hgbook
view fr/ch02-tour-basic.xml @ 983:5e1e70fcdfdb
Corrected some errors.
- Indentation problems
- Syntax errors (missing </para>,...)
- French mistakes
- Indentation problems
- Syntax errors (missing </para>,...)
- French mistakes
| author | Frédéric Bouquet <youshe.jaalon@gmail.com> |
|---|---|
| date | Tue Sep 08 23:42:42 2009 +0200 (2009-09-08) |
| parents | 1df99de46e39 |
| children | c9ad85fd2f38 |
line source
1 <!-- vim: set filetype=docbkxml shiftwidth=2 autoindent expandtab tw=77 : -->
3 <chapter id="chap:tour-basic">
4 <?dbhtml filename="a-tour-of-mercurial-the-basics.html"?>
5 <title>Une rapide présentation de Mercurial : les bases</title>
7 <sect1>
8 <title>Installer Mercurial sur votre système</title>
10 <para id="x_1">Des paquetages binaires de Mercurial sont disponibles pour la
11 plupart des systèmes d'exploitation, ce qui rend facile l'utilisation
12 immédiate de Mercurial sur votre ordinateur.</para>
14 <sect2>
15 <title>Windows</title>
17 <para id="x_c">La meilleur version de Mercurial pour Windows est
18 TortoiseHg, qui peut être téléchargée ici : <ulink
19 url="http://bitbucket.org/tortoisehg/stable/wiki/Home">http://bitbucket.org/tortoisehg/stable/wiki/Home</ulink>.
20 Ce logiciel n'a aucune dépendance exterieure; il fonctionne <quote>et
21 c'est tout</quote>. Il fournit aussi bien les outils en ligne de
22 commmande qu'une interface graphique.</para>
24 </sect2>
26 <sect2>
27 <title>Mac OS X</title>
29 <para id="x_a">Lee Cantey publie un installeur de Mercurial pour Mac OS
30 X sur <ulink
31 url="http://mercurial.berkwood.com">http://mercurial.berkwood.com</ulink>.</para>
32 </sect2>
34 <sect2>
35 <title>Linux</title>
37 <para id="x_2">Parce que chaque distribution de Linux a ses propres
38 outils de gestion de paquets, politiques et rythmes de
39 développements, il est difficile de donner un ensemble
40 d'instructions unique pour installer les binaires de Mercurial. La
41 version de Mercurial avec laquelle vous vous retrouverez dépendra
42 grandement de l'activité de la personne en charge du paquetage pour
43 la distribution.</para>
45 <para id="x_3">Pour rester simple, je me concentrerai sur
46 l'installation de Mercurial en ligne de commande, sous les
47 distributions les plus courantes. La plupart des distributions
48 fournissent des gestionnaires graphiques de paquetage qui vous
49 permettront d'installer Mercurial en quelques clicks. Le paquetage
50 devrait se nommer <literal>mercurial</literal>.</para>
52 <itemizedlist>
53 <listitem><para id="x_4">Ubuntu et Debian:</para>
54 <programlisting>apt-get install mercurial</listitem>
55 <listitem><para id="x_5">Fedora:</para>
56 <programlisting>yum install mercurial</programlisting>
57 <listitem><para id="x_6">Gentoo:</para>
58 <programlisting>emerge mercurial</programlisting></listitem>
59 <listitem><para id="x_715">OpenSUSE:</para>
60 <programlisting>zypper install mercurial</programlisting>
61 </itemizedlist>
63 </sect2>
64 <sect2>
65 <title>Solaris</title>
67 <para id="x_09">SunFreeWare, à <ulink
68 url="http://www.sunfreeware.com">http://www.sunfreeware.com</ulink>,
69 fournit des paquets précompilés pour Mercurial.</para>
70 </sect2>
71 </sect1>
73 <sect1>
74 <title>Commencer à utiliser Mercurial</title>
76 <para id="x_e">Pour commencer, nous utiliserons la commande <command
77 role="hg-cmd">hg version</command> pour vérifier si Mercurial est
78 installé proprement. Les informations affichées sur la version ne sont
79 pas réellement importantes en soit, c'est surtout de savoir si elles
80 s'affichent qui nous intéresse.</para>
82 &interaction.tour.version;
84 <sect2>
85 <title>L'aide intégrée</title>
87 <para id="x_e">Mercurial fournit un système d'aide intégré, ce qui est
88 inestimable quand vous vous retrouvez coincé à essayer de vous
89 rappeler comment lancer une commande. Si vous êtes bloqué, exécutez
90 simplement <command role="hg-cmd">hg help</command>; elle affichera
91 une brève liste des commandes, avec une description pour chacune. Si
92 vous demandez de l'aide sur une commande spécifique (voir
93 ci-dessous), elle affichera des informations plus détaillées.</para>
95 &interaction.tour.help;
97 <para id="x_10">Pour un niveau d'informations encore plus détaillé
98 (ce dont vous aurez rarement besoin), exécuter <command role="hg-cmd">hg
99 help <option role="hg-opt-global">-v</option></command>. L'option
100 <option role="hg-opt-global">-v</option> est l'abréviation de
101 <option role="hg-opt-global">--verbose</option>, et indique à Mercurial
102 d'afficher plus d'informations que d'habitude.</para>
104 </sect2>
105 </sect1>
106 <sect1>
107 <title>Travailler avec un dépôt</title>
109 <para id="x_11">Avec Mercurial, tout se déroule au sein du
110 <emphasis>dépôt</emphasis>. Le dépôt d'un projet contient tous
111 les fichiers qui <quote>appartiennent</quote> au projet.</para>
113 <para id="x_12">Il n'y a rien de particulièrement magique au sujet de
114 ce dépôt, c'est simplement une arborescence sur votre système de fichiers
115 que Mercurial traite de manière spéciale. Vous pouvez renommer ou effacer
116 ce répertoire à n'impporte quel moment, en utilisant la ligne de commande
117 ou votre explorateur de fichiers.</para>
119 <sect2>
120 <title>Faire une copie locale de votre dépôt</title>
122 <para id="x_13"><emphasis>Copier</emphasis> un dépôt est juste un
123 peu spécial. Bien que vous puissiez utiliser une commande habituelle de
124 copie pour copier votre dépôt, il vaut mieux utiliser une commande fournie par
125 Mercurial. Cette commande est appelée <command role="hg-cmd">hg clone</command>,
126 car elle crée une copie identique à un dépôt existant.</para>
128 &interaction.tour.clone;
130 <para id="x_67c">Un avantage de la commande <command role="hg-cmd">hg
131 clone</command> est que, comme nous l'avons vu ci dessus, elle nous
132 permet de faire de cloner les dépôts à travers le réseau. Un autre
133 est qu'elle se rappelle d'où a été cloné un dépôt, ce qui est utile
134 quand on veut mettre à jour le clone.</para>
136 <para id="x_14">Si votre opération de clonage réussit, vous devriez maintenant
137 avoir un répertoire local appelé <filename class="directory">hello</filename>.
138 Ce répertoire contiendra quelques fichiers.</para>
140 &interaction.tour.ls;
142 <para id="x_15">Ces fichiers ont le même contenu et historique dans votre dépôt
143 qu'ils ont dans le dépôt que vous avez cloné.</para>
145 <para id="x_16">Chaque dépôt Mercurial est complet, autonome et
146 indépendant. Il contient sa propre copie privée des fichiers du
147 projet et de leur historique. Le clone d'un dépôt se souvient de la
148 localisation du dépôt à partir duquel il a été clôné, mais il ne
149 communique pas avec ce dernier, ou un autre, à moins que vous ne lui
150 demandiez.</para>
152 <para id="x_17">Ce que tout ceci signifie pour le moment est que nous
153 sommes libres d'expérimenter avec ce dépôt, confiants dans le fait
154 qu'il s'agit d'un <quote>bac à sable</quote> qui n'affectera personne
155 d'autre.</para>
157 </sect2>
158 <sect2>
159 <title>Quel est le contenu d'un dépôt ?</title>
161 <para id="x_18">Prêtons plus attention un instant au contenu d'un dépôt.
162 Nous voyons qu'il contient un répertoire nommé <filename class="directory">.hg
163 </filename>. C'est ici que Mercurial conserve toutes ses
164 métadonnées.</para>
166 &interaction.tour.ls-a;
168 <para id="x_19">Le contenu du répertoire <filename class="directory">.hg
169 </filename> et ses sous répertoires sont les seuls propres à Mercurial.
170 Tous les autres fichiers et répertoires dans le dépôt sont à vous, et
171 vous pouvez en faire ce que vous voulez.</para>
173 <para id="x_1a">Pour introduire un peu de terminologie, le répertoire
174 <filename class="directory">.hg</filename> est un <quote>vrai</quote>
175 dépôt, et tous les fichiers et les répertoires qui coexistent avec lui,
176 sont désignés sous le nom <emphasis>espace de travail</emphasis>. Une
177 manière facile de se rappeler cette distinction est de retenir que le
178 <emphasis>dépôt</emphasis> contient l'<emphasis>historique</emphasis>
179 de votre projet, alors que l'<emphasis>espace de travail</emphasis>
180 contient un "<emphasis>snapshot</emphasis>" de votre projet à un certain
181 point de son historique.</para>
183 </sect2>
184 </sect1>
185 <sect1>
186 <title>Une promenade dans l'historique</title>
188 <para id="x_1b">Une des premières choses que vous aurez envie
189 de faire avec un nouveau dépôt, sera de comprendre son historique.
190 La commande <command role="hg-cmd">hg log</command> vous donne une
191 vue de l'historique.</para>
193 &interaction.tour.log;
195 <para "x_1c">Par défaut, cette commande affiche à l'écran un bref paragraphe pour chaque
196 révision enregistrée pour ce projet. Dans la terminologie de Mercurial, nous
197 appelons chacun de ces évènements enregistrés un <emphasis>changeset</emphasis>, parce
198 qu'il contient un ensemble de modifications sur plusieurs fichiers.</para>
200 <para id="x_1d">La commande <command role="hg-cmd">hg log</command> affiche
201 ainsi ces informations :</para>
203 <itemizedlist>
204 <listitem><para id="x_1e"><literal>changeset</literal> : Ce champ contient
205 un nombre, séparé par deux points (:), d'une chaine hexadécimale. Il
206 s'agit en fait d'<emphasis>identifiants</emphasis> d'un changeset. Il y a
207 deux identifiants car le numéro de la révision est plus court et plus à
208 facile à saisir qu'une séquence hexadécimale.</para>
209 </listitem>
210 <listitem><para id="x_1f"><literal>user</literal> : L'identité de la personne
211 qui a créée ce %%% laisser le terme anglais car il sera affiché
212 changeset. C'est un champ libre de forme, mais la plupart du
213 temps il contient le nom et l'email de la personne.</para>
214 </listitem>
215 <listitem><para id="x_20"><literal>date</literal> : La date et l'heure à
216 laquelle le \textit{changeset} a été créé, ainsi que le fuseau horaire dans
217 lequelle il a été créé. (La date et l'heure sont locales à ce
218 \textit{fuseau}, elles indiquent donc quelle date et heure il était
219 pour la personne qui a créé ce changeset.</para>
220 </listitem>
221 <listitem><para id="x_21"><literal>résumé</literal>: La première ligne du
222 message que le créateur a associé à son changeset pour le décrire.</para>
223 </listitem>
224 <listitem><para id="x_67d">Certains changesets, comme le premier de la
225 liste ci-dessus ont un champ <literal>tag</literal>. Le tag est une autre
226 façon d'identifier un changeset en lui donnant un nom simple à retenir.
227 (Le tag nommé <literal>tip</literal> est spécial : il fait toujours
228 référence aux derniers changements dans le dépôt.)</para></listitem>
229 </itemizedlist>
231 <para id="x_22">Par défaut, la commande <command role="hg-cmd">hg log</command>
232 n'affiche qu'un résumé, il manque beaucoup de détails.</para>
234 <para id="x_23">La figure <xref linkend="fig:tour-basic:history"/> fournit une
235 représentation graphique de l'historique du dépôt <filename class="directory">hello
236 </filename>, pour rendre plus facile de voir dans quelle direction
237 l'historique se <quote>déroule</quote>. Nous reviendrons régulièrement
238 sur cette représentation dans ce chapitre et ceux qui suivent.</para>
241 <figure id="fig:tour-basic:history">
242 <title>Graphical history of the <filename
243 class="directory">hello</filename> repository</title>
244 <mediaobject>
245 <imageobject><imagedata fileref="figs/tour-history.png"/></imageobject>
246 <textobject><phrase>XXX add text</phrase></textobject>
247 </mediaobject>
248 </figure>
251 <sect2>
252 <title>Changesets, révisions, et collaboration</title>
254 <para id="x_25">Comme l'anglais est réputé pour être un langage maladroit,
255 et que l'informatique est la source de bien des erreurs de terminologie
256 (pourquoi utiliser un seul terme quand quatre feront l'affaire ?), la
257 gestion de version a une variété de mots et de phrases qui veulent dire
258 la même chose. Si vous discutez d'historique de Mercurial avec d'autres
259 personnes, vous constaterez que souvent, le mot <quote>changeset</quote>
260 est contracté simplement en <quote>change</quote> ou (à l'écrit)
261 <quote>cset</quote>, et même parfois un changeset
262 <quote>révision</quote>, abrégé en <quote>rev</quote>.</para>
264 <para id="x_26">Bien que le <emphasis>mot</emphasis> que vous utilisez pour
265 désigner le concept de changeset importe peu, l'<emphasis>identifiant</emphasis>
266 que vous utilisez pour désigner un <emphasis>changeset</emphasis> spécifique
267 a une grande importance. Rappelez vous que le champ changeset affiché par la
268 commande <command role="hg-cmd">hg log</command> identifie un changeset à
269 la fois avec un numéro de révision et une séquence hexadécimale.</para>
271 <itemizedlist>
272 <listitem><para id="x_27">Le numéro de révision est <emphasis>seulement
273 valable dans ce dépôt</emphasis>,</para></listitem>
274 <listitem><para id="x_28">La séquence hexadécimale est un
275 <emphasis>identifiant permanent, et invariant</emphasis> qui
276 pourra toujours être associé au changeset exact de <emphasis>chaque</emphasis>
277 copie de votre dépôt.</para></listitem></itemizedlist>
279 <para id="x_29">La distinction est importante. Si vous envoyez un email
280 à quelqu'un en parlant de la <quote>révision 33</quote>, il est très
281 probable que sa révision 33 <emphasis>ne sera pas la même</emphasis>
282 que la votre. La raison de ceci est que le numéro de révision dépend
283 de l'ordre dans lequel les modifications sont arrivées dans le dépôt,
284 et il n'y a aucune garantie que les mêmes changements soient arrivés
285 dans le même ordre dans différents dépôts. Trois modifications
286 <literal>a,b,c</literal> peuvent aisément apparaitre dans un dépôt
287 comme <literal>0,1,2</literal>, et dans un autre comme <literal>0,2,1
288 </literal>.</para>
290 <para id="x_2a">Mercurial utilise les numéros de révision uniquement comme des raccourcis
291 pratiques. Si vous devez discuter d'un \textit{changeset} avec quelqu'un,
292 ou identifer un \textit{changeset} pour une quelconque raison (par exemple,
293 un rapport de \textit{bug}), utilisez la séquence hexadécimale.</para>
295 </sect2>
296 <sect2>
297 <title>Afficher une révision spécifique</title>
299 <para id="x_2b">Pour réduire la sortie de <command role="hg-cmd">hg log
300 </command> à une seule révision, utilisez l'option <option role="hg-opt-log">-r
301 </option> (ou <option role="hg-opt-log">--rev</option>). Vous pouvez utiliser
302 le numéro de révision ou la séquence hexadécimale comme identifiant, et
303 demander autant de révisions que vous le souhaitez.</para>
305 &interaction.tour.log-r;
307 <para id="x_2c">Si vous voulez voir l'historique de plusieurs révisions
308 sans avoir à les énumérer, vous pouvez utiliser la <emphasis>intervalle
309 de numérotation</emphasis> qui vous permet d'exprimer l'idée <quote>je
310 veux toutes les révisions entre $a$ et $b$, inclus</quote></para>
312 &interaction.tour.log.range;
314 <para id="x_2d">Mercurial respecte aussi l'ordre dans lequel vous spécifiez
315 les révisions, ainsi <command role="hg-cmd">hg log -r 2:4</command>
316 affichera <literal>2,3,4</literal> alors que <command role="hg-cmd">hg
317 log -r 4:2</command> affichera <literal>4,3,2</literal>.</para>
319 </sect2>
320 <sect2>
321 <title>Informations détaillées</title>
323 <para id="x_2e">Le résumé affiché par <command role="hg-cmd">hg log</command>
324 est suffisant si vous savez déjà ce que vous cherchez. En
325 revanche, vous aurez probablement besoin de voir une description
326 complète du changement, ou une liste des fichiers modifiés si vous
327 cherchez à déterminer qu'un changeset est bien celui que vous
328 recherchez. L'option \hgopt{-v} de la commande <command role="hg-cmd">hg
329 log</command> (ou <option role="hp-opt-global">--verbose</option>) vous
330 donne ces informations supplémentaires.</para>
332 &interaction.tour.log-v;
334 <para id="x_2f">Si vous voulez voir à la fois la description
335 et le contenu d'une modification, ajouter l'option <option
336 role="hg-opt-log">-p</option> (ou <option role="hg-opt-log">
337 --patch</option>). Ceci affiche le contenu d'une modification
338 comme un <emphasis>diff unifié</emphasis>
339 <!-- \footnote{NdT: \textit{unified diff}} -->
340 (si vous n'avez jamais vu de diff unifié avant, consultez la
341 section <xref linkend="sec:mq:patch"/> pour un rapide
342 survol).</para>
344 &interaction.tour.log-vp;
346 <para id="x_67e">L'option <option role="hg-opt-log">-p</option> est
347 incroyablement utile, il est donc important dans s'en rappeller.</para>
349 </sect2>
350 </sect1>
351 <sect1>
352 <title>Tout sur les options de commandes</title>
354 <para id="x_30">Avant d'aller plus loin sur le fonctionnement
355 des commandes de Mercurial, étudions un moment comment elles
356 fonctionnent de manière générale. Vous trouverez ça probablement
357 utile pour la suite de notre parcours.</para>
359 <para id="x_31">Mercurial utilise une approche directe et cohérente
360 pour interpréter les options que vous passez aux commandes. Il suit une
361 convention commune à la plupart des systèmes Unix et Linux modernes.</para>
363 <itemizedlist>
364 <listitem><para id="x_32">Chaque option a un nom complet. Par exemple,
365 comme nous l'avons déjà vu, la commande <command role="hg-cmd">hg
366 log</command> accepte l'option <option role="hg-opt-log">--rev
367 </option>.</para>
368 </listitem>
369 <listitem><para id="x_33">La plupart des options disposent de
370 noms abrégés. Aussi, au lieu d'utiliser <option role="hg-opt-log">--rev
371 </option>, vous pouvez utiliser <option role="hg-opt-log">-r</option>.
372 (Les options qui n'ont pas de noms abrégés sont généralement
373 rarement utilisées).</para>
374 </listitem>
375 <listitem><para id="x_34">Les noms complets commencent par deux
376 tirets (i.e. <option role="hg-opt-log">--rev</option>),
377 alors que les options courtes commencent avec un seul (i.e.
378 <option role="hg-opt-log">-r</option>).</para>
379 </listitem>
380 <listitem><para id="x_35">Les noms des options sont cohérents
381 entre les commandes. Par exemple, chaque commande qui accepte
382 un changeset ID ou un numéro de révision accepte aussi <option
383 role="hg-opt-log">-r</option> et <option role="hg-opt-log">--rev
384 </option> comme arguments.</para>
385 </listitem>
386 </itemizedlist>
388 <para id="x_36">Dans les exemples de ce livre, j'utilise les noms abrégés
389 plutôt que les noms complets. Ceci est une préférence personnelle, pas
390 une recommandation.</para>
392 <para id="x_37">La plupart des commandes qui affichent une quelconque sortie
393 à l'écran, afficheront davantage avec l'option <option role="hg-opt-global">
394 -v</option> (ou <option role="hg-opt-global">--verbose</option>), et
395 moins avec l'option <option role="hg-opt-global">-q</option> (ou
396 <option role="hg-opt-global">--quiet</option>).</para>
398 <note>
399 <title>Option naming consistency</title>
401 <para id="x_680">Presque toujours, les commandes de Mercurial utilisent
402 des noms d'options cohérentes pour référer à des concepts identiques.
403 Par exemple, si une commande concerne les changesets, vous les
404 identifierez toujours avec l'option <option role="hg-opt-log">-r</option>.
405 Cette utilisation cohérente des noms d'options permet de mémoriser plus
406 facilement quelles options accepte une commande.</para>
407 </note>
410 </sect1>
411 <sect1>
412 <title>Faire et vérifier des modifications</title>
414 <para id="x_38">Maintenant que nous avons une bonne idée des
415 commandes pour consulter l'historique de Mercurial, regardons
416 comment faire des modifications et les examiner.</para>
418 <para id="x_39">La première chose que nous allons faire c'est isoler notre
419 expérience dans un dépôt à part. Nous allons utiliser la commande <command
420 role="hg-cmd">hg clone</command>, mais nous n'avons pas besoin de faire
421 une copie de dépôt distant. Comme nous avons déjà une copie locale, nous
422 pouvons juste faire un clone de celle-ci à la place. C'est beaucoup plus
423 rapide que de faire une copie à travers le réseau, et un dépôt cloné
424 localement prend également moins d'espace disque<footnote>
425 <para id="x_681">L'économie d'espace disque apparait clairement quand les
426 dépôts source et destination sont sur le même système de fichier, où, dans
427 ce cas, Mercurial utilisera des liens physiques pour effectuer des partages
428 copie-lors-des-écritures de ses métadonnées internes. Si cette explication
429 ne signifie rien pour vous, ne vous inquietez pas : tout ceci se passe de
430 manière transparente et automatiquement. Vous n'avez pas du tout besoin de
431 comprendre ceci.</para></footnote>.</para>
433 &interaction.tour.reclone;
435 <para id="x_3a">On notera au passage qu'il est souvent considéré comme
436 une bonne pratique de conserver une copie <quote>immaculée</quote>
437 du dépôt distant, à partir de laquelle vous pourrez faire des
438 copies locales temporaires pour créer des <quote>bacs à sable</quote>
439 pour chaque tâche sur laquelle vous souhaitez travailler. Ceci
440 vous permet de travailler sur plusieurs choses en parallèle,
441 chacune isolée les unes des autres en attendant que ces tâches
442 soient finies et que vous soyez prêt à les réintégrer. Parce
443 que les copies locales sont peu coûteuses, il est très rapide
444 de créer ou détruire des dépôts dès que vous n'en avez plus
445 besoin.</para>
447 <para id="x_3b">Dans notre dépôt <filename
448 class="directory">my-hello</filename>, nous avons un fichier
449 <filename>hello.c</filename> qui contient le classique <quote>hello,
450 world</quote>.</para>
452 &interaction.tour.cat1;
454 <para id="x_682">Editons ce fichier pour qu'il affiche une autre ligne
455 sur la sortie standard.</para>
457 &interaction.tour.cat2;
459 <para id="x_3c">La commande Mercurial <command role="hg-cmd">hg
460 status</command> nous dira ce que Mercurial sait des fichiers du
461 dépôts.</para>
463 &interaction.tour.status;
465 <para id="x_3d">La commande <command role="hg-cmd">hg status</command>
466 n'affichera pas le contenu des fichiers, mais une ligne commençant par
467 <quote><literal>M</literal></quote> pour <filename>hello.c</filename>.
468 A moins que vous lui demandiez, la commande <command role="hg-cmd">hg
469 status</command> n'affichera aucune information sur les fichiers que
470 vous n'avez pas modifiés.</para>
472 <para id="x_3d">Le <quote><literal>M</literal></quote> indique que
473 Mercurial a remarqué que nous avons modifié le fichier
474 <filename>hello.c</filename>. Nous n'avons pas besoin
475 <emphasis>d'informer</emphasis> Mercurial que nous allons modifier un
476 fichier avant de commencer à le faire, ou que nous avons modifié un
477 fichier après avoir commencé à le faire, il est capable de découvrir ça
478 tout seul. </para>
480 <para id="x_3f">C'est déjà pratique de savoir que nous avons modifié le
481 fichier <filename>hello.c</filename>, mais nous préférerions savoir
482 exactement <emphasis>ce que</emphasis> nous avons changé. Pour ceci, nous
483 utilisons la commande <command role="hg-cmd">hg diff</command>.</para>
485 &interaction.tour.diff;
487 <tip>
488 <title>Comprendre les patches</title>
490 <para id="x_683">Penser à jeter un oeil à <xref
491 linkend="sec:mq:patch"/> si vous n'arrivez pas à lire la sortie
492 ci-dessus.</para>
493 </tip>
494 </sect1>
495 <sect1>
496 <title>Enregister vos modifications dans une nouvelle révision</title>
498 <para id="x_40">Nous pouvons modifier des fichiers, compiler et tester
499 nos modifications, et utiliser les commandes <command role="hg-cmd">hg
500 status</command> et <command role="hg-cmd">hg diff</command> pour
501 voir les modifications effectuées, jusqu'à ce que nous soyons assez
502 satisfaits pour décider d'enregistrer notre travail dans un
503 \textit{changeset}.</para>
505 <para id="x_41">La commande <command role="hg-cmd">hg commit</command>
506 vous laisse créer une nouvelle révision, nous désignerons généralement
507 cette opération par <quote>faire un commit</quote> ou
508 <quote>committer</quote>.</para>
510 <sect2>
511 <title>Définir le nom d'utilisateur</title>
513 <para id="x_42">Quand vous exécutez la commande <command
514 role="hg-cmd">hg commit</command> pour la première fois, il n'est
515 pas garanti qu'elle réussisse du premier coup. En effet, Mercurial
516 enregistre votre nom et votre adresse avec chaque modification que
517 vous effectuez, de manière à ce que vous soyez capable (ou d'autres
518 le soient) de savoir qui a fait quelle modification. Mercurial essaye
519 automatiquement de découvrir un nom d'utilisateur qui ait un minimum
520 de sens pour effectuer l'opération de commit avec. Il va essayer
521 chacune des méthodes suivantes, dans l'ordre :</para>
523 <orderedlist>
524 <listitem><para id="x_43">Si vous spécifiez l'option <option
525 role="hg-opt-commit">-u</option> avec la commande <command
526 role="hg-cmd">hg commit</command>, suivi d'un nom
527 d'utilisateur, ceci aura toujours la priorité sur les autres
528 méthodes ci dessous.</para></listitem>
529 <listitem><para id="x_44">Si vous avez défini une variable
530 d'environnement <envar>HGUSER</envar>, c'est cette valeur qui est
531 alors utilisée.</para></listitem>
532 <listitem><para id="x_45">Si vous créez un fichier nommé <filename
533 role="special">.hgrc</filename> dans votre répertoire
534 \textit{home}, avec une entrée <envar
535 role="rc-item-ui">username</envar>, c'est la valeur associée
536 qui sera utilisée. Pour voir à quoi ressemble le contenu de ce
537 fichier regardez la section <xref
538 linkend="sec:tour-basic:username"/>
539 ci-dessous.</para></listitem>
540 <listitem><para id="x_46">Si vous avez défini une variable
541 d'environnement <envar>EMAIL</envar> celle ci sera utilisée
542 ensuite.</para></listitem>
543 <listitem><para id="x_47">Enfin, Mercurial interrogera votre système
544 pour trouver votre nom d'utilisateur local ainsi que le nom de la
545 machine hôte, et il fabriquera un nom d'utilisateur à partir de
546 ces données. Comme il arrive souvent que ce genre de noms soit
547 totalement inutile, il vous préviendra en affichant un message
548 d'avertissement.</para></listitem>
549 </orderedlist>
551 <para id="x_48">Si tous ces mécanismes échouent, Mercurial n'exécutera
552 pas la commande, affichant un message d'erreur. Dans ce cas, il ne
553 vous laissera pas effectuer de commit tant que vous n'aurez pas
554 défini un nom d'utilisateur.</para>
556 <para id="x_49">Vous devriez penser à utiliser la variable
557 d'environement <envar>HGUSER</envar> et l'option <option
558 role="hg-opt-commit">-u</option> comme moyen pour
559 <emphasis>changer</emphasis> le nom d'utilisateur par défaut. Pour
560 une utilisation normale, la manière la plus simple et robuste
561 d'opérer est de créer un fichier <filename
562 role="special">.hgrc</filename>, voir ci-dessous pour les détails
563 à ce sujet.</para>
565 <sect3 id="sec:tour-basic:username">
566 <title>Créer un fichier de configuration pour Mercurial</title>
568 <para id="x_4a">Pour définir un nom d'utilisateur, utilisez votre
569 éditeur de texte favori pour créer un fichier <filename
570 role="special">.hgrc</filename> dans votre répertoire home.
571 Mercurial va utiliser ce fichier pour retrouver votre
572 configuration personnelle. Le contenu initial devrait
573 ressembler à ceci :</para>
575 <tip>
576 <title><quote>Home directory</quote> sous Windows</title>
578 <para id="x_716">Quand on parle de répertoire home, sur une version
579 anglaise d'une installation de Windows, il s'agira habituellement
580 d'un répertoire nommée comme votre nom dans <filename>C:\Documents
581 and Settings</filename>. Vous pouvez trouver de quelle répertoire
582 il s'agit en lançant une fenêtre d'interpréteur de commande et en
583 exécutant la commande suivante :</para>
585 <screen><prompt>C:\</prompt> <userinput>echo
586 %UserProfile</userinput></screen>
587 </tip>
589 <programlisting># This is a Mercurial configuration file.
590 [ui]
591 username = Firstname Lastname <email.address@domain.net></programlisting>
593 <para id="x_4b">La ligne avec <literal>[ui]</literal> commence une
594 <emphasis>section</emphasis> du fichier de configuration, ainsi la ligne
595 <quote><literal>username = ...</literal></quote> signifie <quote>
596 définir la valeur de l'élément <literal>username</literal> dans la
597 section <literal>ui</literal></quote>. Une section continue jusqu'à ce
598 qu'une nouvelle commence, ou que la fin du fichier soit atteinte.
599 Mercurial ignore les lignes vides et traite tout texte situé à la suite
600 d'un <quote><literal>#</literal></quote> jusqu'à la fin de la ligne
601 comme un commentaire.</para>
603 </sect3>
604 <sect3>
605 <title>Choisir un nom d'utilisateur</title>
607 <para id="x_4c">Vous pouvez utiliser n'importe quelle valeur
608 pour votre <literal>username</literal>, car cette information
609 est destinée à d'autres personnes et non à être interprétée
610 par Mercurial. La convention que la plupart des personnes
611 suivent est d'utiliser leurs noms suivies de leurs adresses emails,
612 comme montré ci-dessus :</para>
613 <note>
614 <para id="x_4d">Le mécanisme interne du serveur web intégré à Mercurial,
615 masque les adresses emails, pour rendre plus difficile leurs
616 récupérations par les outils utilisés par les spammmers.
617 Ceci réduit la probabilité que de recevoir encore plus de
618 spam si vous vous publiez un dépôt sur internet.</para>
619 </note>
620 </sect3>
621 </sect2>
622 <sect2>
623 <title>Rédiger un message de \textit{commit}</title>
625 <para id="x_4e">Lorsqu'on effectue une opération de commit, Mercurial
626 lance automatiquement un éditeur de texte pour permettre de saisir
627 un message qui décrira les modifications effectuées dans cette
628 révision. Ce message est nommé le <emphasis>message de commit</emphasis>.
629 Ce sera un enregistrement pour tout lecteur expliquant le pourquoi
630 et le comment de vos modifications, et il sera affiché par la
631 commande <command role="hg-cmd">hg log</command>.</para>
633 &interaction.tour.commit;
635 <para id="x_4f">L'éditeur que la commande <command role="hg-cmd">hg
636 commit</command> déclenche ne contiendra qu'une ligne vide suivi
637 d'un certain nombre de lignes commençant par <quote><literal>HG:
638 </literal></quote>.</para>
640 <programlisting>
641 This is where I type my commit comment.
643 HG: Enter commit message. Lines beginning with 'HG:' are removed.
644 HG: --
645 HG: user: Bryan O'Sullivan <bos@serpentine.com>
646 HG: branch 'default'
647 HG: changed hello.c</programlisting>
650 <para id="x_50">Mercurial ignore les lignes qui commencent
651 avec <quote><literal>HG:</literal></quote>, il ne les
652 utilise que pour nous indiquer quels fichiers modifiés il se
653 prépare à \textit{commiter}. Modifier ou effacer ces lignes n'a
654 aucune conséquence sur l'opération de commit.
655 </para>
657 </sect2>
658 <sect2>
659 <title>Rédiger un message \textit{approprié}</title>
661 <para id="x_51">Comme <command role="hg-cmd">hg log</command> n'affiche
662 que la première ligne du message de commit par défaut, il est souvent
663 considéré comme une bonne pratique de rédiger des messages de commit
664 qui tiennent sur une seule ligne. Voilà un exemple concret de message
665 de commit qui <emphasis>ne suit pas</emphasis> cette directive, et
666 qui a donc un résumé peu lisible.</para>
668 <programlisting>
669 changeset: 73:584af0e231be
670 user: Censored Person <censored.person@example.org>
671 date: Tue Sep 26 21:37:07 2006 -0700
672 summary: include buildmeister/commondefs. Add an exports and install
673 </programlisting>
675 <para id="x_52">A ce sujet, il faut noter qu'il n'existe pas de règle
676 absolue dans ce domaine. Mercurial lui-même n'interprète pas les
677 contenus des messages de commit, ainsi votre projet est libre de
678 concevoir différentes politiques de mise en page des messages.</para>
680 <para id="x_53">Ma préférence personnelle va au message court, mais
681 informatif, qui offre des précisions supplémentaires par rapport à ce
682 que pourrait m'apprendre une commande <command role="hg-cmd">hg log
683 --patch</command>.</para>
685 <para id="x_55">Si vous exécutez la commande <command role="hg-cmd">hg
686 commit</command> sans aucun argument, elle enregistre tous les
687 changements qui ont été fait, et qui sont indiqué par les commandes
688 <command role="hg-cmd">hg status</command> et <command
689 role="hg-cmd">hg diff</command>.</para>
691 <note>
692 <title>Une surprise pour les utilisateurs habitués à Subversion</title>
694 <para id="x_717">Comme n'importe quel autre commande de Mercurial, si
695 vous soumettez pas de manière explicite les noms des fichiers à
696 committer à la commande <command role="hg-cmd">hg commit</command>, elle
697 va travailler sur l'ensemble du répertoire de travail. Soyez conscient
698 de ceci si vous venez du monde Subversion ou CVS, car vous pourriez
699 attendre qu'elle opère uniquement le répertoire courant et ses sous
700 répertoires.</para>
701 </note>
702 </sect2>
703 <sect2>
704 <title>Annuler un \textit{commit}</title>
706 <para id="x_54">Si, en rédigeant le message, vous décidez que
707 finalement vous ne voulez pas effectuer ce commit, il suffit
708 de quitter simplement l'éditeur sans sauver. Ceci n'aura aucune
709 conséquence sur le dépôt ou les fichiers du répertoire de
710 travail.</para>
711 </sect2>
713 <sect2>
714 <title>Admirer votre travail</title>
716 <para id="x_56">Une fois que votre \textit{commit} est terminé, vous
717 pouvez utiliser la commande <command role="hg-cmd">hg tip</command>
718 pour afficher le \textit{changeset} que vous venez de créer. Cette
719 commande produit une sortie à l'écran qui est identique à celle du
720 <command role="hg-cmd">hg log</command>, mais qui n'affiche que la
721 dernière révision du dépôt.</para>
723 &interaction.tour.tip;
725 <para id="x_57">On fait couramment référence à la dernière révision
726 du dépôt comme étant la <emphasis>révision tip</emphasis>, ou plus
727 simplement le <emphasis>tip</emphasis>.</para>
729 <para id="x_684">Au passage, la commande <command role="hg-cmd">hg
730 tip</command> accepte la plupart des options qu'accepte
731 <command role="hg-cmd">hg log</command>. Ainsi <option
732 role="hg-opt-global">-v</option> ci dessus implique <quote>soit
733 verbeux</quote>, <option role="hg-opt-tip">-p</option>
734 veux dire <quote>affiche le patch</quote>. L'utilisation de l'option
735 <option role="hg-opt-tip">-p</option> pour afficher un patch est un
736 autre exemple de la cohérence des commandes évoquée plus tôt.</para>
738 </sect2>
739 </sect1>
740 <sect1>
741 <title>Partager ses modifications</title>
743 <para id="x_58">Nous avons mentionné plus haut que les dépôts
744 de Mercurial sont autosuffisants. Ce qui signifie que la nouvelle
745 révision que vous venez de créer existe seulement dans votre
746 répertoire <filename class="directory">my-hello</filename>. Étudions
747 comment propager cette modification dans d'autres dépôts.</para>
749 <sect2 id="sec:tour:pull">
750 <title>Récupérer les modifications d'autres dépôts</title>
752 <para id="x_5a">Pour commencer, construisons un clone de notre dépôt
753 <filename class="directory">hello</filename> qui ne contiendra pas
754 le changement que nous venons d'effectuer. Nous l'appellerons notre
755 dépôt temporaire <filename
756 class="directory">hello-pull</filename>.</para>
758 &interaction.tour.clone-pull;
760 <para id="x_5a">Nous allons utiliser la commande <command
761 role="hg-cmd">hg pull</command> pour envoyer les modifications
762 depuis <filename class="directory">my-hello</filename> dans <filename
763 class="directory">hello-pull</filename>. Néanmoins, récupérer
764 aveuglement des modifications depuis un dépôt a quelque chose d'un
765 peu effrayant. Mercurial propose donc une commande <command
766 role="hg-cmd">hg incoming</command> qui permet de savoir quelles
767 modifications la commande <command role="hg-cmd">hg pull</command>
768 <emphasis>pourrait</emphasis> entraîner dans notre dépôt, et ceci
769 sans effectuer réellement de modification dessus.</para>
771 &interaction.tour.incoming;
773 <para id="x_5c">Apporter les modifications rapatriées dans un dépôt se
774 résume donc à exécuter la commande <command role="hg-cmd">hg
775 pull</command>, et préciser depuis quel dépôt effectuer le <command
776 role="hg-cmd">hg pull</command>.</para>
778 &interaction.tour.pull;
780 <para id="x_5d">Comme vous le voyez avec une sortie avant et après de la
781 commande <command role="hg-cmd">hg tip</command>, nous avons réussi à
782 récupérer aisément les modifications dans notre dépôt. Il reste néanmoins
783 quelque chose à faire avant de placer ces modifications dans l'espace de
784 travail.</para>
786 <tip>
787 <title>Récupérer des changements précis</title>
789 <para id="x_5b">Il est possible à cause du délai entre l'exécution de la
790 commande <command role="hg-cmd">hg incoming</command> et l'exécution de
791 la commande <command role="hg-cmd">hg pull</command>, que vous ne
792 puissiez pas voir toutes les modifications que vous rapporterez d'un
793 autre dépôt. Supposons que vous récupériez les modifications d'un dépôt
794 situé quelque part sur le réseau. Alors que vous regardez le résultat de
795 la commande <command role="hg-cmd">hg incoming</command>, et avant que
796 vous ne décidiez de récupérer ces modifications, quelqu'un peut ajouter
797 de nouvelles révisions dans le dépôt distant. Ce qui signifie que vous
798 récupérez plus de révision que ce que vous aviez regardées en utilisant
799 la commande <command role="hg-cmd">hg incoming</command>.</para>
801 <para id="x_718">Si vous voulez seulement récupérer ce que vous aviez
802 vérifier à l'aide de la commande <command role="hg-cmd">hg
803 incoming</command>, ou que pour d'autres raisons vous souhaitiez ne
804 récupérer qu'un sous ensemble des révisions supplémentaires
805 disponibles, indiquant simplement les modifications que vous souhaitez
806 récupérer par leurs ID de révision, soit <command>hg pull
807 -r7e95bb</command>. </para>
808 </tip>
810 </sect2>
811 <sect2>
812 <title>Mise à jour de l'espace de travail</title>
814 <para id="x_5e">Nous avons jusqu'à maintenant grossièrement défini la
815 relation entre un dépôt et un espace de travail. La commande <command
816 role="hg-cmd">hg pull</command> que nous avons exécutée dans la section
817 <xref linkend="sec:tour:pull"/> a apporté des modifications, que nous
818 avons vérifiées, dans notre dépôt, mais il n'y a aucune trace de ces
819 modifications dans notre espace de travail. En effet, <command
820 role="hg-cmd">hg pull</command> ne touche pas (par défaut) à l'espace
821 de travail. C'est la commande <command role="hg-cmd">hg update</command>
822 qui s'en charge.</para>
824 &interaction.tour.update;
826 <para id="x_5f">Il peut sembler un peu étrange que la commande <command
827 role="hg-cmd">hg pull</command> ne mette pas à jour l'espace de travail
828 automatiquement. Il y a en fait une très bonne raison à cela : vous
829 pouvez utilisez la commande <command role="hg-cmd">hg update</command>
830 pour mettre à jour votre espace de travail à l'état dans lequel il était
831 à <emphasis>n'importe quelle révision</emphasis> de l'historique du dépôt.
832 Si vous aviez un espace de travail contenant une ancienne
833 révision&emdash;pour chercher l'origine d'un bug, par exemple&emdash;et
834 que vous effectuiez un <command role="hg-cmd">hg pull</command> qui
835 mettrait à jour automatiquement votre espace de travail, vous ne seriez
836 probablement pas très satisfait.</para>
838 <para id="x_60">Néanmoins, comme les opérations de pull sont très souvent
839 suivies d'un update, Mercurial vous permet de combiner les
840 deux aisément en passant l'option <option role="hg-opt-pull">-u</option>
841 à la commande <command role="hg-cmd">hg pull</command>.</para>
843 <para id="x_61">Si vous étudiez de nouveau la sortie de la commande <command
844 role="hg-cmd">hg pull</command> dans la section <xref
845 linkend="sec:tour:pull"/> quand nous l'avons exécutée sans l'option
846 <option role="hg-opt-pull">-u</option>, vous pouvez constater qu'elle a
847 affiché un rappel assez utile : vous devez encore effectuer une
848 opération pour mettre à jour votre espace de travail.</para>
850 <para id="x_62">Pour découvrir sur quelle révision de l'espace de
851 travail on se trouve, utilisez la commande <command role="hg-cmd">hg
852 parents</command>.</para>
854 &interaction.tour.parents;
856 <para id="x_63">Si vous regardez de nouveau le dessin <xref
857 linkend="fig:tour-basic:history"/>, vous verrez les flèches reliant
858 entre elles les révisions. Le nœud d'où la flèche
859 <emphasis>part</emphasis> est dans chaque cas un parent,
860 et le nœud où la flèche <emphasis>arrive</emphasis> est un
861 enfant.</para>
863 <para id="x_64">Pour mettre à jour l'espace de travail d'une révision
864 particulière, indiquez un numéro de révision ou un \textit{changeset
865 ID} à la commande <command role="hg-cmd">hg update</command>.</para>
867 &interaction.tour.older;
869 <para id="x_65">Si vous ne précisez pas de manière explicite de numéro
870 de révision la commande <command role="hg-cmd">hg update</command>
871 mettra à jour votre espace de travail avec le contenu de la révison
872 \textit{tip}, comme montré dans l'exemple ci dessus lors du second
873 appel à <command role="hg-cmd">hg update</command>.</para>
875 </sect2>
876 <sect2>
877 <title>Transférer les modifications vers un autre dépôt</title>
879 <para id="x_66">Mercurial vous laisse transférer les modifications vers
880 un autre dépôt, depuis votre dépôt actuel. Comme dans l'exemple du
881 <command role="hg-cmd">hg pull</command> ci-dessus, nous allons créer
882 un dépôt temporaire vers lequel transférer nos modifications.</para>
884 &interaction.tour.clone-push;
886 <para id="x_67">La commande <command role="hg-cmd">hg outgoing</command>
887 nous indique quels changements nous allons transférer vers l'autre
888 serveur.</para>
890 &interaction.tour.outgoing;
892 <para id="x_68">Et la commande <command role="hg-cmd">hg push</command>
893 effectue réellement le transfert.</para>
895 &interaction.tour.push;
897 <para id="x_69">Comme avec <command role="hg-cmd">hg pull</command>, la
898 commande <command role="hg-cmd">hg push</command> ne met pas à jour
899 le répertoire de travail du dépôt dans lequel il transfère les
900 modifications. À l'inverse de <command role="hg-cmd">hg
901 pull</command>, <command role="hg-cmd">hg push</command> ne fournit
902 pas d'option <literal>-u</literal> pour forcer la mise à jour de
903 l'espace de travail cible. Cette asymétrie est délibéré : le dépot
904 vers lequel nous transférons peut très bien être un serveur distant
905 et partagé par plusieurs personnes. Si nous devions mettre à jour son
906 répertoire de travail alors que quelqu'un d'autre travaille dessus,
907 nous risquerions de perturber son travail.</para>
909 <para id="x_6a">Qu'est ce qui se passe lorsque vous essayez de récupérer
910 ou de transférer vos modifications et que le dépôt cible a déjà reçu
911 ces modifications ? Rien de bien excitant.</para>
913 &interaction.tour.push.nothing;
915 </sect2>
917 <sect2>
918 <title>Emplacements par défaut</title>
920 <para id="x_719">Quand nous faisons un clone d'un dépôt, Mercurial
921 enregistre l'emplacement du dépôt d'origine dans le fichier
922 <filename>.hg/hgrc</filename> de notre nouveau dépôt. Si nous ne
923 fournissons pas d'emplacement à la commande <command>hg
924 pull</command> ou à la commande <command>hg push</command>, ces
925 commandes utiliseront alors cet emplacement comme valeur par défaut.
926 Les commandes <command>hg incoming</command> et <command>hg
927 outgoing</command> feront de même.</para>
929 <para id="x_71a">Si vous regardez le fichier
930 <filename>.hg/hgrc</filename>, vous constaterez que son contenu
931 ressemble à ce qui suit.</para>
933 <programlisting>[paths]
934 default = http://www.selenic.com/repo/hg</programlisting>
936 <para id="x_71b">Il est possible&emdash;et souvent
937 pratique&emdash;d'avoir un emplacement par défaut pour les commandes
938 <command>hg push</command> et <command>hg outgoing</command>
939 différent de celui des commandes <command>hg pull</command> et
940 <command>hg incoming</command>. C'est faisable en ajoutant une entrée
941 <literal>default-push</literal> à la section
942 <literal>[paths]</literal> du <filename>.hg/hgrc</filename>, comme
943 suit.</para>
945 <programlisting>[paths]
946 default = http://www.selenic.com/repo/hg
947 default-push = http://hg.example.com/hg</programlisting>
949 </sect2>
950 <sect2>
951 <title>Partager ses modifications à travers le réseau</title>
953 <para id="x_6b">Les commandes que nous avons étudiées dans les sections
954 précédentes ne sont pas limitées aux dépôts locaux. Chacune fonctionne
955 de la même manière à travers une connexion réseau, il suffit de lui
956 passer une URL à la place d'un chemin de fichier local.</para>
958 &interaction.tour.outgoing.net;
960 <para id="x_6c">Dans cet exemple, nous allons voir quels changements
961 nous pourrions transférer vers le dépôt distant, mais le dépôt est,
962 de manière tout à fait compréhensible, pas configuré pour accepter
963 des modifications d'utilisateurs anonymes.</para>
965 &interaction.tour.push.net;
967 </sect2>
969 </sect1>
971 <sect1>
972 <title>Commencer un nouveau projet</title>
974 <para id="x_71c">Il est tout aussi aisé de commencer un nouveau projet
975 que de travailler sur un qui existe déjà. La commande <command>hg
976 init</command> crée un nouveau dépôt Mercurial vide.</para>
978 &interaction.ch01-new.init;
980 <para id="x_71d">Ceci crée simplement un répertoire nommé
981 <filename>myproject</filename> dans le répertoire courant.</para>
983 &interaction.ch01-new.ls;
985 <para id="x_71e">Nous pouvons dire que <filename>myproject</filename> est
986 un dépôt Mercurial car il contient un répertoire
987 <filename>.hg</filename>.</para>
989 &interaction.ch01-new.ls2;
991 <para id="x_71f">Si vous voulons ajouter quelques fichiers préexistants
992 dans ce dépôt, il suffit de les recopier dans le répertoire de travail,
993 et demander à Mercurial de commencer à les suivre en utilisant la
994 commande <command>hg add</command>.</para>
996 &interaction.ch01-new.add;
998 <para id="x_720">Une fois que nous sommes satisfaits de notre projet,
999 nous pouvons commencer à ajouter nos révisions.</para>
1001 &interaction.ch01-new.commit;
1003 <para id="x_721">Il ne prend que quelques instants pour commencer à
1004 utiliser Mercurial sur un nouveau projet, ce qui fait aussi de ses
1005 points forts. Travailler avec une gestion de révision devient très
1006 facile, nous pouvons même l'utiliser pour les plus petits projets où
1007 nous aurions probablement jamais penser utiliser un outils aussi
1008 complexe.</para>
1009 </sect1>
1010 </chapter>
1012 <!--
1013 local variables:
1014 sgml-parent-document: ("00book.xml" "book" "chapter")
1015 end:
1016 -->