1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
#LyX 1.6.7 created this file. For more info see http://www.lyx.org/
\lyxformat 345
\begin_document
\begin_header
\textclass article
\use_default_options true
\language english
\inputencoding auto
\font_roman default
\font_sans default
\font_typewriter courier
\font_default_family default
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 1
\use_esint 1
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\author ""
\author ""
\end_header
\begin_body
\begin_layout Title
Structure du projet et makefiles
\end_layout
\begin_layout Part*
Structure
\end_layout
\begin_layout Standard
Le dosier du projet, nommé `vhc' (pour `Virtual Hadron Collider'), est structuré
de la manière suivante:
\end_layout
\begin_layout Standard
\begin_inset listings
lstparams "basicstyle={\ttfamily}"
inline false
status open
\begin_layout Plain Layout
vhc
\end_layout
\begin_layout Plain Layout
|-- bin
\end_layout
\begin_layout Plain Layout
| |-- main
\end_layout
\begin_layout Plain Layout
| `-- test
\end_layout
\begin_layout Plain Layout
|-- doc
\end_layout
\begin_layout Plain Layout
|-- Doxyfile
\end_layout
\begin_layout Plain Layout
|-- JOURNAL.txt
\end_layout
\begin_layout Plain Layout
|-- Makefile
\end_layout
\begin_layout Plain Layout
|-- reponses.lyx
\end_layout
\begin_layout Plain Layout
|-- REPONSES.pdf
\end_layout
\begin_layout Plain Layout
`-- src
\end_layout
\begin_layout Plain Layout
|-- main
\end_layout
\begin_layout Plain Layout
`-- test
\end_layout
\end_inset
\end_layout
\begin_layout Section*
vhc
\end_layout
\begin_layout Standard
Le répertoire principale (dit `de base') du projet est est `vhc'.
Dans celui-ci se trouvent les fichiers expliqués dans la description officielle
du projet.
Notamment:
\end_layout
\begin_layout Itemize
JOURNAL
\end_layout
\begin_layout Itemize
REPONSES
\end_layout
\begin_layout Itemize
README
\end_layout
\begin_layout Itemize
Makefile
\end_layout
\begin_layout Standard
Il contient de plus le fichier `Doxyfile' utilisé pour générer de la documentati
on du code source.
\end_layout
\begin_layout Section*
src
\end_layout
\begin_layout Standard
Ce répertoire contient tout le code source, donc les fichiers les plus important
s du projet! Le code source est lui-meme reparti dans les sous-répertoires
suivantes:
\end_layout
\begin_layout Itemize
main
\begin_inset Newline newline
\end_inset
Contient le code source principale, c'est à dire tout les fichiers sources
du simulateur.
\begin_inset Newline newline
\end_inset
Exemples: Vector3D.cc, Vector3D.h, Particle.cc, etc...
\end_layout
\begin_layout Itemize
test
\begin_inset Newline newline
\end_inset
Contient le code source des tests.
Les fichiers tests contenant une fonction `main' devraient se terminer
avec `Test'.
\begin_inset Newline newline
\end_inset
Exemples: Vector3DTest.cc, etc...
\end_layout
\begin_layout Section*
doc
\end_layout
\begin_layout Standard
Contient de la documentation générée automatiquement par un outil comme
`doxygen'.
\end_layout
\begin_layout Standard
Remarque: n'est pas sous contrôle de version.
\end_layout
\begin_layout Section*
bin
\end_layout
\begin_layout Standard
Contient les fichiers binaires (i.e.
executables, objets, librairies etc...) compilés du code source.
La structure de ce répertoire est identique a celle de `src', c'est-à-dire
que les tests seront compilés dans `bin/test/' et les sources principaux
dans `bin/main/'.
\end_layout
\begin_layout Standard
Remarque: n'est pas sous contrôle de version.
\end_layout
\begin_layout Part*
Makefiles
\end_layout
\begin_layout Standard
Afin d'automatiser le processus de compilation, un Makefile est présent
dans le répertoire de base.
A cause de la compléxité du répertoire source, le Makefile est récursif.
Cela signifie que ce Makefile ne fait que de déléguer les commandes à deux
makefiles contenus dans les répertoires src/main et src/test.
Ainsi, lorsqu'on ajoute/supprime des fichiers des répertoires précédents,
il suffit de modifier le Makefile contenu dans le répertoire respectif.
En général, il ne faut pas modifer le Makefile de base.
\end_layout
\begin_layout Standard
Pour plus d'informations voir les commantaires des Makefiles.
\end_layout
\begin_layout Section*
Commandes
\end_layout
\begin_layout Standard
Voici quelques commandes pour le Makefile principal.
\end_layout
\begin_layout Itemize
build
\begin_inset Newline newline
\end_inset
compile les sources principaux
\end_layout
\begin_layout Itemize
test-build
\begin_inset Newline newline
\end_inset
compile les tests
\end_layout
\begin_layout Itemize
all
\begin_inset Newline newline
\end_inset
lance un build, test-build
\end_layout
\begin_layout Itemize
doc
\begin_inset Newline newline
\end_inset
génère la documentation
\end_layout
\begin_layout Itemize
clean
\begin_inset Newline newline
\end_inset
supprime le répertoire bin pour une compilation
\begin_inset Quotes eld
\end_inset
propre
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Itemize
test
\begin_inset Newline newline
\end_inset
lance tous les tests
\end_layout
\begin_layout Section*
Compilation
\end_layout
\begin_layout Itemize
Les fichiers source principaux sont compilés et regroupés dans une librairie
statique.
Cette libraire s'appelle `libvhc.a'.
\end_layout
\begin_layout Itemize
Les tests sont compilés en éxécutables et reliés (linked) avec la librairie
statique `libvhc.a'
\end_layout
\end_body
\end_document
|
