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