hgbook
view fr/ch02-tour-basic.xml @ 997:c9ad85fd2f38
Fixing some XML and DTD errors to allow build of HgBook Fr
| author | Romain PELISSE <belaran@gmail.com> |
|---|---|
| date | Sat Sep 12 20:52:03 2009 +0200 (2009-09-12) |
| parents | 5e1e70fcdfdb |
| children | 0d743c1cf101 |
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</programlisting></listitem>
55 <listitem><para id="x_5">Fedora:</para>
56 <programlisting>yum install mercurial</programlisting></listitem>
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
61 mercurial</programlisting></listitem>
62 </itemizedlist>
64 </sect2>
65 <sect2>
66 <title>Solaris</title>
68 <para id="x_09">SunFreeWare, à <ulink
69 url="http://www.sunfreeware.com">http://www.sunfreeware.com</ulink>,
70 fournit des paquets précompilés pour Mercurial.</para>
71 </sect2>
72 </sect1>
74 <sect1>
75 <title>Commencer à utiliser Mercurial</title>
77 <para id="x_e">Pour commencer, nous utiliserons la commande <command
78 role="hg-cmd">hg version</command> pour vérifier si Mercurial est
79 installé proprement. Les informations affichées sur la version ne sont
80 pas réellement importantes en soit, c'est surtout de savoir si elles
81 s'affichent qui nous intéresse.</para>
83 &interaction.tour.version;
85 <sect2>
86 <title>L'aide intégrée</title>
88 <para id="x_f">Mercurial fournit un système d'aide intégré, ce qui est
89 inestimable quand vous vous retrouvez coincé à essayer de vous
90 rappeler comment lancer une commande. Si vous êtes bloqué, exécutez
91 simplement <command role="hg-cmd">hg help</command>; elle affichera
92 une brève liste des commandes, avec une description pour chacune. Si
93 vous demandez de l'aide sur une commande spécifique (voir
94 ci-dessous), elle affichera des informations plus détaillées.</para>
96 &interaction.tour.help;
98 <para id="x_10">Pour un niveau d'informations encore plus détaillé
99 (ce dont vous aurez rarement besoin), exécuter <command role="hg-cmd">hg
100 help <option role="hg-opt-global">-v</option></command>. L'option
101 <option role="hg-opt-global">-v</option> est l'abréviation de
102 <option role="hg-opt-global">--verbose</option>, et indique à Mercurial
103 d'ficher plus d'informations que d'habitude.</para>
105 </sect2>
106 </sect1>
107 <sect1>
108 <title>Travailler avec un dépôt</title>
110 <para id="x_11">Avec Mercurial, tout se déroule au sein du
111 <emphasis>dépôt</emphasis>. Le dépôt d'un projet contient tous
112 les fichiers qui <quote>appartiennent</quote> au projet.</para>
114 <para id="x_12">Il n'y a rien de particulièrement magique au sujet de
115 ce dépôt, c'est simplement une arborescence sur votre système de fichiers
116 que Mercurial traite de manière spéciale. Vous pouvez renommer ou effacer
117 ce répertoire à n'impporte quel moment, en utilisant la ligne de commande
118 ou votre explorateur de fichiers.</para>
120 <sect2>
121 <title>Faire une copie locale de votre dépôt</title>
123 <para id="x_13"><emphasis>Copier</emphasis> un dépôt est juste un
124 peu spécial. Bien que vous puissiez utiliser une commande habituelle de
125 copie pour copier votre dépôt, il vaut mieux utiliser une commande fournie par
126 Mercurial. Cette commande est appelée <command role="hg-cmd">hg clone</command>,
127 car elle crée une copie identique à un dépôt existant.</para>
129 &interaction.tour.clone;
131 <para id="x_67c">Un avantage de la commande <command role="hg-cmd">hg
132 clone</command> est que, comme nous l'avons vu ci dessus, elle nous
133 permet de faire de cloner les dépôts à travers le réseau. Un autre
134 est qu'elle se rappelle d'où a été cloné un dépôt, ce qui est utile
135 quand on veut mettre à jour le clone.</para>
137 <para id="x_14">Si votre opération de clonage réussit, vous devriez maintenant
138 avoir un répertoire local appelé <filename class="directory">hello</filename>.
139 Ce répertoire contiendra quelques fichiers.</para>
141 &interaction.tour.ls;
143 <para id="x_15">Ces fichiers ont le même contenu et historique dans votre dépôt
144 qu'ils ont dans le dépôt que vous avez cloné.</para>
146 <para id="x_16">Chaque dépôt Mercurial est complet, autonome et
147 indépendant. Il contient sa propre copie privée des fichiers du
148 projet et de leur historique. Le clone d'un dépôt se souvient de la
149 localisation du dépôt à partir duquel il a été clôné, mais il ne
150 communique pas avec ce dernier, ou un autre, à moins que vous ne lui
151 demandiez.</para>
153 <para id="x_17">Ce que tout ceci signifie pour le moment est que nous
154 sommes libres d'expérimenter avec ce dépôt, confiants dans le fait
155 qu'il s'agit d'un <quote>bac à sable</quote> qui n'affectera personne
156 d'autre.</para>
158 </sect2>
159 <sect2>
160 <title>Quel est le contenu d'un dépôt ?</title>
162 <para id="x_18">Prêtons plus attention un instant au contenu d'un dépôt.
163 Nous voyons qu'il contient un répertoire nommé <filename class="directory">.hg
164 </filename>. C'est ici que Mercurial conserve toutes ses
165 métadonnées.</para>
167 &interaction.tour.ls-a;
169 <para id="x_19">Le contenu du répertoire <filename class="directory">.hg
170 </filename> et ses sous répertoires sont les seuls propres à Mercurial.
171 Tous les autres fichiers et répertoires dans le dépôt sont à vous, et
172 vous pouvez en faire ce que vous voulez.</para>
174 <para id="x_1a">Pour introduire un peu de terminologie, le répertoire
175 <filename class="directory">.hg</filename> est un <quote>vrai</quote>
176 dépôt, et tous les fichiers et les répertoires qui coexistent avec lui,
177 sont désignés sous le nom <emphasis>espace de travail</emphasis>. Une
178 manière facile de se rappeler cette distinction est de retenir que le
179 <emphasis>dépôt</emphasis> contient l'<emphasis>historique</emphasis>
180 de votre projet, alors que l'<emphasis>espace de travail</emphasis>
181 contient un "<emphasis>snapshot</emphasis>" de votre projet à un certain
182 point de son historique.</para>
184 </sect2>
185 </sect1>
186 <sect1>
187 <title>Une promenade dans l'historique</title>
189 <para id="x_1b">Une des premières choses que vous aurez envie
190 de faire avec un nouveau dépôt, sera de comprendre son historique.
191 La commande <command role="hg-cmd">hg log</command> vous donne une
192 vue de l'historique.</para>
194 &interaction.tour.log;
196 <para id="x_1c">Par défaut, cette commande affiche à l'écran un bref paragraphe pour chaque
197 révision enregistrée pour ce projet. Dans la terminologie de Mercurial, nous
198 appelons chacun de ces évènements enregistrés un <emphasis>changeset</emphasis>, parce
199 qu'il contient un ensemble de modifications sur plusieurs fichiers.</para>
201 <para id="x_1d">La commande <command role="hg-cmd">hg log</command> affiche
202 ainsi ces informations :</para>
204 <itemizedlist>
205 <listitem><para id="x_1e"><literal>changeset</literal> : Ce champ contient
206 un nombre, séparé par deux points (:), d'une chaine hexadécimale. Il
207 s'agit en fait d'<emphasis>identifiants</emphasis> d'un changeset. Il y a
208 deux identifiants car le numéro de la révision est plus court et plus à
209 facile à saisir qu'une séquence hexadécimale.</para>
210 </listitem>
211 <listitem><para id="x_1f"><literal>user</literal> : L'identité de la personne
212 qui a créée ce %%% laisser le terme anglais car il sera affiché
213 changeset. C'est un champ libre de forme, mais la plupart du
214 temps il contient le nom et l'email de la personne.</para>
215 </listitem>
216 <listitem><para id="x_20"><literal>date</literal> : La date et l'heure à
217 laquelle le \textit{changeset} a été créé, ainsi que le fuseau horaire dans
218 lequelle il a été créé. (La date et l'heure sont locales à ce
219 \textit{fuseau}, elles indiquent donc quelle date et heure il était
220 pour la personne qui a créé ce changeset.</para>
221 </listitem>
222 <listitem><para id="x_21"><literal>résumé</literal>: La première ligne du
223 message que le créateur a associé à son changeset pour le décrire.</para>
224 </listitem>
225 <listitem><para id="x_67d">Certains changesets, comme le premier de la
226 liste ci-dessus ont un champ <literal>tag</literal>. Le tag est une autre
227 façon d'identifier un changeset en lui donnant un nom simple à retenir.
228 (Le tag nommé <literal>tip</literal> est spécial : il fait toujours
229 référence aux derniers changements dans le dépôt.)</para></listitem>
230 </itemizedlist>
232 <para id="x_22">Par défaut, la commande <command role="hg-cmd">hg log</command>
233 n'affiche qu'un résumé, il manque beaucoup de détails.</para>
235 <para id="x_23">La figure <xref linkend="fig:tour-basic:history"/> fournit une
236 représentation graphique de l'historique du dépôt <filename class="directory">hello
237 </filename>, pour rendre plus facile de voir dans quelle direction
238 l'historique se <quote>déroule</quote>. Nous reviendrons régulièrement
239 sur cette représentation dans ce chapitre et ceux qui suivent.</para>
242 <figure id="fig:tour-basic:history">
243 <title>Graphical history of the <filename
244 class="directory">hello</filename> repository</title>
245 <mediaobject>
246 <imageobject><imagedata fileref="figs/tour-history.png"/></imageobject>
247 <textobject><phrase>XXX add text</phrase></textobject>
248 </mediaobject>
249 </figure>
252 <sect2>
253 <title>Changesets, révisions, et collaboration</title>
255 <para id="x_25">Comme l'anglais est réputé pour être un langage maladroit,
256 et que l'informatique est la source de bien des erreurs de terminologie
257 (pourquoi utiliser un seul terme quand quatre feront l'affaire ?), la
258 gestion de version a une variété de mots et de phrases qui veulent dire
259 la même chose. Si vous discutez d'historique de Mercurial avec d'autres
260 personnes, vous constaterez que souvent, le mot <quote>changeset</quote>
261 est contracté simplement en <quote>change</quote> ou (à l'écrit)
262 <quote>cset</quote>, et même parfois un changeset
263 <quote>révision</quote>, abrégé en <quote>rev</quote>.</para>
265 <para id="x_26">Bien que le <emphasis>mot</emphasis> que vous utilisez pour
266 désigner le concept de changeset importe peu, l'<emphasis>identifiant</emphasis>
267 que vous utilisez pour désigner un <emphasis>changeset</emphasis> spécifique
268 a une grande importance. Rappelez vous que le champ changeset affiché par la
269 commande <command role="hg-cmd">hg log</command> identifie un changeset à
270 la fois avec un numéro de révision et une séquence hexadécimale.</para>
272 <itemizedlist>
273 <listitem><para id="x_27">Le numéro de révision est <emphasis>seulement
274 valable dans ce dépôt</emphasis>,</para></listitem>
275 <listitem><para id="x_28">La séquence hexadécimale est un
276 <emphasis>identifiant permanent, et invariant</emphasis> qui
277 pourra toujours être associé au changeset exact de <emphasis>chaque</emphasis>
278 copie de votre dépôt.</para></listitem></itemizedlist>
280 <para id="x_29">La distinction est importante. Si vous envoyez un email
281 à quelqu'un en parlant de la <quote>révision 33</quote>, il est très
282 probable que sa révision 33 <emphasis>ne sera pas la même</emphasis>
283 que la votre. La raison de ceci est que le numéro de révision dépend
284 de l'ordre dans lequel les modifications sont arrivées dans le dépôt,
285 et il n'y a aucune garantie que les mêmes changements soient arrivés
286 dans le même ordre dans différents dépôts. Trois modifications
287 <literal>a,b,c</literal> peuvent aisément apparaitre dans un dépôt
288 comme <literal>0,1,2</literal>, et dans un autre comme <literal>0,2,1
289 </literal>.</para>
291 <para id="x_2a">Mercurial utilise les numéros de révision uniquement comme des raccourcis
292 pratiques. Si vous devez discuter d'un \textit{changeset} avec quelqu'un,
293 ou identifer un \textit{changeset} pour une quelconque raison (par exemple,
294 un rapport de \textit{bug}), utilisez la séquence hexadécimale.</para>
296 </sect2>
297 <sect2>
298 <title>Afficher une révision spécifique</title>
300 <para id="x_2b">Pour réduire la sortie de <command role="hg-cmd">hg log
301 </command> à une seule révision, utilisez l'option <option role="hg-opt-log">-r
302 </option> (ou <option role="hg-opt-log">--rev</option>). Vous pouvez utiliser
303 le numéro de révision ou la séquence hexadécimale comme identifiant, et
304 demander autant de révisions que vous le souhaitez.</para>
306 &interaction.tour.log-r;
308 <para id="x_2c">Si vous voulez voir l'historique de plusieurs révisions
309 sans avoir à les énumérer, vous pouvez utiliser la <emphasis>intervalle
310 de numérotation</emphasis> qui vous permet d'exprimer l'idée <quote>je
311 veux toutes les révisions entre $a$ et $b$, inclus</quote></para>
313 &interaction.tour.log.range;
315 <para id="x_2d">Mercurial respecte aussi l'ordre dans lequel vous spécifiez
316 les révisions, ainsi <command role="hg-cmd">hg log -r 2:4</command>
317 affichera <literal>2,3,4</literal> alors que <command role="hg-cmd">hg
318 log -r 4:2</command> affichera <literal>4,3,2</literal>.</para>
320 </sect2>
321 <sect2>
322 <title>Informations détaillées</title>
324 <para id="x_2e">Le résumé affiché par <command role="hg-cmd">hg log</command>
325 est suffisant si vous savez déjà ce que vous cherchez. En
326 revanche, vous aurez probablement besoin de voir une description
327 complète du changement, ou une liste des fichiers modifiés si vous
328 cherchez à déterminer qu'un changeset est bien celui que vous
329 recherchez. L'option \hgopt{-v} de la commande <command role="hg-cmd">hg
330 log</command> (ou <option role="hp-opt-global">--verbose</option>) vous
331 donne ces informations supplémentaires.</para>
333 &interaction.tour.log-v;
335 <para id="x_2f">Si vous voulez voir à la fois la description
336 et le contenu d'une modification, ajouter l'option <option
337 role="hg-opt-log">-p</option> (ou <option role="hg-opt-log">
338 --patch</option>). Ceci affiche le contenu d'une modification
339 comme un <emphasis>diff unifié</emphasis>
340 <!-- \footnote{NdT: \textit{unified diff}} -->
341 (si vous n'avez jamais vu de diff unifié avant, consultez la
342 section <xref linkend="sec:mq:patch"/> pour un rapide
343 survol).</para>
345 &interaction.tour.log-vp;
347 <para id="x_67e">L'option <option role="hg-opt-log">-p</option> est
348 incroyablement utile, il est donc important dans s'en rappeller.</para>
350 </sect2>
351 </sect1>
352 <sect1>
353 <title>Tout sur les options de commandes</title>
355 <para id="x_30">Avant d'aller plus loin sur le fonctionnement
356 des commandes de Mercurial, étudions un moment comment elles
357 fonctionnent de manière générale. Vous trouverez ça probablement
358 utile pour la suite de notre parcours.</para>
360 <para id="x_31">Mercurial utilise une approche directe et cohérente
361 pour interpréter les options que vous passez aux commandes. Il suit une
362 convention commune à la plupart des systèmes Unix et Linux modernes.</para>
364 <itemizedlist>
365 <listitem><para id="x_32">Chaque option a un nom complet. Par exemple,
366 comme nous l'avons déjà vu, la commande <command role="hg-cmd">hg
367 log</command> accepte l'option <option role="hg-opt-log">--rev
368 </option>.</para>
369 </listitem>
370 <listitem><para id="x_33">La plupart des options disposent de
371 noms abrégés. Aussi, au lieu d'utiliser <option role="hg-opt-log">--rev
372 </option>, vous pouvez utiliser <option role="hg-opt-log">-r</option>.
373 (Les options qui n'ont pas de noms abrégés sont généralement
374 rarement utilisées).</para>
375 </listitem>
376 <listitem><para id="x_34">Les noms complets commencent par deux
377 tirets (i.e. <option role="hg-opt-log">--rev</option>),
378 alors que les options courtes commencent avec un seul (i.e.
379 <option role="hg-opt-log">-r</option>).</para>
380 </listitem>
381 <listitem><para id="x_35">Les noms des options sont cohérents
382 entre les commandes. Par exemple, chaque commande qui accepte
383 un changeset ID ou un numéro de révision accepte aussi <option
384 role="hg-opt-log">-r</option> et <option role="hg-opt-log">--rev
385 </option> comme arguments.</para>
386 </listitem>
387 </itemizedlist>
389 <para id="x_36">Dans les exemples de ce livre, j'utilise les noms abrégés
390 plutôt que les noms complets. Ceci est une préférence personnelle, pas
391 une recommandation.</para>
393 <para id="x_37">La plupart des commandes qui affichent une quelconque sortie
394 à l'écran, afficheront davantage avec l'option <option role="hg-opt-global">
395 -v</option> (ou <option role="hg-opt-global">--verbose</option>), et
396 moins avec l'option <option role="hg-opt-global">-q</option> (ou
397 <option role="hg-opt-global">--quiet</option>).</para>
399 <note>
400 <title>Option naming consistency</title>
402 <para id="x_680">Presque toujours, les commandes de Mercurial utilisent
403 des noms d'options cohérentes pour référer à des concepts identiques.
404 Par exemple, si une commande concerne les changesets, vous les
405 identifierez toujours avec l'option <option role="hg-opt-log">-r</option>.
406 Cette utilisation cohérente des noms d'options permet de mémoriser plus
407 facilement quelles options accepte une commande.</para>
408 </note>
411 </sect1>
412 <sect1>
413 <title>Faire et vérifier des modifications</title>
415 <para id="x_38">Maintenant que nous avons une bonne idée des
416 commandes pour consulter l'historique de Mercurial, regardons
417 comment faire des modifications et les examiner.</para>
419 <para id="x_39">La première chose que nous allons faire c'est isoler notre
420 expérience dans un dépôt à part. Nous allons utiliser la commande <command
421 role="hg-cmd">hg clone</command>, mais nous n'avons pas besoin de faire
422 une copie de dépôt distant. Comme nous avons déjà une copie locale, nous
423 pouvons juste faire un clone de celle-ci à la place. C'est beaucoup plus
424 rapide que de faire une copie à travers le réseau, et un dépôt cloné
425 localement prend également moins d'espace disque<footnote>
426 <para id="x_681">L'économie d'espace disque apparait clairement quand les
427 dépôts source et destination sont sur le même système de fichier, où, dans
428 ce cas, Mercurial utilisera des liens physiques pour effectuer des partages
429 copie-lors-des-écritures de ses métadonnées internes. Si cette explication
430 ne signifie rien pour vous, ne vous inquietez pas : tout ceci se passe de
431 manière transparente et automatiquement. Vous n'avez pas du tout besoin de
432 comprendre ceci.</para></footnote>.</para>
434 &interaction.tour.reclone;
436 <para id="x_3a">On notera au passage qu'il est souvent considéré comme
437 une bonne pratique de conserver une copie <quote>immaculée</quote>
438 du dépôt distant, à partir de laquelle vous pourrez faire des
439 copies locales temporaires pour créer des <quote>bacs à sable</quote>
440 pour chaque tâche sur laquelle vous souhaitez travailler. Ceci
441 vous permet de travailler sur plusieurs choses en parallèle,
442 chacune isolée les unes des autres en attendant que ces tâches
443 soient finies et que vous soyez prêt à les réintégrer. Parce
444 que les copies locales sont peu coûteuses, il est très rapide
445 de créer ou détruire des dépôts dès que vous n'en avez plus
446 besoin.</para>
448 <para id="x_3b">Dans notre dépôt <filename
449 class="directory">my-hello</filename>, nous avons un fichier
450 <filename>hello.c</filename> qui contient le classique <quote>hello,
451 world</quote>.</para>
453 &interaction.tour.cat1;
455 <para id="x_682">Editons ce fichier pour qu'il affiche une autre ligne
456 sur la sortie standard.</para>
458 &interaction.tour.cat2;
460 <para id="x_3c">La commande Mercurial <command role="hg-cmd">hg
461 status</command> nous dira ce que Mercurial sait des fichiers du
462 dépôts.</para>
464 &interaction.tour.status;
466 <para id="x_3d">La commande <command role="hg-cmd">hg status</command>
467 n'affichera pas le contenu des fichiers, mais une ligne commençant par
468 <quote><literal>M</literal></quote> pour <filename>hello.c</filename>.
469 A moins que vous lui demandiez, la commande <command role="hg-cmd">hg
470 status</command> n'affichera aucune information sur les fichiers que
471 vous n'avez pas modifiés.</para>
473 <para id="x_3e">Le <quote><literal>M</literal></quote> indique que
474 Mercurial a remarqué que nous avons modifié le fichier
475 <filename>hello.c</filename>. Nous n'avons pas besoin
476 <emphasis>d'informer</emphasis> Mercurial que nous allons modifier un
477 fichier avant de commencer à le faire, ou que nous avons modifié un
478 fichier après avoir commencé à le faire, il est capable de découvrir ça
479 tout seul. </para>
481 <para id="x_3f">C'est déjà pratique de savoir que nous avons modifié le
482 fichier <filename>hello.c</filename>, mais nous préférerions savoir
483 exactement <emphasis>ce que</emphasis> nous avons changé. Pour ceci, nous
484 utilisons la commande <command role="hg-cmd">hg diff</command>.</para>
486 &interaction.tour.diff;
488 <tip>
489 <title>Comprendre les patches</title>
491 <para id="x_683">Penser à jeter un oeil à <xref
492 linkend="sec:mq:patch"/> si vous n'arrivez pas à lire la sortie
493 ci-dessus.</para>
494 </tip>
495 </sect1>
496 <sect1>
497 <title>Enregister vos modifications dans une nouvelle révision</title>
499 <para id="x_40">Nous pouvons modifier des fichiers, compiler et tester
500 nos modifications, et utiliser les commandes <command role="hg-cmd">hg
501 status</command> et <command role="hg-cmd">hg diff</command> pour
502 voir les modifications effectuées, jusqu'à ce que nous soyons assez
503 satisfaits pour décider d'enregistrer notre travail dans un
504 \textit{changeset}.</para>
506 <para id="x_41">La commande <command role="hg-cmd">hg commit</command>
507 vous laisse créer une nouvelle révision, nous désignerons généralement
508 cette opération par <quote>faire un commit</quote> ou
509 <quote>committer</quote>.</para>
511 <sect2>
512 <title>Définir le nom d'utilisateur</title>
514 <para id="x_42">Quand vous exécutez la commande <command
515 role="hg-cmd">hg commit</command> pour la première fois, il n'est
516 pas garanti qu'elle réussisse du premier coup. En effet, Mercurial
517 enregistre votre nom et votre adresse avec chaque modification que
518 vous effectuez, de manière à ce que vous soyez capable (ou d'autres
519 le soient) de savoir qui a fait quelle modification. Mercurial essaye
520 automatiquement de découvrir un nom d'utilisateur qui ait un minimum
521 de sens pour effectuer l'opération de commit avec. Il va essayer
522 chacune des méthodes suivantes, dans l'ordre :</para>
524 <orderedlist>
525 <listitem><para id="x_43">Si vous spécifiez l'option <option
526 role="hg-opt-commit">-u</option> avec la commande <command
527 role="hg-cmd">hg commit</command>, suivi d'un nom
528 d'utilisateur, ceci aura toujours la priorité sur les autres
529 méthodes ci dessous.</para></listitem>
530 <listitem><para id="x_44">Si vous avez défini une variable
531 d'environnement <envar>HGUSER</envar>, c'est cette valeur qui est
532 alors utilisée.</para></listitem>
533 <listitem><para id="x_45">Si vous créez un fichier nommé <filename
534 role="special">.hgrc</filename> dans votre répertoire
535 \textit{home}, avec une entrée <envar
536 role="rc-item-ui">username</envar>, c'est la valeur associée
537 qui sera utilisée. Pour voir à quoi ressemble le contenu de ce
538 fichier regardez la section <xref
539 linkend="sec:tour-basic:username"/>
540 ci-dessous.</para></listitem>
541 <listitem><para id="x_46">Si vous avez défini une variable
542 d'environnement <envar>EMAIL</envar> celle ci sera utilisée
543 ensuite.</para></listitem>
544 <listitem><para id="x_47">Enfin, Mercurial interrogera votre système
545 pour trouver votre nom d'utilisateur local ainsi que le nom de la
546 machine hôte, et il fabriquera un nom d'utilisateur à partir de
547 ces données. Comme il arrive souvent que ce genre de noms soit
548 totalement inutile, il vous préviendra en affichant un message
549 d'avertissement.</para></listitem>
550 </orderedlist>
552 <para id="x_48">Si tous ces mécanismes échouent, Mercurial n'exécutera
553 pas la commande, affichant un message d'erreur. Dans ce cas, il ne
554 vous laissera pas effectuer de commit tant que vous n'aurez pas
555 défini un nom d'utilisateur.</para>
557 <para id="x_49">Vous devriez penser à utiliser la variable
558 d'environement <envar>HGUSER</envar> et l'option <option
559 role="hg-opt-commit">-u</option> comme moyen pour
560 <emphasis>changer</emphasis> le nom d'utilisateur par défaut. Pour
561 une utilisation normale, la manière la plus simple et robuste
562 d'opérer est de créer un fichier <filename
563 role="special">.hgrc</filename>, voir ci-dessous pour les détails
564 à ce sujet.</para>
566 <sect3 id="sec:tour-basic:username">
567 <title>Créer un fichier de configuration pour Mercurial</title>
569 <para id="x_4a">Pour définir un nom d'utilisateur, utilisez votre
570 éditeur de texte favori pour créer un fichier <filename
571 role="special">.hgrc</filename> dans votre répertoire home.
572 Mercurial va utiliser ce fichier pour retrouver votre
573 configuration personnelle. Le contenu initial devrait
574 ressembler à ceci :</para>
576 <tip>
577 <title><quote>Home directory</quote> sous Windows</title>
579 <para id="x_716">Quand on parle de répertoire home, sur une version
580 anglaise d'une installation de Windows, il s'agira habituellement
581 d'un répertoire nommée comme votre nom dans <filename>C:\Documents
582 and Settings</filename>. Vous pouvez trouver de quelle répertoire
583 il s'agit en lançant une fenêtre d'interpréteur de commande et en
584 exécutant la commande suivante :</para>
586 <screen><prompt>C:\</prompt> <userinput>echo
587 %UserProfile</userinput></screen>
588 </tip>
590 <programlisting># This is a Mercurial configuration file.
591 [ui]
592 username = Firstname Lastname <email.address@domain.net></programlisting>
594 <para id="x_4b">La ligne avec <literal>[ui]</literal> commence une
595 <emphasis>section</emphasis> du fichier de configuration, ainsi la ligne
596 <quote><literal>username = ...</literal></quote> signifie <quote>
597 définir la valeur de l'élément <literal>username</literal> dans la
598 section <literal>ui</literal></quote>. Une section continue jusqu'à ce
599 qu'une nouvelle commence, ou que la fin du fichier soit atteinte.
600 Mercurial ignore les lignes vides et traite tout texte situé à la suite
601 d'un <quote><literal>#</literal></quote> jusqu'à la fin de la ligne
602 comme un commentaire.</para>
604 </sect3>
605 <sect3>
606 <title>Choisir un nom d'utilisateur</title>
608 <para id="x_4c">Vous pouvez utiliser n'importe quelle valeur
609 pour votre <literal>username</literal>, car cette information
610 est destinée à d'autres personnes et non à être interprétée
611 par Mercurial. La convention que la plupart des personnes
612 suivent est d'utiliser leurs noms suivies de leurs adresses emails,
613 comme montré ci-dessus :</para>
614 <note>
615 <para id="x_4d">Le mécanisme interne du serveur web intégré à Mercurial,
616 masque les adresses emails, pour rendre plus difficile leurs
617 récupérations par les outils utilisés par les spammmers.
618 Ceci réduit la probabilité que de recevoir encore plus de
619 spam si vous vous publiez un dépôt sur internet.</para>
620 </note>
621 </sect3>
622 </sect2>
623 <sect2>
624 <title>Rédiger un message de \textit{commit}</title>
626 <para id="x_4e">Lorsqu'on effectue une opération de commit, Mercurial
627 lance automatiquement un éditeur de texte pour permettre de saisir
628 un message qui décrira les modifications effectuées dans cette
629 révision. Ce message est nommé le <emphasis>message de commit</emphasis>.
630 Ce sera un enregistrement pour tout lecteur expliquant le pourquoi
631 et le comment de vos modifications, et il sera affiché par la
632 commande <command role="hg-cmd">hg log</command>.</para>
634 &interaction.tour.commit;
636 <para id="x_4f">L'éditeur que la commande <command role="hg-cmd">hg
637 commit</command> déclenche ne contiendra qu'une ligne vide suivi
638 d'un certain nombre de lignes commençant par <quote><literal>HG:
639 </literal></quote>.</para>
641 <programlisting>
642 This is where I type my commit comment.
644 HG: Enter commit message. Lines beginning with 'HG:' are removed.
645 HG: --
646 HG: user: Bryan O'Sullivan <bos@serpentine.com>
647 HG: branch 'default'
648 HG: changed hello.c</programlisting>
651 <para id="x_50">Mercurial ignore les lignes qui commencent
652 avec <quote><literal>HG:</literal></quote>, il ne les
653 utilise que pour nous indiquer quels fichiers modifiés il se
654 prépare à \textit{commiter}. Modifier ou effacer ces lignes n'a
655 aucune conséquence sur l'opération de commit.
656 </para>
658 </sect2>
659 <sect2>
660 <title>Rédiger un message \textit{approprié}</title>
662 <para id="x_51">Comme <command role="hg-cmd">hg log</command> n'affiche
663 que la première ligne du message de commit par défaut, il est souvent
664 considéré comme une bonne pratique de rédiger des messages de commit
665 qui tiennent sur une seule ligne. Voilà un exemple concret de message
666 de commit qui <emphasis>ne suit pas</emphasis> cette directive, et
667 qui a donc un résumé peu lisible.</para>
669 <programlisting>
670 changeset: 73:584af0e231be
671 user: Censored Person <censored.person@example.org>
672 date: Tue Sep 26 21:37:07 2006 -0700
673 summary: include buildmeister/commondefs. Add an exports and install
674 </programlisting>
676 <para id="x_52">A ce sujet, il faut noter qu'il n'existe pas de règle
677 absolue dans ce domaine. Mercurial lui-même n'interprète pas les
678 contenus des messages de commit, ainsi votre projet est libre de
679 concevoir différentes politiques de mise en page des messages.</para>
681 <para id="x_53">Ma préférence personnelle va au message court, mais
682 informatif, qui offre des précisions supplémentaires par rapport à ce
683 que pourrait m'apprendre une commande <command role="hg-cmd">hg log
684 --patch</command>.</para>
686 <para id="x_55">Si vous exécutez la commande <command role="hg-cmd">hg
687 commit</command> sans aucun argument, elle enregistre tous les
688 changements qui ont été fait, et qui sont indiqué par les commandes
689 <command role="hg-cmd">hg status</command> et <command
690 role="hg-cmd">hg diff</command>.</para>
692 <note>
693 <title>Une surprise pour les utilisateurs habitués à Subversion</title>
695 <para id="x_717">Comme n'importe quel autre commande de Mercurial, si
696 vous soumettez pas de manière explicite les noms des fichiers à
697 committer à la commande <command role="hg-cmd">hg commit</command>, elle
698 va travailler sur l'ensemble du répertoire de travail. Soyez conscient
699 de ceci si vous venez du monde Subversion ou CVS, car vous pourriez
700 attendre qu'elle opère uniquement le répertoire courant et ses sous
701 répertoires.</para>
702 </note>
703 </sect2>
704 <sect2>
705 <title>Annuler un \textit{commit}</title>
707 <para id="x_54">Si, en rédigeant le message, vous décidez que
708 finalement vous ne voulez pas effectuer ce commit, il suffit
709 de quitter simplement l'éditeur sans sauver. Ceci n'aura aucune
710 conséquence sur le dépôt ou les fichiers du répertoire de
711 travail.</para>
712 </sect2>
714 <sect2>
715 <title>Admirer votre travail</title>
717 <para id="x_56">Une fois que votre \textit{commit} est terminé, vous
718 pouvez utiliser la commande <command role="hg-cmd">hg tip</command>
719 pour afficher le \textit{changeset} que vous venez de créer. Cette
720 commande produit une sortie à l'écran qui est identique à celle du
721 <command role="hg-cmd">hg log</command>, mais qui n'affiche que la
722 dernière révision du dépôt.</para>
724 &interaction.tour.tip;
726 <para id="x_57">On fait couramment référence à la dernière révision
727 du dépôt comme étant la <emphasis>révision tip</emphasis>, ou plus
728 simplement le <emphasis>tip</emphasis>.</para>
730 <para id="x_684">Au passage, la commande <command role="hg-cmd">hg
731 tip</command> accepte la plupart des options qu'accepte
732 <command role="hg-cmd">hg log</command>. Ainsi <option
733 role="hg-opt-global">-v</option> ci dessus implique <quote>soit
734 verbeux</quote>, <option role="hg-opt-tip">-p</option>
735 veux dire <quote>affiche le patch</quote>. L'utilisation de l'option
736 <option role="hg-opt-tip">-p</option> pour afficher un patch est un
737 autre exemple de la cohérence des commandes évoquée plus tôt.</para>
739 </sect2>
740 </sect1>
741 <sect1>
742 <title>Partager ses modifications</title>
744 <para id="x_58">Nous avons mentionné plus haut que les dépôts
745 de Mercurial sont autosuffisants. Ce qui signifie que la nouvelle
746 révision que vous venez de créer existe seulement dans votre
747 répertoire <filename class="directory">my-hello</filename>. Étudions
748 comment propager cette modification dans d'autres dépôts.</para>
750 <sect2 id="sec:tour:pull">
751 <title>Récupérer les modifications d'autres dépôts</title>
753 <para id="x_59">Pour commencer, construisons un clone de notre dépôt
754 <filename class="directory">hello</filename> qui ne contiendra pas
755 le changement que nous venons d'effectuer. Nous l'appellerons notre
756 dépôt temporaire <filename
757 class="directory">hello-pull</filename>.</para>
759 &interaction.tour.clone-pull;
761 <para id="x_5a">Nous allons utiliser la commande <command
762 role="hg-cmd">hg pull</command> pour envoyer les modifications
763 depuis <filename class="directory">my-hello</filename> dans <filename
764 class="directory">hello-pull</filename>. Néanmoins, récupérer
765 aveuglement des modifications depuis un dépôt a quelque chose d'un
766 peu effrayant. Mercurial propose donc une commande <command
767 role="hg-cmd">hg incoming</command> qui permet de savoir quelles
768 modifications la commande <command role="hg-cmd">hg pull</command>
769 <emphasis>pourrait</emphasis> entraîner dans notre dépôt, et ceci
770 sans effectuer réellement de modification dessus.</para>
772 &interaction.tour.incoming;
774 <para id="x_5c">Apporter les modifications rapatriées dans un dépôt se
775 résume donc à exécuter la commande <command role="hg-cmd">hg
776 pull</command>, et préciser depuis quel dépôt effectuer le <command
777 role="hg-cmd">hg pull</command>.</para>
779 &interaction.tour.pull;
781 <para id="x_5d">Comme vous le voyez avec une sortie avant et après de la
782 commande <command role="hg-cmd">hg tip</command>, nous avons réussi à
783 récupérer aisément les modifications dans notre dépôt. Il reste néanmoins
784 quelque chose à faire avant de placer ces modifications dans l'espace de
785 travail.</para>
787 <tip>
788 <title>Récupérer des changements précis</title>
790 <para id="x_5b">Il est possible à cause du délai entre l'exécution de la
791 commande <command role="hg-cmd">hg incoming</command> et l'exécution de
792 la commande <command role="hg-cmd">hg pull</command>, que vous ne
793 puissiez pas voir toutes les modifications que vous rapporterez d'un
794 autre dépôt. Supposons que vous récupériez les modifications d'un dépôt
795 situé quelque part sur le réseau. Alors que vous regardez le résultat de
796 la commande <command role="hg-cmd">hg incoming</command>, et avant que
797 vous ne décidiez de récupérer ces modifications, quelqu'un peut ajouter
798 de nouvelles révisions dans le dépôt distant. Ce qui signifie que vous
799 récupérez plus de révision que ce que vous aviez regardées en utilisant
800 la commande <command role="hg-cmd">hg incoming</command>.</para>
802 <para id="x_718">Si vous voulez seulement récupérer ce que vous aviez
803 vérifier à l'aide de la commande <command role="hg-cmd">hg
804 incoming</command>, ou que pour d'autres raisons vous souhaitiez ne
805 récupérer qu'un sous ensemble des révisions supplémentaires
806 disponibles, indiquant simplement les modifications que vous souhaitez
807 récupérer par leurs ID de révision, soit <command>hg pull
808 -r7e95bb</command>. </para>
809 </tip>
811 </sect2>
812 <sect2>
813 <title>Mise à jour de l'espace de travail</title>
815 <para id="x_5e">Nous avons jusqu'à maintenant grossièrement défini la
816 relation entre un dépôt et un espace de travail. La commande <command
817 role="hg-cmd">hg pull</command> que nous avons exécutée dans la section
818 <xref linkend="sec:tour:pull"/> a apporté des modifications, que nous
819 avons vérifiées, dans notre dépôt, mais il n'y a aucune trace de ces
820 modifications dans notre espace de travail. En effet, <command
821 role="hg-cmd">hg pull</command> ne touche pas (par défaut) à l'espace
822 de travail. C'est la commande <command role="hg-cmd">hg update</command>
823 qui s'en charge.</para>
825 &interaction.tour.update;
827 <para id="x_5f">Il peut sembler un peu étrange que la commande <command
828 role="hg-cmd">hg pull</command> ne mette pas à jour l'espace de travail
829 automatiquement. Il y a en fait une très bonne raison à cela : vous
830 pouvez utilisez la commande <command role="hg-cmd">hg update</command>
831 pour mettre à jour votre espace de travail à l'état dans lequel il était
832 à <emphasis>n'importe quelle révision</emphasis> de l'historique du dépôt.
833 Si vous aviez un espace de travail contenant une ancienne
834 révision&emdash;pour chercher l'origine d'un bug, par exemple&emdash;et
835 que vous effectuiez un <command role="hg-cmd">hg pull</command> qui
836 mettrait à jour automatiquement votre espace de travail, vous ne seriez
837 probablement pas très satisfait.</para>
839 <para id="x_60">Néanmoins, comme les opérations de pull sont très souvent
840 suivies d'un update, Mercurial vous permet de combiner les
841 deux aisément en passant l'option <option role="hg-opt-pull">-u</option>
842 à la commande <command role="hg-cmd">hg pull</command>.</para>
844 <para id="x_61">Si vous étudiez de nouveau la sortie de la commande <command
845 role="hg-cmd">hg pull</command> dans la section <xref
846 linkend="sec:tour:pull"/> quand nous l'avons exécutée sans l'option
847 <option role="hg-opt-pull">-u</option>, vous pouvez constater qu'elle a
848 affiché un rappel assez utile : vous devez encore effectuer une
849 opération pour mettre à jour votre espace de travail.</para>
851 <para id="x_62">Pour découvrir sur quelle révision de l'espace de
852 travail on se trouve, utilisez la commande <command role="hg-cmd">hg
853 parents</command>.</para>
855 &interaction.tour.parents;
857 <para id="x_63">Si vous regardez de nouveau le dessin <xref
858 linkend="fig:tour-basic:history"/>, vous verrez les flèches reliant
859 entre elles les révisions. Le nœud d'où la flèche
860 <emphasis>part</emphasis> est dans chaque cas un parent,
861 et le nœud où la flèche <emphasis>arrive</emphasis> est un
862 enfant.</para>
864 <para id="x_64">Pour mettre à jour l'espace de travail d'une révision
865 particulière, indiquez un numéro de révision ou un \textit{changeset
866 ID} à la commande <command role="hg-cmd">hg update</command>.</para>
868 &interaction.tour.older;
870 <para id="x_65">Si vous ne précisez pas de manière explicite de numéro
871 de révision la commande <command role="hg-cmd">hg update</command>
872 mettra à jour votre espace de travail avec le contenu de la révison
873 \textit{tip}, comme montré dans l'exemple ci dessus lors du second
874 appel à <command role="hg-cmd">hg update</command>.</para>
876 </sect2>
877 <sect2>
878 <title>Transférer les modifications vers un autre dépôt</title>
880 <para id="x_66">Mercurial vous laisse transférer les modifications vers
881 un autre dépôt, depuis votre dépôt actuel. Comme dans l'exemple du
882 <command role="hg-cmd">hg pull</command> ci-dessus, nous allons créer
883 un dépôt temporaire vers lequel transférer nos modifications.</para>
885 &interaction.tour.clone-push;
887 <para id="x_67">La commande <command role="hg-cmd">hg outgoing</command>
888 nous indique quels changements nous allons transférer vers l'autre
889 serveur.</para>
891 &interaction.tour.outgoing;
893 <para id="x_68">Et la commande <command role="hg-cmd">hg push</command>
894 effectue réellement le transfert.</para>
896 &interaction.tour.push;
898 <para id="x_69">Comme avec <command role="hg-cmd">hg pull</command>, la
899 commande <command role="hg-cmd">hg push</command> ne met pas à jour
900 le répertoire de travail du dépôt dans lequel il transfère les
901 modifications. À l'inverse de <command role="hg-cmd">hg
902 pull</command>, <command role="hg-cmd">hg push</command> ne fournit
903 pas d'option <literal>-u</literal> pour forcer la mise à jour de
904 l'espace de travail cible. Cette asymétrie est délibéré : le dépot
905 vers lequel nous transférons peut très bien être un serveur distant
906 et partagé par plusieurs personnes. Si nous devions mettre à jour son
907 répertoire de travail alors que quelqu'un d'autre travaille dessus,
908 nous risquerions de perturber son travail.</para>
910 <para id="x_6a">Qu'est ce qui se passe lorsque vous essayez de récupérer
911 ou de transférer vos modifications et que le dépôt cible a déjà reçu
912 ces modifications ? Rien de bien excitant.</para>
914 &interaction.tour.push.nothing;
916 </sect2>
918 <sect2>
919 <title>Emplacements par défaut</title>
921 <para id="x_719">Quand nous faisons un clone d'un dépôt, Mercurial
922 enregistre l'emplacement du dépôt d'origine dans le fichier
923 <filename>.hg/hgrc</filename> de notre nouveau dépôt. Si nous ne
924 fournissons pas d'emplacement à la commande <command>hg
925 pull</command> ou à la commande <command>hg push</command>, ces
926 commandes utiliseront alors cet emplacement comme valeur par défaut.
927 Les commandes <command>hg incoming</command> et <command>hg
928 outgoing</command> feront de même.</para>
930 <para id="x_71a">Si vous regardez le fichier
931 <filename>.hg/hgrc</filename>, vous constaterez que son contenu
932 ressemble à ce qui suit.</para>
934 <programlisting>[paths]
935 default = http://www.selenic.com/repo/hg</programlisting>
937 <para id="x_71b">Il est possible&emdash;et souvent
938 pratique&emdash;d'avoir un emplacement par défaut pour les commandes
939 <command>hg push</command> et <command>hg outgoing</command>
940 différent de celui des commandes <command>hg pull</command> et
941 <command>hg incoming</command>. C'est faisable en ajoutant une entrée
942 <literal>default-push</literal> à la section
943 <literal>[paths]</literal> du <filename>.hg/hgrc</filename>, comme
944 suit.</para>
946 <programlisting>[paths]
947 default = http://www.selenic.com/repo/hg
948 default-push = http://hg.example.com/hg</programlisting>
950 </sect2>
951 <sect2>
952 <title>Partager ses modifications à travers le réseau</title>
954 <para id="x_6b">Les commandes que nous avons étudiées dans les sections
955 précédentes ne sont pas limitées aux dépôts locaux. Chacune fonctionne
956 de la même manière à travers une connexion réseau, il suffit de lui
957 passer une URL à la place d'un chemin de fichier local.</para>
959 &interaction.tour.outgoing.net;
961 <para id="x_6c">Dans cet exemple, nous allons voir quels changements
962 nous pourrions transférer vers le dépôt distant, mais le dépôt est,
963 de manière tout à fait compréhensible, pas configuré pour accepter
964 des modifications d'utilisateurs anonymes.</para>
966 &interaction.tour.push.net;
968 </sect2>
970 </sect1>
972 <sect1>
973 <title>Commencer un nouveau projet</title>
975 <para id="x_71c">Il est tout aussi aisé de commencer un nouveau projet
976 que de travailler sur un qui existe déjà. La commande <command>hg
977 init</command> crée un nouveau dépôt Mercurial vide.</para>
979 &interaction.ch01-new.init;
981 <para id="x_71d">Ceci crée simplement un répertoire nommé
982 <filename>myproject</filename> dans le répertoire courant.</para>
984 &interaction.ch01-new.ls;
986 <para id="x_71e">Nous pouvons dire que <filename>myproject</filename> est
987 un dépôt Mercurial car il contient un répertoire
988 <filename>.hg</filename>.</para>
990 &interaction.ch01-new.ls2;
992 <para id="x_71f">Si vous voulons ajouter quelques fichiers préexistants
993 dans ce dépôt, il suffit de les recopier dans le répertoire de travail,
994 et demander à Mercurial de commencer à les suivre en utilisant la
995 commande <command>hg add</command>.</para>
997 &interaction.ch01-new.add;
999 <para id="x_720">Une fois que nous sommes satisfaits de notre projet,
1000 nous pouvons commencer à ajouter nos révisions.</para>
1002 &interaction.ch01-new.commit;
1004 <para id="x_721">Il ne prend que quelques instants pour commencer à
1005 utiliser Mercurial sur un nouveau projet, ce qui fait aussi de ses
1006 points forts. Travailler avec une gestion de révision devient très
1007 facile, nous pouvons même l'utiliser pour les plus petits projets où
1008 nous aurions probablement jamais penser utiliser un outils aussi
1009 complexe.</para>
1010 </sect1>
1011 </chapter>
1013 <!--
1014 local variables:
1015 sgml-parent-document: ("00book.xml" "book" "chapter")
1016 end:
1017 -->