hgbook
view fr/tour-basic.tex @ 940:1dc7475ccab1
Work in progress on tour-basic
| author | Romain PELISSE <belaran@gmail.com> |
|---|---|
| date | Mon Feb 16 18:24:25 2009 +0100 (2009-02-16) |
| parents | 99b93caf2db2 |
| children | afdc168fa06c |
line source
1 \chapter{Un rapide tour de Mercurial}
2 \label{chap:tour-basic}
4 \section{Installer Mercurial sur votre système}
5 \label{sec:tour:install}
7 Des paquetages binaires de Mercurial sont disponible pour tous les plupart
8 des systèmes d'exploitation, ce qui rend facile de commencer de suite
9 à utiliser Mercurial sur votre ordinateur.
11 \subsection{Linux}
13 Parce que chaque distribution de Linux a ses propres outils de gestion
14 de paquets, politique et rythme de développements, il est difficile de
15 donner un ensemble instructions fixes pour installer les binaires de
16 Mercurial. La version de Mercurial avec laquelle vous vous retrouverez
17 dépendera grandement selon l'activité de la personne en charge du paquetage
18 pour la distribution.
20 Pour rester simple, je me concentrerais sur l'installation de Mercurial
21 en ligne de commande, sous les plus courantes des distributions. La
22 plupart des distributions fournissent des gestionnaires graphiques de
23 paquetage qui vous permettront d'installer Mercurial en quelques clicks.
24 Le paquetage devrait se nommer \textit{mercurial}.
26 \begin{itemize}
27 \item[Debian]
28 \begin{codesample4}
29 apt-get install mercurial
30 \end{codesample4}
32 \item[Fedora Core]
33 \begin{codesample4}
34 yum install mercurial
35 \end{codesample4}
37 \item[Gentoo]
38 \begin{codesample4}
39 emerge mercurial
40 \end{codesample4}
42 \item[OpenSUSE]
43 \begin{codesample4}
44 yum install mercurial
45 \end{codesample4}
47 \item[Ubuntu] Le paquetage de Mercurial d'Ubuntu est construit sur celui de Debian. Pour
48 l'installer, exécute simplement les commandes suivantes:
49 \begin{codesample4}
50 apt-get install mercurial
51 \end{codesample4}
52 Les paquetages Ubuntu pour Mercurial ont tendance à être un peu en retard
53 par rapport au paquetage Debian (au moment de l'écriture de ce livre, un
54 peu près 7 mois), ce qui signifie que parfois sur Ubuntu, vous risquez
55 de rencontrer des problèmes qui ont été corrigés depuis longtemps dans
56 les paquetages Debian.
57 \end{itemize}
59 \subsection{Solaris}
61 SunFreeWare, à \url{http://www.saufreeware.com}, est une bonne source
62 pour trouver un vaste nombre de paquet précompiler pour 32 ou 64 bits
63 Intel et les architecture Sparc, dont les versions courantes de Mercurial.
65 \subsection{Mac OS X}
67 Lee Cantey publie un installeur de Mercurial pour Mac OS~X sur le site
68 \url{http://mercurial.berkwood.com}. Ce paquetage fonctionne sur les
69 architecture Intel-~et PowerPCC. Avant de vous en servir, vous devez
70 installer une version Universel MacPython~\cite{web:macpython}. C'est
71 assez facile à faire : suivez simplement les instructions sur le site
72 de Lee.
74 Il est aussi possible d'installer Mercurial en utilisant Fink ou MacPorts,
75 deux outils de gestion de paquetage libre pour Mac OS X. Si vous avez
76 Fink, utiliser \command{sudo fink install mercurial-py25}. Si vous avez
77 acPorts, \command{sudo port install mercurial}.
79 \subsection{Windows}
81 Lee Cantey publie aussi un installeur de Mercurial pour Windows sur le site
82 \url{http://mercurial.berkwood.com}. Ce paquetage n'a aucune dépendance
83 externe, il fonctionne ``tout court''.
85 \begin{note}
86 Le version de Windows de Mercurial ne convertie pas automatiquement
87 les retour chariot Windows et Unix. Si vous désirez partager votre
88 travail avec des utilisateurs Unix, vous devez faire un peu de configuration
89 supllémentaire. XXX En dire plus.
90 \end{note}
92 \section{Commencer à utiliser Mercurial}
94 Pour commencer, nous utiliserons la commande \hgcmd{version} pour vérifier
95 si Mercurial est installé proprement. Les informations affichées sur la
96 version ne sont pas réellement importante en soit, c'est surtout de savoir
97 si elles s'affichent qui nous intéresse.
98 \interaction{tour.version}
100 \subsection{L'aide intégrée}
102 Mercurial fournit un système d'aide intégré, ce qui est inestimable quand
103 vous vous retrouvez coincé à essayer de vous rappeler comment lancer telle
104 ou telle commande.
105 Si c'est le cas, exécuter simplement \hgcmd{help}; il vous aidera à imprimer
106 une brève liste de commandes, avec une description de ce qu'elle fait. Si vous
107 demandez de l'aide sur une commande spécifique (voir ci dessous), il affichera
108 des informations plus détaillés.
109 \interaction{tour.help}
110 Pour un niveau d'informations encore plus détaillé (ce dont vous aurez rarement
111 besoins), exécuter \hgcmdargs{help}{\hggopt{-v}}. L'option \hggopt{-v} est
112 l'abréviation de \hggopt{--verbose}, et indique à Mercurial d'afficher plus
113 d'information que d'habitude.
115 \section{Travailler avec un dépot}
117 Avec Mercurial, tout se déroule au sein du \emph{dépot}\footnote{NdT: Dépôt est
118 la traduction que j'ai retenu pour tout l'ouvrage du terme anglais \textit{repository}}.
119 Le dépôt d'une projet contient tout les fichiers qui ``appartiennent''
120 au projet, avec l'historique des fichiers du projet.
122 Il n'y a rien de particulièrement magique au sujet de ce dépot, c'est
123 simplement une arboresence sur votre système de fichiers que Mercurial
124 traite de manière spéciale. Si vous pouvez renommer ou effacer ce répertoire
125 à n'importe quel moment, en utilisant la ligne de commande ou votre
126 explorateur de fichiers.
128 \subsection{Faire une copie locale de votre dépot}
130 \emph{Copier} un dépôt est just un peu spécial. Bien que vous
131 puissiez utiliser une commande habituelle de copie pour copier
132 votre dépôt, il vaut mieux utiliser une commande fournie par
133 Mercurial. Cette commande est appelée \hgcmd{clone}, car elle
134 crée une copie identique d'un dépôt existant.
135 \interaction{tour.clone}
136 Si votre opération de clonage réussit, vous devriez maintenant
137 avoir un répertoire local appelé \dirname{hello}. Ce répertoire
138 contiendra quelques fichiers.
139 \interaction{tour.ls}
140 Ces fichiers ont le même contenu et historique dans votre dépôt
141 qu'ils ont dans le dépôt que vous avez cloné.
143 Chaque dépôt Mercurial est complet, autonome et indépendant. Il
144 contient sa propre copie privé des fichiers du projet et de leurs
145 historiques. Le clone d'un dépôt se souvient de la localisation du
146 dépôt à partir duquel il a été clôné, mais il ne communique pas avec
147 ce dernier, ou un autre, à moins que vous ne lui demandiez.
149 Ce que tout ceci signifie pour le moment est que nous sommes libre
150 d'expérimenter avec ce dépôt, confiant dans le fait qu'il s'agit d'un
151 ``bac à sable'' qui n'affectera personne d'autres.
153 \subsection{Quel est le contenu d'un dépôt ?}
155 Prêtons plus attention un instant au contenu d'un dépôt. Nous voyons
156 qu'il contient un répertoire nommée \dirname{.hg}. C'est ici que Mercurial
157 conserve toutes ses métadonnées.
158 \interaction{tour.ls-a}
160 Le contenu du répertoire \dirname{.hg} et ses sous répertoires sont les
161 seules propre à Mercurial. Tout les autres fichiers et répertoire dans
162 le répertoire sont à vous, et vous pouvez faire ce que vous en voulez.
164 Pour introduire un peu de terminologie, le répertoire \dirname{.hg} est
165 un ``vrai'' dépôt, et tout les fichiers et les répertoires qui coexistent
166 avec lui, sont désigné sous le nom de \emph{espace de travail}\footnote{NdT:
167 \textit{working directory}}. Une manière facile de se rappeler cette
168 distinction est de retenir que le \emph{dépôt} contient l'\emph{historique}
169 de votre projet, alors que l'\emph{espace de travail} contient une \emph{copie
170 précise}\footnote{NdT: Ce terme est une traduction du terme anglais
171 \textit{snapshot}. Il est traduit ici pour faciliter la lecture, mais ne sera
172 plus traduit par la suite.} de votre projet à un certain point de son
173 historique.
175 \section{Une ballade dans l'historique}
177 Une des premières choses que vous aurez envie de faire avec un nouveau
178 dépôt, sera de comprendre son historique. La commande \hgcmd{log} vous
179 donne une vue de l'historique.
180 \interaction{tour.log}
181 Par défaut, cette commande affiche à l'écran un bref paragraphe pour chaque
182 révision enregistrée pour ce projet. Dans la terminologie de Mercurial, nous
183 appelons chacun de ces évènements enregistrés un \emph{changeset}, parce
184 qu'il contient un ensemble de mofications sur plusieurs fichiers.
186 La commande \hgcmd{log} affiche ainsi ces informations:
187 \begin{itemize}
188 \item[\texttt{changeset}] Ce champ contient un nombre, séparé par une
189 virgule, d'une chaine hexadécimal. Il s'agit en effet d'\emph{identifiants}
190 pour un \textit{changeset}. Il y a deux identifiants car le numéro de
191 la révision est plus court et plus à facile à saisir qu'une séquence
192 hexadécimale.
193 \item[\texttt{utilisateur}] L'identité de la personne qui a crée ce
194 \textit{changeset}. C'est un champ libre de forme, mais la plupart du
195 temps il contient le nom et l'email de la personne.
196 \item[\texttt{date}] La date et l'heure à laquelle le \textit{changeset}
197 a été crée, ainsi que le \textit{timezone} dans laquelle il a été crée. %%%TODO: Translate 'timezone' properly
198 (La date et l'heure sont locals à cette \textit{timezone}, ils indiquent
199 donc quelle date et quelle il était pour la personne qui a crée ce
200 \textit{changeset}.)
201 \item[\texttt{résumé}] La première du message que le créateur a associée à
202 son \textit{changeset} pour le décrire.
203 \end{itemize}
205 Par défaut, la commande \hgcmd{log} n'affiche qu'un résumé, il manque
206 beaucoup de détails.
209 La figure~\ref{fig:tour-basic:history} fournit un représentation graphique
210 de l'historique du dépôt \dirname{hello}, pour rendre plus facile de voir
211 dans quelle direction l'historique se ``déroule''\footnote{NdT: \textit{flowing in}.}.
212 Nous reviendrons régulièrement à cette représentation dans ce chapitre et
213 ceux qui suivent.
215 \begin{figure}[ht]
216 \centering
217 \grafix{tour-history}
218 \caption{Représentation graphique du dépôt \dirname{hello} }
219 \label{fig:tour-basic:history}
220 \end{figure}
222 \subsection{Changesets, révisions, et discuter avec les autres}
224 Comme l'anglais est réputé pour un langage maladroit, et que l'informatique
225 est la source de bien des erreurs terminologique (pourquoi utiliser un
226 seul terme quand quatre feront l'affaire ?), la gestion de version a une
227 variété de mot et de phrases qui veulent dire la même chose. Si vous
228 parlez à quelqu'un de l'historique de Mercurial à d'autres personnes,
229 vous constaterez que souvent le mot ``\textit{changeset}'' est compressé
230 en juste ``change'' ou (à l'écrit) ``cset'', et même parfois un
231 \textit{changeset} simplement ``révision'', abrégé en ``rev''.
233 Bien que le \emph{mot} que vous utilisez pour désigner le concept de
234 \textit{changeset} importe peu, l'\emph{identifiant} que vous utilisez
235 pour désigner un \emph{spécifique} \textit{spécifique} a une grande
236 importance. Rappelez vous que le \textit{changeset} affiché par la
237 commande \hgcmd{log} identifie un \textit{changeset} à la fois avec
238 un numéro de révision et une séquence hexadécimale.
240 \begin{itemize}
241 \item Le numéro de révision est \emph{seulement valable dans ce dépôt},
242 \item alors que la séquence hexadécimale est un \emph{identifiant
243 permanent, et immutable } qui pourra toujours être associé à %%%TODO: Immutable ? Is this french ?
244 \textit{changeset} exacte de \emph{chaque} copie de votre dépôt.
245 \end{itemize}
247 La distinction est importante. Si vous envoyez un email à quelqu'un en
248 parlant de la ``révision 33'', il est très probable que sa révision~33
249 \emph{ne sera pas la même} que la votre. La raison de ceci est que le
250 numéro de révision dépend de l'ordre dans lequel les modifications sont
251 arrivés dans le dépôt, et il n'y a aucune garantie que les mêmes changements
252 soient arrivés dans le même ordre dans différents dépôts. Trois modifications
253 $a,b,c$ peuvent aisément apparaitre dans un dépôt comme $0,1,2$, et dans
254 un autre comme $1,0,2$.
256 Mercurial utilise les numéro de révision uniquement comme des raccourcis
257 pratique. Si vous devez disctuer d'un \textit{changeset} avec quelqu'un,
258 our faire un enregistrement d'un \textit{changeset} pour une quelquonque
259 raison (par exemple, un rapport de \textit{bug}), utilisez la séquence
260 hexadécimale.
262 \subsection{Afficher une révision spécifique}
264 Pour réduire la sortie de \hgcmd{log} à une seule révision, utilisez
265 l'option \hgopt{log}{-r} (ou \hgopt{log}{--rev}). Vous pouvez utiser
266 le numéro de révision ou la séquence hexadécimal comme identifiant, et
267 vous demandez autant de révisions que vous le souhaitez.
268 \interaction{tour.log-r}
270 Si vous voulez voir l'historique de plusieurs révisions sans avoir à
271 les énumérer, vous pouvez utiliser la \emph{\textit{range notation}}
272 \footnote{NdT: Il n'est pas aisé de traduire ce terme, donc je le
273 laisse en anglais} qui vous permet d'exprimer l'idée ``je veux toutes
274 les révisions entre $a$ et $b$, inclus''.
275 \interaction{tour.log.range}
276 Mercurial respecte aussi l'ordre dans lequel vous spécifier les
277 révisions, ainsi \hgcmdargs{log}{-r 2:4} affichera $2,3,4$ alors que
278 \hgcmdargs{log}{-r 4:2} affichera $4,3,2$.
280 \subsection{Informations détaillées}
282 Si le résumé affiché par \hgcmd{log} est utile si vous savez déjà ce
283 que vous cherchez. Vous aurez probablement besoin de voir un description
284 complète du changement, ou une liste des fichiers modifiés. Si vous
285 cherchez à déterminer si ce \textit{changeset} est bien celui que vous
286 recherchez. L'option \hgopt{-v} de la commande \hgcmd{log} (ou
287 \hgopt{--verbose}) vous donne des informations supplémentaires.
288 \interaction{tour.log-v}
290 Si vous voulez voir à la fois la description et le contenu d'une
291 modification, ajouter l'option \hgopt{log}{-p} (ou \hgopt{log}{--patch}).
292 Ceci affiche le contenu d'une modification comme un \emph{diff unifié}
293 \footnote{NdT: \textit{unified diff}} (si vous n'avez jamais vu de diff
294 unifié avant, consulter la section~\ref{sec:mq:patch} pour rapide
295 survol).
296 \interaction{tour.log-vp}
298 \section{Tout sur les options de commandes}
300 Avant d'aller plus loin sur le fonctionnement des commandes de Mercurial,
301 étudions un moment comment elles fonctionnent de manière générale, vous
302 trouverez ça probablement utile pour la suite de notre parcours.
304 Mercurial a une manière approche directe et cohérente pour interpréter
305 les options que vous passez aux commandes. Il suit une convention commune
306 à la plupart des systèmes Unix et Linux modernes.
308 \begin{itemize}
309 \item Every option has a long name. For example, as we've already
310 seen, the \hgcmd{log} command accepts a \hgopt{log}{--rev} option.
311 \item Most options have short names, too. Instead of
312 \hgopt{log}{--rev}, we can use \hgopt{log}{-r}. (The reason that
313 some options don't have short names is that the options in question
314 are rarely used.)
315 \item Long options start with two dashes (e.g.~\hgopt{log}{--rev}),
316 while short options start with one (e.g.~\hgopt{log}{-r}).
317 \item Option naming and usage is consistent across commands. For
318 example, every command that lets you specify a changeset~ID or
319 revision number accepts both \hgopt{log}{-r} and \hgopt{log}{--rev}
320 arguments.
321 \end{itemize}
322 In the examples throughout this book, I use short options instead of
323 long. This just reflects my own preference, so don't read anything
324 significant into it.
326 Most commands that print output of some kind will print more output
327 when passed a \hggopt{-v} (or \hggopt{--verbose}) option, and less
328 when passed \hggopt{-q} (or \hggopt{--quiet}).
330 \section{Making and reviewing changes}
332 Now that we have a grasp of viewing history in Mercurial, let's take a
333 look at making some changes and examining them.
335 The first thing we'll do is isolate our experiment in a repository of
336 its own. We use the \hgcmd{clone} command, but we don't need to
337 clone a copy of the remote repository. Since we already have a copy
338 of it locally, we can just clone that instead. This is much faster
339 than cloning over the network, and cloning a local repository uses
340 less disk space in most cases, too.
341 \interaction{tour.reclone}
342 As an aside, it's often good practice to keep a ``pristine'' copy of a
343 remote repository around, which you can then make temporary clones of
344 to create sandboxes for each task you want to work on. This lets you
345 work on multiple tasks in parallel, each isolated from the others
346 until it's complete and you're ready to integrate it back. Because
347 local clones are so cheap, there's almost no overhead to cloning and
348 destroying repositories whenever you want.
350 In our \dirname{my-hello} repository, we have a file
351 \filename{hello.c} that contains the classic ``hello, world'' program.
352 Let's use the ancient and venerable \command{sed} command to edit this
353 file so that it prints a second line of output. (I'm only using
354 \command{sed} to do this because it's easy to write a scripted example
355 this way. Since you're not under the same constraint, you probably
356 won't want to use \command{sed}; simply use your preferred text editor to
357 do the same thing.)
358 \interaction{tour.sed}
360 Mercurial's \hgcmd{status} command will tell us what Mercurial knows
361 about the files in the repository.
362 \interaction{tour.status}
363 The \hgcmd{status} command prints no output for some files, but a line
364 starting with ``\texttt{M}'' for \filename{hello.c}. Unless you tell
365 it to, \hgcmd{status} will not print any output for files that have
366 not been modified.
368 The ``\texttt{M}'' indicates that Mercurial has noticed that we
369 modified \filename{hello.c}. We didn't need to \emph{inform}
370 Mercurial that we were going to modify the file before we started, or
371 that we had modified the file after we were done; it was able to
372 figure this out itself.
374 It's a little bit helpful to know that we've modified
375 \filename{hello.c}, but we might prefer to know exactly \emph{what}
376 changes we've made to it. To do this, we use the \hgcmd{diff}
377 command.
378 \interaction{tour.diff}
380 \section{Recording changes in a new changeset}
382 We can modify files, build and test our changes, and use
383 \hgcmd{status} and \hgcmd{diff} to review our changes, until we're
384 satisfied with what we've done and arrive at a natural stopping point
385 where we want to record our work in a new changeset.
387 The \hgcmd{commit} command lets us create a new changeset; we'll
388 usually refer to this as ``making a commit'' or ``committing''.
390 \subsection{Setting up a username}
392 When you try to run \hgcmd{commit} for the first time, it is not
393 guaranteed to succeed. Mercurial records your name and address with
394 each change that you commit, so that you and others will later be able
395 to tell who made each change. Mercurial tries to automatically figure
396 out a sensible username to commit the change with. It will attempt
397 each of the following methods, in order:
398 \begin{enumerate}
399 \item If you specify a \hgopt{commit}{-u} option to the \hgcmd{commit}
400 command on the command line, followed by a username, this is always
401 given the highest precedence.
402 \item If you have set the \envar{HGUSER} environment variable, this is
403 checked next.
404 \item If you create a file in your home directory called
405 \sfilename{.hgrc}, with a \rcitem{ui}{username} entry, that will be
406 used next. To see what the contents of this file should look like,
407 refer to section~\ref{sec:tour-basic:username} below.
408 \item If you have set the \envar{EMAIL} environment variable, this
409 will be used next.
410 \item Mercurial will query your system to find out your local user
411 name and host name, and construct a username from these components.
412 Since this often results in a username that is not very useful, it
413 will print a warning if it has to do this.
414 \end{enumerate}
415 If all of these mechanisms fail, Mercurial will fail, printing an
416 error message. In this case, it will not let you commit until you set
417 up a username.
419 You should think of the \envar{HGUSER} environment variable and the
420 \hgopt{commit}{-u} option to the \hgcmd{commit} command as ways to
421 \emph{override} Mercurial's default selection of username. For normal
422 use, the simplest and most robust way to set a username for yourself
423 is by creating a \sfilename{.hgrc} file; see below for details.
425 \subsubsection{Creating a Mercurial configuration file}
426 \label{sec:tour-basic:username}
428 To set a user name, use your favourite editor to create a file called
429 \sfilename{.hgrc} in your home directory. Mercurial will use this
430 file to look up your personalised configuration settings. The initial
431 contents of your \sfilename{.hgrc} should look like this.
432 \begin{codesample2}
433 # This is a Mercurial configuration file.
434 [ui]
435 username = Firstname Lastname <email.address@domain.net>
436 \end{codesample2}
437 The ``\texttt{[ui]}'' line begins a \emph{section} of the config file,
438 so you can read the ``\texttt{username = ...}'' line as meaning ``set
439 the value of the \texttt{username} item in the \texttt{ui} section''.
440 A section continues until a new section begins, or the end of the
441 file. Mercurial ignores empty lines and treats any text from
442 ``\texttt{\#}'' to the end of a line as a comment.
444 \subsubsection{Choosing a user name}
446 You can use any text you like as the value of the \texttt{username}
447 config item, since this information is for reading by other people,
448 but for interpreting by Mercurial. The convention that most people
449 follow is to use their name and email address, as in the example
450 above.
452 \begin{note}
453 Mercurial's built-in web server obfuscates email addresses, to make
454 it more difficult for the email harvesting tools that spammers use.
455 This reduces the likelihood that you'll start receiving more junk
456 email if you publish a Mercurial repository on the web.
457 \end{note}
459 \subsection{Writing a commit message}
461 When we commit a change, Mercurial drops us into a text editor, to
462 enter a message that will describe the modifications we've made in
463 this changeset. This is called the \emph{commit message}. It will be
464 a record for readers of what we did and why, and it will be printed by
465 \hgcmd{log} after we've finished committing.
466 \interaction{tour.commit}
468 The editor that the \hgcmd{commit} command drops us into will contain
469 an empty line, followed by a number of lines starting with
470 ``\texttt{HG:}''.
471 \begin{codesample2}
472 \emph{empty line}
473 HG: changed hello.c
474 \end{codesample2}
475 Mercurial ignores the lines that start with ``\texttt{HG:}''; it uses
476 them only to tell us which files it's recording changes to. Modifying
477 or deleting these lines has no effect.
479 \subsection{Writing a good commit message}
481 Since \hgcmd{log} only prints the first line of a commit message by
482 default, it's best to write a commit message whose first line stands
483 alone. Here's a real example of a commit message that \emph{doesn't}
484 follow this guideline, and hence has a summary that is not readable.
485 \begin{codesample2}
486 changeset: 73:584af0e231be
487 user: Censored Person <censored.person@example.org>
488 date: Tue Sep 26 21:37:07 2006 -0700
489 summary: include buildmeister/commondefs. Add an exports and install
490 \end{codesample2}
492 As far as the remainder of the contents of the commit message are
493 concerned, there are no hard-and-fast rules. Mercurial itself doesn't
494 interpret or care about the contents of the commit message, though
495 your project may have policies that dictate a certain kind of
496 formatting.
498 My personal preference is for short, but informative, commit messages
499 that tell me something that I can't figure out with a quick glance at
500 the output of \hgcmdargs{log}{--patch}.
502 \subsection{Aborting a commit}
504 If you decide that you don't want to commit while in the middle of
505 editing a commit message, simply exit from your editor without saving
506 the file that it's editing. This will cause nothing to happen to
507 either the repository or the working directory.
509 If we run the \hgcmd{commit} command without any arguments, it records
510 all of the changes we've made, as reported by \hgcmd{status} and
511 \hgcmd{diff}.
513 \subsection{Admiring our new handiwork}
515 Once we've finished the commit, we can use the \hgcmd{tip} command to
516 display the changeset we just created. This command produces output
517 that is identical to \hgcmd{log}, but it only displays the newest
518 revision in the repository.
519 \interaction{tour.tip}
520 We refer to the newest revision in the repository as the tip revision,
521 or simply the tip.
523 \section{Sharing changes}
525 We mentioned earlier that repositories in Mercurial are
526 self-contained. This means that the changeset we just created exists
527 only in our \dirname{my-hello} repository. Let's look at a few ways
528 that we can propagate this change into other repositories.
530 \subsection{Pulling changes from another repository}
531 \label{sec:tour:pull}
533 To get started, let's clone our original \dirname{hello} repository,
534 which does not contain the change we just committed. We'll call our
535 temporary repository \dirname{hello-pull}.
536 \interaction{tour.clone-pull}
538 We'll use the \hgcmd{pull} command to bring changes from
539 \dirname{my-hello} into \dirname{hello-pull}. However, blindly
540 pulling unknown changes into a repository is a somewhat scary
541 prospect. Mercurial provides the \hgcmd{incoming} command to tell us
542 what changes the \hgcmd{pull} command \emph{would} pull into the
543 repository, without actually pulling the changes in.
544 \interaction{tour.incoming}
545 (Of course, someone could cause more changesets to appear in the
546 repository that we ran \hgcmd{incoming} in, before we get a chance to
547 \hgcmd{pull} the changes, so that we could end up pulling changes that we
548 didn't expect.)
550 Bringing changes into a repository is a simple matter of running the
551 \hgcmd{pull} command, and telling it which repository to pull from.
552 \interaction{tour.pull}
553 As you can see from the before-and-after output of \hgcmd{tip}, we
554 have successfully pulled changes into our repository. There remains
555 one step before we can see these changes in the working directory.
557 \subsection{Updating the working directory}
559 We have so far glossed over the relationship between a repository and
560 its working directory. The \hgcmd{pull} command that we ran in
561 section~\ref{sec:tour:pull} brought changes into the repository, but
562 if we check, there's no sign of those changes in the working
563 directory. This is because \hgcmd{pull} does not (by default) touch
564 the working directory. Instead, we use the \hgcmd{update} command to
565 do this.
566 \interaction{tour.update}
568 It might seem a bit strange that \hgcmd{pull} doesn't update the
569 working directory automatically. There's actually a good reason for
570 this: you can use \hgcmd{update} to update the working directory to
571 the state it was in at \emph{any revision} in the history of the
572 repository. If you had the working directory updated to an old
573 revision---to hunt down the origin of a bug, say---and ran a
574 \hgcmd{pull} which automatically updated the working directory to a
575 new revision, you might not be terribly happy.
577 However, since pull-then-update is such a common thing to do,
578 Mercurial lets you combine the two by passing the \hgopt{pull}{-u}
579 option to \hgcmd{pull}.
580 \begin{codesample2}
581 hg pull -u
582 \end{codesample2}
583 If you look back at the output of \hgcmd{pull} in
584 section~\ref{sec:tour:pull} when we ran it without \hgopt{pull}{-u},
585 you can see that it printed a helpful reminder that we'd have to take
586 an explicit step to update the working directory:
587 \begin{codesample2}
588 (run 'hg update' to get a working copy)
589 \end{codesample2}
591 To find out what revision the working directory is at, use the
592 \hgcmd{parents} command.
593 \interaction{tour.parents}
594 If you look back at figure~\ref{fig:tour-basic:history}, you'll see
595 arrows connecting each changeset. The node that the arrow leads
596 \emph{from} in each case is a parent, and the node that the arrow
597 leads \emph{to} is its child. The working directory has a parent in
598 just the same way; this is the changeset that the working directory
599 currently contains.
601 To update the working directory to a particular revision, give a
602 revision number or changeset~ID to the \hgcmd{update} command.
603 \interaction{tour.older}
604 If you omit an explicit revision, \hgcmd{update} will update to the
605 tip revision, as shown by the second call to \hgcmd{update} in the
606 example above.
608 \subsection{Pushing changes to another repository}
610 Mercurial lets us push changes to another repository, from the
611 repository we're currently visiting. As with the example of
612 \hgcmd{pull} above, we'll create a temporary repository to push our
613 changes into.
614 \interaction{tour.clone-push}
615 The \hgcmd{outgoing} command tells us what changes would be pushed
616 into another repository.
617 \interaction{tour.outgoing}
618 And the \hgcmd{push} command does the actual push.
619 \interaction{tour.push}
620 As with \hgcmd{pull}, the \hgcmd{push} command does not update the
621 working directory in the repository that it's pushing changes into.
622 (Unlike \hgcmd{pull}, \hgcmd{push} does not provide a \texttt{-u}
623 option that updates the other repository's working directory.)
625 What happens if we try to pull or push changes and the receiving
626 repository already has those changes? Nothing too exciting.
627 \interaction{tour.push.nothing}
629 \subsection{Sharing changes over a network}
631 The commands we have covered in the previous few sections are not
632 limited to working with local repositories. Each works in exactly the
633 same fashion over a network connection; simply pass in a URL instead
634 of a local path.
635 \interaction{tour.outgoing.net}
636 In this example, we can see what changes we could push to the remote
637 repository, but the repository is understandably not set up to let
638 anonymous users push to it.
639 \interaction{tour.push.net}
641 %%% Local Variables:
642 %%% mode: latex
643 %%% TeX-master: "00book"
644 %%% End: