hgbook

annotate fr/tour-basic.tex @ 960:e3913a4b5b26

Fixing leftovers stuff from last merge with Wilkk
author Romain PELISSE <belaran@gmail.com>
date Tue Feb 24 00:03:10 2009 +0100 (2009-02-24)
parents f42151a42f9e
children
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
huguesfrachon@942 7 Des paquetages binaires de Mercurial sont disponibles pour la plupart
huguesfrachon@942 8 des systèmes d'exploitation, ce qui rend facile l'utilisation immédiate
huguesfrachon@942 9 de 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
huguesfrachon@942 14 de paquets, politiques et rythmes de développements, il est difficile de
Wilk@956 15 donner un ensemble d'instructions uniques pour installer les binaires de
romain@931 16 Mercurial. La version de Mercurial avec laquelle vous vous retrouverez
huguesfrachon@942 17 dépendra grandement de l'activité de la personne en charge du paquetage
romain@931 18 pour la distribution.
romain@931 19
huguesfrachon@942 20 Pour rester simple, je me concentrerai sur l'installation de Mercurial
Wilk@956 21 en ligne de commande, sous les distributions les plus courantes. 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
belaran@943 47 \item[Ubuntu] Le paquetage de Mercurial d'Ubuntu est construit sur celui de Debian.
Wilk@956 48 Pour l'installer, exécutez 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
belaran@943 53 par rapport au paquetage Debian (au moment de l'écriture de ce livre, il
Wilk@956 54 faut compter à peu près un retard de 7 mois), ce qui signifie que parfois
belaran@943 55 sur Ubuntu, vous risquez de rencontrer des problèmes qui ont été corrigés
belaran@943 56 depuis longtemps dans 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
huguesfrachon@942 62 pour trouver un vaste nombre de paquets précompilés 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
Wilk@956 67 Lee Cantey publie un installateur de Mercurial pour Mac OS~X sur le site
romain@931 68 \url{http://mercurial.berkwood.com}. Ce paquetage fonctionne sur les
Wilk@956 69 architectures Intel-~et PowerPC. Avant de vous en servir, vous devez
Wilk@956 70 installer une version Universelle 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,
huguesfrachon@942 75 deux outils de gestion de paquetage libres pour Mac OS X. Si vous avez
Wilk@956 76 Fink, utilisez \command{sudo fink install mercurial-py25}. Si vous avez
Wilk@956 77 MacPorts, \command{sudo port install mercurial}.
simon@313 78
bos@84 79 \subsection{Windows}
bos@84 80
Wilk@956 81 Lee Cantey publie aussi un installateur 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}
Wilk@956 86 La version de Windows de Mercurial ne convertie pas automatiquement
Wilk@956 87 les retours 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
Wilk@956 89 supplé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
Wilk@956 96 version ne sont pas réellement importantes 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.
Wilk@956 105 Si c'est le cas, exécutez simplement \hgcmd{help}; il vous aidera à imprimer
huguesfrachon@942 106 une brève liste de commandes, avec une description de ce qu'elles font. Si vous
Wilk@956 107 demandez de l'aide sur une commande spécifique (voir ci-dessous), il affichera
huguesfrachon@942 108 des informations plus détaillées.
bos@87 109 \interaction{tour.help}
huguesfrachon@942 110 Pour un niveau d'informations encore plus détaillées (ce dont vous aurez rarement
huguesfrachon@942 111 besoin), 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
huguesfrachon@942 113 d'informations que d'habitude.
romain@931 114
Wilk@956 115 \section{Travailler avec un dépôt}
Wilk@956 116
Wilk@956 117 Avec Mercurial, tout se déroule au sein du \emph{dépôt}\footnote{NdT: Dépôt est
huguesfrachon@942 118 la traduction que j'ai retenue pour tout l'ouvrage du terme anglais \textit{repository}}.
huguesfrachon@942 119 Le dépôt d'un projet contient tous les fichiers qui ``appartiennent'' au projet.
belaran@938 120
Wilk@956 121 Il n'y a rien de particulièrement magique au sujet de ce dépôt, c'est
Wilk@956 122 simplement une arborescence sur votre système de fichiers que Mercurial
huguesfrachon@950 123 traite de manière spéciale. Vous pouvez renommer ou effacer ce répertoire
Wilk@956 124 à n'importe quel moment, en utilisant la ligne de commande ou votre
belaran@938 125 explorateur de fichiers.
belaran@938 126
Wilk@956 127 \subsection{Faire une copie locale de votre dépôt}
belaran@938 128
huguesfrachon@950 129 \emph{Copier} un dépôt est juste un peu spécial. Bien que vous
belaran@938 130 puissiez utiliser une commande habituelle de copie pour copier
belaran@938 131 votre dépôt, il vaut mieux utiliser une commande fournie par
belaran@938 132 Mercurial. Cette commande est appelée \hgcmd{clone}, car elle
Wilk@956 133 crée une copie identique à un dépôt existant.
bos@87 134 \interaction{tour.clone}
belaran@938 135 Si votre opération de clonage réussit, vous devriez maintenant
belaran@938 136 avoir un répertoire local appelé \dirname{hello}. Ce répertoire
belaran@938 137 contiendra quelques fichiers.
bos@87 138 \interaction{tour.ls}
belaran@938 139 Ces fichiers ont le même contenu et historique dans votre dépôt
belaran@938 140 qu'ils ont dans le dépôt que vous avez cloné.
belaran@938 141
belaran@938 142 Chaque dépôt Mercurial est complet, autonome et indépendant. Il
Wilk@956 143 contient sa propre copie privée des fichiers du projet et de leur
Wilk@956 144 historique. Le clone d'un dépôt se souvient de la localisation du
belaran@938 145 dépôt à partir duquel il a été clôné, mais il ne communique pas avec
belaran@938 146 ce dernier, ou un autre, à moins que vous ne lui demandiez.
belaran@938 147
huguesfrachon@950 148 Ce que tout ceci signifie pour le moment est que nous sommes libres
huguesfrachon@950 149 d'expérimenter avec ce dépôt, confiants dans le fait qu'il s'agit d'un
huguesfrachon@950 150 ``bac à sable'' qui n'affectera personne d'autre.
belaran@938 151
belaran@938 152 \subsection{Quel est le contenu d'un dépôt ?}
belaran@938 153
belaran@938 154 Prêtons plus attention un instant au contenu d'un dépôt. Nous voyons
huguesfrachon@950 155 qu'il contient un répertoire nommé \dirname{.hg}. C'est ici que Mercurial
belaran@938 156 conserve toutes ses métadonnées.
bos@88 157 \interaction{tour.ls-a}
bos@88 158
belaran@938 159 Le contenu du répertoire \dirname{.hg} et ses sous répertoires sont les
huguesfrachon@950 160 seuls propres à Mercurial. Tous les autres fichiers et répertoires dans
Wilk@956 161 le dépôt sont à vous, et vous pouvez en faire ce que vous voulez.
belaran@938 162
belaran@938 163 Pour introduire un peu de terminologie, le répertoire \dirname{.hg} est
huguesfrachon@950 164 un ``vrai'' dépôt, et tous les fichiers et les répertoires qui coexistent
Wilk@956 165 avec lui, sont désignés sous le nom \emph{espace de travail}\footnote{NdT:
belaran@938 166 \textit{working directory}}. Une manière facile de se rappeler cette
belaran@938 167 distinction est de retenir que le \emph{dépôt} contient l'\emph{historique}
belaran@938 168 de votre projet, alors que l'\emph{espace de travail} contient une \emph{copie
Wilk@956 169 ponctuelle}\footnote{NdT: Ce terme est une traduction du terme anglais
belaran@938 170 \textit{snapshot}. Il est traduit ici pour faciliter la lecture, mais ne sera
belaran@938 171 plus traduit par la suite.} de votre projet à un certain point de son
belaran@938 172 historique.
belaran@938 173
belaran@938 174 \section{Une ballade dans l'historique}
belaran@938 175
belaran@938 176 Une des premières choses que vous aurez envie de faire avec un nouveau
belaran@938 177 dépôt, sera de comprendre son historique. La commande \hgcmd{log} vous
belaran@938 178 donne une vue de l'historique.
bos@88 179 \interaction{tour.log}
belaran@938 180 Par défaut, cette commande affiche à l'écran un bref paragraphe pour chaque
belaran@938 181 révision enregistrée pour ce projet. Dans la terminologie de Mercurial, nous
belaran@938 182 appelons chacun de ces évènements enregistrés un \emph{changeset}, parce
Wilk@956 183 qu'il contient un ensemble de modifications sur plusieurs fichiers.
belaran@938 184
belaran@938 185 La commande \hgcmd{log} affiche ainsi ces informations:
bos@88 186 \begin{itemize}
Wilk@956 187 \item[\texttt{changeset}] Ce champ contient un nombre, séparé par deux points
Wilk@956 188 (:), d'une chaine hexadécimale. Il s'agit en fait d'\emph{identifiants}
Wilk@956 189 d'un \textit{changeset}. Il y a deux identifiants car le numéro de
belaran@938 190 la révision est plus court et plus à facile à saisir qu'une séquence
belaran@938 191 hexadécimale.
Wilk@956 192 \item[\texttt{user}] L'identité de la personne qui a créée ce %%% laisser le terme anglais car il sera affiché
belaran@938 193 \textit{changeset}. C'est un champ libre de forme, mais la plupart du
belaran@938 194 temps il contient le nom et l'email de la personne.
belaran@938 195 \item[\texttt{date}] La date et l'heure à laquelle le \textit{changeset}
Wilk@956 196 a été créé, ainsi que le \textit{fuseau horaire} dans laquelle il a été créé. %%%TODO: Translate 'timezone' properly : FUSEAU
Wilk@956 197 (La date et l'heure sont locales à ce \textit{fuseau}, elles indiquent
Wilk@956 198 donc quelle date et heure il était pour la personne qui a créé ce %%%TODO: je suppose (quelle "heure") OUI
belaran@938 199 \textit{changeset}.)
Wilk@956 200 \item[\texttt{résumé}] La première du message que le créateur a associé à
belaran@938 201 son \textit{changeset} pour le décrire.
bos@88 202 \end{itemize}
belaran@938 203
belaran@938 204 Par défaut, la commande \hgcmd{log} n'affiche qu'un résumé, il manque
belaran@938 205 beaucoup de détails.
belaran@938 206
Wilk@956 207 La figure~\ref{fig:tour-basic:history} fournit une représentation graphique
belaran@938 208 de l'historique du dépôt \dirname{hello}, pour rendre plus facile de voir
belaran@938 209 dans quelle direction l'historique se ``déroule''\footnote{NdT: \textit{flowing in}.}.
Wilk@956 210 Nous reviendrons régulièrement sur cette représentation dans ce chapitre et
belaran@938 211 ceux qui suivent.
bos@97 212
bos@96 213 \begin{figure}[ht]
bos@96 214 \centering
bos@96 215 \grafix{tour-history}
belaran@938 216 \caption{Représentation graphique du dépôt \dirname{hello} }
bos@99 217 \label{fig:tour-basic:history}
bos@96 218 \end{figure}
bos@96 219
huguesfrachon@950 220 \subsection{Changesets, révisions, et discuter avec les autres}%%%TODO: je propose : "discussion" (3 noms communs)
Wilk@956 221 %%% je propose "colaboration"
huguesfrachon@950 222
huguesfrachon@950 223 Comme l'anglais est réputé pour être un langage maladroit, et que l'informatique
Wilk@956 224 est la source de bien des erreurs de terminologies (pourquoi utiliser un
belaran@939 225 seul terme quand quatre feront l'affaire ?), la gestion de version a une
huguesfrachon@950 226 variété de mots et de phrases qui veulent dire la même chose. Si vous
Wilk@956 227 discutez d'historique de Mercurial avec d'autres personnes,
huguesfrachon@950 228 %%%TODO: ça ne veut rien dire: il faut supprimer une des personnes : soit "quelqu'un",
huguesfrachon@950 229 % soit "à d'autres personnes"
Wilk@956 230 vous constaterez que souvent le mot ``\textit{changeset}'' est contracté simplement
huguesfrachon@950 231 en ``change'' ou (à l'écrit) ``cset'', et même parfois un
belaran@939 232 \textit{changeset} simplement ``révision'', abrégé en ``rev''.
belaran@939 233
belaran@939 234 Bien que le \emph{mot} que vous utilisez pour désigner le concept de
belaran@939 235 \textit{changeset} importe peu, l'\emph{identifiant} que vous utilisez
Wilk@956 236 pour désigner un \emph{changeset} \textit{spécifique} a une grande
Wilk@956 237 importance. Rappelez vous que le champ \textit{changeset} affiché par la
belaran@939 238 commande \hgcmd{log} identifie un \textit{changeset} à la fois avec
belaran@939 239 un numéro de révision et une séquence hexadécimale.
belaran@939 240
bos@97 241 \begin{itemize}
belaran@939 242 \item Le numéro de révision est \emph{seulement valable dans ce dépôt},
belaran@939 243 \item alors que la séquence hexadécimale est un \emph{identifiant
huguesfrachon@950 244 permanent, et invariant } qui pourra toujours être associé au
huguesfrachon@950 245 \textit{changeset} exact de \emph{chaque} copie de votre dépôt.
bos@97 246 \end{itemize}
belaran@939 247
belaran@939 248 La distinction est importante. Si vous envoyez un email à quelqu'un en
belaran@939 249 parlant de la ``révision 33'', il est très probable que sa révision~33
belaran@939 250 \emph{ne sera pas la même} que la votre. La raison de ceci est que le
belaran@939 251 numéro de révision dépend de l'ordre dans lequel les modifications sont
huguesfrachon@950 252 arrivées dans le dépôt, et il n'y a aucune garantie que les mêmes changements
belaran@939 253 soient arrivés dans le même ordre dans différents dépôts. Trois modifications
belaran@939 254 $a,b,c$ peuvent aisément apparaitre dans un dépôt comme $0,1,2$, et dans
belaran@939 255 un autre comme $1,0,2$.
belaran@939 256
Wilk@956 257 Mercurial utilise les numéros de révision uniquement comme des raccourcis
Wilk@956 258 pratiques. Si vous devez discuter d'un \textit{changeset} avec quelqu'un,
Wilk@956 259 ou identifer un \textit{changeset} pour une quelquonque %%%TODO: our : "pour" ou "ou"
belaran@939 260 raison (par exemple, un rapport de \textit{bug}), utilisez la séquence
belaran@939 261 hexadécimale.
belaran@939 262
belaran@939 263 \subsection{Afficher une révision spécifique}
belaran@939 264
belaran@939 265 Pour réduire la sortie de \hgcmd{log} à une seule révision, utilisez
huguesfrachon@950 266 l'option \hgopt{log}{-r} (ou \hgopt{log}{--rev}). Vous pouvez utiliser
huguesfrachon@950 267 le numéro de révision ou la séquence hexadécimale comme identifiant, et
Wilk@956 268 demander autant de révisions que vous le souhaitez.
belaran@939 269 \interaction{tour.log-r}
belaran@939 270
belaran@939 271 Si vous voulez voir l'historique de plusieurs révisions sans avoir à
belaran@939 272 les énumérer, vous pouvez utiliser la \emph{\textit{range notation}}
Wilk@956 273 \footnote{NdT: Il n'est pas aisé de traduire ce terme, donc je le %%%TODO : intervalle de numérotation ?
belaran@939 274 laisse en anglais} qui vous permet d'exprimer l'idée ``je veux toutes
belaran@939 275 les révisions entre $a$ et $b$, inclus''.
bos@88 276 \interaction{tour.log.range}
huguesfrachon@950 277 Mercurial respecte aussi l'ordre dans lequel vous spécifiez les
belaran@939 278 révisions, ainsi \hgcmdargs{log}{-r 2:4} affichera $2,3,4$ alors que
belaran@939 279 \hgcmdargs{log}{-r 4:2} affichera $4,3,2$.
belaran@939 280
belaran@939 281 \subsection{Informations détaillées}
bos@91 282
belaran@948 283
Wilk@956 284 Le résumé affiché par \hgcmd{log} est suffisant si vous savez déjà ce %%%TODO: je pense que le premier "si" est de trop : exact
Wilk@956 285 que vous cherchez. En revanche, vous aurez probablement besoin de voir une description
Wilk@956 286 complète du changement, ou une liste des fichiers modifiés si vous
Wilk@956 287 cherchez à déterminer qu'un \textit{changeset} est bien celui que vous%%%TODO: les propositions sont mal construites : après un "si...." il faut une proposition sans "si... donc ici : "si ... recherchez", ben quoi ?
belaran@940 288 recherchez. L'option \hgopt{-v} de la commande \hgcmd{log} (ou
Wilk@956 289 \hgopt{--verbose}) vous donne ces informations supplémentaires.
bos@91 290 \interaction{tour.log-v}
bos@91 291
belaran@949 292 Si vous voulez voir à la fois la description et le contenu d'une
belaran@949 293 modification, ajouter l'option \hgopt{log}{-p} (ou \hgopt{log}{--patch}).
belaran@949 294 Ceci affiche le contenu d'une modification comme un \emph{diff unifié}
belaran@949 295 \footnote{NdT: \textit{unified diff}} (si vous n'avez jamais vu de diff
huguesfrachon@950 296 unifié avant, consultez la section~\ref{sec:mq:patch} pour un rapide
belaran@949 297 survol).
belaran@948 298
bos@91 299 \interaction{tour.log-vp}
bos@91 300
belaran@940 301 \section{Tout sur les options de commandes}
belaran@940 302
belaran@946 303
belaran@940 304 Avant d'aller plus loin sur le fonctionnement des commandes de Mercurial,
huguesfrachon@950 305 étudions un moment comment elles fonctionnent de manière générale. Vous
belaran@940 306 trouverez ça probablement utile pour la suite de notre parcours.
belaran@940 307
Wilk@956 308 Mercurial utilise une approche directe et cohérente pour interpréter %%%TODO: une manière d'approche ?
belaran@940 309 les options que vous passez aux commandes. Il suit une convention commune
belaran@940 310 à la plupart des systèmes Unix et Linux modernes.
belaran@940 311
bos@91 312 \begin{itemize}
belaran@947 313 \item Chaque option a un nom complet. Par exemple, comme nous l'avons déjà
Wilk@956 314 vu, la commande \hgcmd{log} accepte l'option \hgopt{log}{--rev}.%%%TODO: commande ou command e\hgcmd...?
huguesfrachon@950 315 \item La plupart des options disposent de noms abrégés. Aussi, au lieu d'utiliser
belaran@947 316 \hgopt{log}{--rev}, vous pouvez utiliser \hgopt{log}{-r}. (Les options qui
Wilk@956 317 n'ont pas de noms abrégés sont généralement rarement utilisées, pour cette raison).
huguesfrachon@950 318 \item Les noms complets commencent par deux tirets (i.e.~\hgopt{log}{--rev}),
belaran@947 319 alors que les options courtes commencent avec un seul (i.e.~\hgopt{log}{-r}).
huguesfrachon@950 320 \item Les noms des options sont cohérents entre les commandes. Par exemple,
Wilk@956 321 chaque commande qui accepte un \textit{changeset~ID} ou un numéro de révision
belaran@947 322 accepte aussi \hgopt{log}{-r} et \hgopt{log}{--rev} comme arguments.
belaran@947 323 %TODO: Small mistake here, shouldn't have log here... shouldn't it ?
bos@91 324 \end{itemize}
belaran@947 325
huguesfrachon@950 326 Dans les exemples de ce livre, j'utilise les noms abrégés plutôt que les noms
huguesfrachon@950 327 complets. Ceci est une préférence personnelle, pas une recommandation.
huguesfrachon@950 328
Wilk@956 329 La plupart des commandes qui affichent une quelconque sortie à l'écran,
Wilk@956 330 afficheront davantage avec l'option \hggopt{-v} (ou \hggopt{--verbose}), et
huguesfrachon@950 331 moins avec l'option \hggopt{-q} (ou \hggopt{--quiet}).
belaran@947 332
belaran@947 333 \section{Faire et vérifier des modifications}
belaran@947 334
huguesfrachon@950 335 Maintenant que nous avons une bonne idée des commandes pour consulter
huguesfrachon@950 336 l'historique de Mercurial, regardons comment faire des modifications et
huguesfrachon@950 337 les examiner.
huguesfrachon@950 338
belaran@947 339
belaran@947 340 La première chose que nous allons faire c'est isoler notre expérience dans
belaran@947 341 un dépôt à part. Nous allons utiliser la commande \hgcmd{clone}, mais nous
belaran@947 342 n'avons pas besoin de faire une copie de dépôt distant. Comme nous avons
Wilk@956 343 déjà une copie locale, nous pouvons juste faire un clone de celle-ci à la
belaran@947 344 place. C'est beaucoup plus rapide que de faire une copie à travers le
Wilk@956 345 réseau, et un dépôt cloné localement prend également moins d'espace disque.
belaran@947 346
bos@91 347 \interaction{tour.reclone}
belaran@947 348
belaran@947 349 On notera au passage qu'il est souvent considéré comme une bonne pratique
belaran@947 350 de conserver une copie ``immaculée'' du dépôt distant, à partir de laquelle
belaran@947 351 vous pourrez faire des copies locales temporaires pour créer des ``bacs à
belaran@947 352 sable'' pour chaque tâche sur laquelle vous souhaitez travailler. Ceci vous
huguesfrachon@950 353 permet de travailler sur plusieurs choses en parallèle, chacune isolée les
huguesfrachon@950 354 unes des autres en attendant que ces tâches soient finies et que vous soyez
huguesfrachon@950 355 prêt à les réintégrer. Parce que les copies locales sont peu coûteuses, il
belaran@947 356 est très rapide de créer ou détruire des dépôts dès que vous en avez besoin.
belaran@947 357
belaran@947 358 %% Note: la dernière phrase n'est pas une traduction littérale, mais je
belaran@947 359 %% pense qu'elle exprime plus clairement en français ce que veut dire son
Wilk@956 360 %% équivalent anglais. : OUI
belaran@947 361
belaran@947 362 Dans notre dépôt \dirname{my-hello}, nous avons un fichier \filename{hello.c}
belaran@947 363 qui contient le classique programme ``hello, world''. Nous allons utiliser
Wilk@956 364 l'ancienne et vénérable commande \command{sed} pour l'éditer afin qu'il
belaran@947 365 affiche une seconde ligne à l'écran. (J'utilise \command{sed} seulement parce
Wilk@956 366 qu'il est ainsi facile d'écrire des exemples sous forme de script. Comme
belaran@947 367 vous n'avez pas ces contraintes, vous n'utiliserez probablement pas \command{sed}
belaran@947 368 mais plutôt votre éditeur de texte favori).
belaran@947 369
bos@91 370 \interaction{tour.sed}
bos@91 371
belaran@947 372 La commande \hgcmd{status} de Mercurial nous dira de quels fichiers Mercurial
belaran@947 373 s'occupe au sein de ce dépôt.
bos@91 374 \interaction{tour.status}
belaran@947 375 La commande \hgcmd{status} n'affiche rien sur la sortie pour quelques fichiers
belaran@947 376 mais une ligne commence par ``\texttt{M}'' for \filename{hello.c}. À moins que
belaran@947 377 vous ne lui indiquiez de le faire, \hgcmd{status} n'affichera aucune sortie
belaran@947 378 pour les fichiers qui n'ont pas été modifiés.
belaran@947 379
belaran@947 380 Le caractère ``\texttt{M}'' indique que Mercurial a remarqué que nous avions
belaran@947 381 modifié le fichier \filename{hello.c}. Nous n'avons pas besoin d'\emph{informer}
belaran@947 382 Mercurial que nous allons modifier un fichier avant de le faire, ou que nous
belaran@947 383 venons de le modifier, il est capable de s'en rendre compte tout seul.
belaran@947 384
belaran@947 385 C'est pratique de savoir que nous avons modifié \filename{hello.c}, mais il
belaran@947 386 serait encore plus pratique de savoir ce que nous avons modifié exactement. Pour
belaran@947 387 cela, nous avons la commande \hgcmd{diff}.
belaran@947 388
bos@91 389 \interaction{tour.diff}
bos@91 390
belaran@947 391 \section{Enregister les modifications dans un nouveau \textit{changeset}}
belaran@947 392
belaran@947 393 Nous pouvons modifier des fichiers, compiler et tester nos modifications,
Wilk@956 394 et utiliser les commandes \hgcmd{status} et \hgcmd{diff} pour voir les
huguesfrachon@950 395 modifications effectuées, jusqu'au moment où nous serons assez satisfaits
huguesfrachon@950 396 pour décider d'enregistrer notre travail dans un \textit{changeset}.
belaran@947 397
belaran@947 398 La commande \hgcmd{commit} vous laisse créer un nouveau \textit{changeset},
belaran@947 399 nous désignerons généralement cette opération par ``faire un commit'' ou
huguesfrachon@950 400 ``commiter''\footnote{NdT: De mon expérience, la plupart des francophones
belaran@947 401 utilisent régulièrement, à l'oral, cette expression, mais bien évidement
Wilk@956 402 il ne s'agit pas d'un terme de terminologie correcte, ni même français.}
belaran@947 403
belaran@947 404 \subsection{Définir le nom d'utilisateur}
belaran@947 405
huguesfrachon@950 406 Quand vous exécutez la commande \hgcmd{commit} pour la première fois, elle
huguesfrachon@950 407 n'est pas garantie de réussir. Mercurial enregistre votre nom et votre
belaran@947 408 adresse avec chaque modification que vous effectuez, de manière à ce que
belaran@947 409 vous soyez capable (ou d'autres le soient) de savoir qui a fait quelle
belaran@947 410 modification. Mercurial essaye automatiquement de découvrir un nom
huguesfrachon@950 411 d'utilisateur qui ait un minimum de sens pour effectuer l'opération
belaran@947 412 de \textit{commit} avec. Il va essayer chacune des méthodes suivantes,
belaran@947 413 dans l'ordre:
bos@174 414 \begin{enumerate}
belaran@947 415 \item Si vous spécifiez l'option \hgopt{commit}{-u} avec la commande
belaran@947 416 \hgcmd{commit}, suivi d'un nom d'utilisateur, ceci aura toujours la
belaran@947 417 priorité sur les autres méthodes ci dessous.
Wilk@956 418 \item Si vous avez défini une variable d'environnement \envar{HGUSER},
belaran@947 419 c'est cette valeur qui est alors utilisée.
huguesfrachon@950 420 \item Si vous créez un fichier nommé \sfilename{.hgrc} dans votre
belaran@947 421 répertoire \textit{home}, avec une entrée \rcitem{ui}{username},
belaran@947 422 c'est la valeur associée qui sera utilisée. Pour voir à quoi
belaran@947 423 ressemble le contenu de ce fichier regardez la
Wilk@956 424 section~\ref{sec:tour-basic:username} ci-dessous.
Wilk@956 425 \item Si vous avez défini une variable d'environnement \envar{EMAIL}
belaran@947 426 celle ci sera utilisée ensuite.
belaran@947 427 \item Enfin, Mercurial interrogera votre système pour trouver votre
belaran@947 428 nom d'utilisateur local ainsi que le nom de la machine hôte, et il
belaran@951 429 fabriquera un nom d'utilisateur à partir de ces données. Comme il arrive
belaran@947 430 souvent que ce genre de noms soit totalement inutile, il vous
belaran@947 431 préviendra en affichant un message d'avertissement.
bos@174 432 \end{enumerate}
belaran@947 433
huguesfrachon@950 434 Si tous ces mécanismes échouent, Mercurial n'exécutera pas la commande,
belaran@947 435 affichant un message d'erreur. Dans ce cas, il ne vous laissera pas
belaran@947 436 effectuer de \textit{commit} tant que vous n'aurez pas défini un nom
belaran@947 437 d'utilisateur.
belaran@947 438
belaran@947 439 Vous devriez penser à utiliser la variable d'environement \envar{HGUSER}
belaran@947 440 et l'option \hgopt{commit}{-u} comme moyen pour \emph{changer le nom
Wilk@956 441 d'utilisateur} par défaut. Pour une utilisation normale, la manière la plus
Wilk@956 442 simple et robuste d'opérer est de créer un fichier \sfilename{.hgrc},
Wilk@956 443 voir ci-dessous pour les détails à ce sujet.
bos@102 444
huguesfrachon@950 445 \subsubsection{Créer un fichier de configuration pour Mercurial}
bos@174 446 \label{sec:tour-basic:username}
bos@102 447
Wilk@956 448 Pour définir un nom d'utilisateur, utilisez votre éditeur de texte favori
huguesfrachon@950 449 pour créer un fichier \sfilename{.hgrc} dans votre répertoire \textit{home}.
huguesfrachon@950 450 Mercurial va utiliser ce fichier pour retrouver votre configuration personnelle.
huguesfrachon@950 451 Le contenu initial devrait ressembler à ceci:
bos@102 452 \begin{codesample2}
bos@102 453 # This is a Mercurial configuration file.
bos@102 454 [ui]
bos@102 455 username = Firstname Lastname <email.address@domain.net>
bos@102 456 \end{codesample2}
huguesfrachon@950 457 La ligne avec \texttt{[ui]} commence une \emph{section} du fichier de
huguesfrachon@950 458 configuration, ainsi la ligne ``\texttt{username = ...}'' signifie ``
huguesfrachon@950 459 définir la valeur de l'élément \texttt{username} dans la section
huguesfrachon@950 460 \texttt{ui}''. Une section continue jusqu'à ce qu'une nouvelle
huguesfrachon@950 461 commence, ou que la fin du fichier soit atteinte. Mercurial ignore
huguesfrachon@955 462 les lignes vides et traite tout texte situé à la suite d'un
belaran@951 463 ``\texttt{\#}'' jusqu'à la fin de la ligne comme un commentaire.
belaran@951 464
belaran@951 465 \subsubsection{Choisir un nom d'utilisateur}
belaran@951 466
belaran@951 467 Vous pouvez utiliser n'importe quelle valeur pour votre \texttt{username},
belaran@951 468 car cette information est destinée à d'autres personnes et non à être
belaran@951 469 interprétée par Mercurial. La convention que la plupart des personnes
belaran@958 470 <<<<<<< local
belaran@951 471 suivent est d'utiliser leurs noms suivies de leurs adresses emails,
Wilk@956 472 comme montrée ci-dessus:
bos@102 473
bos@102 474 \begin{note}
belaran@951 475 Le mécanisme interne du serveur \textit{web} intégré à Mercurial,
belaran@951 476 masque les adresses emails, pour rendre plus difficile leurs
belaran@951 477 récupérations par les outils utilisés par les \textit{spammmers}.
huguesfrachon@955 478 Ceci réduit la probabilité que de recevoir encore plus de
belaran@951 479 \textit{spam} si vous vous publiez un dépôt sur internet.
bos@102 480 \end{note}
bos@102 481
belaran@951 482 \subsection{Rédiger un message de \textit{commit}}
belaran@951 483
Wilk@956 484 Lorsqu'on effectue une opération de \textit{commit}, Mercurial
belaran@951 485 lance automatiquement un éditeur de texte pour permettre de saisir
belaran@951 486 un message qui décrira les modifications effectuées dans ce
huguesfrachon@955 487 \textit{changeset}. Ce message est nommé le \emph{message de
belaran@951 488 \textit{commit}}. Ce sera un enregistrement pour tout lecteur
belaran@951 489 expliquant le pourquoi et le comment de vos modifications, et il sera
belaran@951 490 affiché par la commande \hgcmd{log}.
bos@91 491 \interaction{tour.commit}
bos@91 492
huguesfrachon@955 493 L'éditeur que la commande \hgcmd{commit} déclenche ne contiendra
belaran@951 494 qu'une ligne vide suivi d'un certain nombre de lignes commençant
belaran@951 495 par ``\texttt{HG:}''.
bos@91 496 \begin{codesample2}
bos@91 497 \emph{empty line}
bos@91 498 HG: changed hello.c
bos@91 499 \end{codesample2}
huguesfrachon@955 500 Mercurial ignore les lignes qui commencent avec ``\texttt{HG:}'', il
belaran@951 501 ne les utilise que pour nous indiquer quels fichiers modifiés il se
belaran@951 502 prépare à \textit{commiter}. Modifier ou effacer ces lignes n'a
belaran@951 503 aucune conséquence sur l'opération de \textit{commit}.
belaran@951 504
Wilk@956 505 \subsection{Rédiger un message \textit{approprié}}
belaran@951 506
belaran@951 507 Comme \hgcmd{log} n'affiche que la première ligne du message de
belaran@951 508 \textit{commit} par défaut, il est souvent considéré comme une bonne
Wilk@956 509 pratique de rédiger des messages de \textit{commit} qui tiennent
belaran@951 510 sur une seule ligne. Voilà un exemple concret de message de
belaran@951 511 \textit{commit} qui \emph{ne suit pas} cette directive, et qui a donc
belaran@951 512 un résumé peu lisible.
belaran@960 513
bos@91 514 \begin{codesample2}
bos@91 515 changeset: 73:584af0e231be
bos@91 516 user: Censored Person <censored.person@example.org>
bos@91 517 date: Tue Sep 26 21:37:07 2006 -0700
bos@91 518 summary: include buildmeister/commondefs. Add an exports and install
bos@91 519 \end{codesample2}
bos@91 520
huguesfrachon@955 521 A ce sujet, il faut noter qu'il n'existe pas de règle absolue dans ce
belaran@951 522 domaine. Mercurial lui-même n'interprète pas les contenus des messages
belaran@951 523 de \textit{commit}, ainsi votre projet est libre de concevoir différentes
Wilk@956 524 politiques de mise en page des messages.
belaran@951 525
belaran@951 526 Ma préférence personnelle va au message court, mais informatif, qui offre
huguesfrachon@955 527 des précisions supplémentaires par rapport à ce que pourrait m'apprendre une commande
belaran@951 528 \hgcmdargs{log}{--patch}.
belaran@951 529
belaran@951 530 \subsection{Annuler un \textit{commit}}
belaran@951 531
belaran@951 532 Si, en rédigeant le message, vous décidez que finalement vous ne
huguesfrachon@955 533 voulez pas effectuer ce \textit{commit}, il suffit de quitter simplement
belaran@951 534 l'éditeur sans sauver. Ceci n'aura aucune conséquence sur le dépôt ou
belaran@951 535 les fichiers de l'espace de travail.
belaran@951 536
Wilk@956 537 Si vous exécuter la commande \hgcmd{commit} sans aucun argument, elle
belaran@951 538 enregistre toutes les modifications que vous avez faites, comme le montre
huguesfrachon@955 539 les commandes \hgcmd{status} et \hgcmd{diff}.
belaran@951 540
belaran@951 541 \subsection{Admirer votre travail}
belaran@951 542
belaran@951 543 Une fois que votre \textit{commit} est terminé, vous pouvez utiliser
belaran@951 544 la commande \hgcmd{tip} pour afficher le \textit{changeset} que nous
belaran@951 545 venons de créer. Cette commande produit une sortie à l'écran qui est
huguesfrachon@955 546 identique à celle du \hgcmd{log}, mais qui n'affiche que la dernière
belaran@951 547 révision du dépôt.
bos@91 548 \interaction{tour.tip}
Wilk@956 549 On fait couramment référence à la dernière révision du dépôt comme
belaran@951 550 étant la révision \textit{tip}, ou plus simplement le \textit{tip}.
belaran@951 551
belaran@951 552 \section{Partager ses modifications}
belaran@951 553
belaran@951 554 Nous avons mentionné plus haut que les dépôts de Mercurial
belaran@951 555 sont autosuffisants. Ce qui signifie que le \textit{changeset}
belaran@951 556 que vous venez de créer existe seulement dans votre répertoire
Wilk@956 557 \dirname{my-hello}. Étudions comment propager cette modification
belaran@951 558 dans d'autres dépôts.
belaran@951 559
belaran@951 560 \subsection{Récupérer les modifications d'autres dépôts}
bos@91 561 \label{sec:tour:pull}
bos@91 562
Wilk@956 563 Pour commencer, construisons un clone de notre dépôt \dirname{hello}
belaran@951 564 qui ne contiendra pas le changement que nous venons d'effectuer. Nous
Wilk@956 565 l'appellerons notre dépôt temporaire \dirname{hello-pull}.
belaran@960 566
bos@91 567 \interaction{tour.clone-pull}
bos@91 568
belaran@951 569 Nous allons utiliser la commande \hgcmd{pull} pour apporter les
belaran@951 570 modifications depuis \dirname{my-hello} dans \dirname{hello-pull}.
belaran@951 571 Néanmoins, récupérer aveuglement des modifications depuis un dépôt
Wilk@956 572 a quelque chose d'un peu effrayant. Mercurial propose donc une
belaran@951 573 commande \hgcmd{incoming} qui permet de savoir quelles modifications
belaran@951 574 la commande \hgcmd{pull} \emph{pourrait} entraîner dans notre dépôt,
huguesfrachon@955 575 et ceci sans effectuer réellement de modification dessus.
bos@91 576 \interaction{tour.incoming}
huguesfrachon@955 577 (Bien évidement, quelqu'un pourrait ajouter des modifications
belaran@951 578 supplémentaires sur le dépôt que nous étudions avec \hgcmd{incoming},
belaran@951 579 avant que nous ayons effectué notre \hgcmd{pull}, avec comme
belaran@951 580 triste conséquence que nous aurons récupéré des modifications que
belaran@951 581 nous n'attendions pas.)
belaran@951 582
huguesfrachon@955 583 Apporter les modifications rapatriées dans un dépôt se résume donc
belaran@951 584 à exécuter la commande \hgcmd{pull}, et préciser depuis quel dépôt
belaran@951 585 effectuer le \hgcmd{pull}.
bos@91 586 \interaction{tour.pull}
belaran@951 587
belaran@951 588 Comme vous le voyez avec une sortie avant et après de la commande
belaran@951 589 \hgcmd{tip}, nous avons réussi à récupérer aisément les modifications
huguesfrachon@955 590 dans notre dépôt. Il reste néanmoins quelque chose à faire avant de
belaran@951 591 placer ces modifications dans l'espace de travail.
belaran@951 592
belaran@951 593 \subsection{Mise à jour de l'espace de travail}
belaran@951 594
huguesfrachon@955 595 Nous avons jusqu'à maintenant grossièrement définie la relation
belaran@951 596 entre un dépôt et un espace de travail. La commande \hgcmd{pull} que
huguesfrachon@955 597 nous avons exécutée dans la section~\ref{sec:tour:pull} a apporté
belaran@951 598 des modifications, que nous avons vérifiées, dans notre dépôt, mais
huguesfrachon@955 599 il n'y a aucune trace de ces modifications dans notre espace de travail.
belaran@951 600 En effet, \hgcmd{pull} ne touche pas (par défaut) à l'espace de
belaran@951 601 travail. C'est la commande \hgcmd{update} qui s'en charge.
bos@91 602 \interaction{tour.update}
bos@91 603
huguesfrachon@955 604 Il peut sembler un peu étrange que la commande \hgcmd{pull} ne mette
belaran@951 605 pas à jour l'espace de travail automatiquement. Il y a en fait une
Wilk@956 606 très bonne raison à cela : vous pouvez utilisez la commande
belaran@960 607
belaran@951 608 \hgcmd{update} pour mettre à jour votre espace de travail à l'état
belaran@951 609 dans lequel il était à \emph{n'importe quelle révision} de l'historique
belaran@951 610 du dépôt. Si vous aviez un espace de travail contenant une ancienne
belaran@951 611 révision---pour chercher l'origine d'un \textit{bug}, par exemple---et
belaran@951 612 que vous effectuiez un \hgcmd{pull} qui mettrait à jour automatiquement
belaran@951 613 votre espace de travail, vous ne seriez probablement pas très satisfait.
belaran@951 614
Wilk@956 615 Néanmoins, comme les opérations de \textit{pull} sont très souvent
belaran@951 616 suivies d'un \textit{update}, Mercurial vous permet de combiner les
huguesfrachon@955 617 deux aisément en passant l'option \hgopt{pull}{-u} à la commande
belaran@951 618 \hgcmd{pull}
bos@91 619 \begin{codesample2}
bos@91 620 hg pull -u
bos@91 621 \end{codesample2}
belaran@951 622
belaran@951 623 Si vous étudiez de nouveau la sortie de la commande \hgcmd{pull} dans
huguesfrachon@955 624 la section~\ref{sec:tour:pull} quand nous l'avons exécutée sans l'option
huguesfrachon@955 625 \hgopt{pull}{-u}, vous pouvez constater qu'elle a affiché un rappel assez
huguesfrachon@955 626 utile : vous devez encore effectuer une opération pour mettre à jour
belaran@951 627 votre espace de travail:
belaran@960 628
bos@92 629 \begin{codesample2}
bos@92 630 (run 'hg update' to get a working copy)
bos@92 631 \end{codesample2}
bos@91 632
Wilk@956 633 Pour découvrir sur quelle révision de l'espace de travail on est, utilisez
belaran@951 634 la commande \hgcmd{parents}.
bos@91 635 \interaction{tour.parents}
belaran@951 636 Si vous regardez de nouveau le dessin~\ref{fig:tour-basic:history}, vous
belaran@958 637 <<<<<<< local
Wilk@956 638 verrez les flèches reliant entre eux les \textit{changeset}. Le nœud
Wilk@956 639 d'où la flèche \emph{part} est dans chaque cas un parent,
Wilk@956 640 et le nœud où la flèche \emph{arrive} est un enfant.
belaran@960 641
belaran@951 642 L'espace de travail a un parent de la même manière, c'est ce \textit{changeset}
belaran@951 643 que l'espace de travail contient à ce moment.
huguesfrachon@955 644 %%%TODO : difficile à comprendre : l'espace de travail a un parent, de la même manière, c'est ce changeset que l'espace...
belaran@951 645
belaran@951 646 Pour mettre à jour l'espace de travail d'une révision particulière,
Wilk@956 647 indiquez un numéro de révision ou un \textit{changeset~ID} à la commande
belaran@951 648 \hgcmd{update}.
bos@91 649 \interaction{tour.older}
belaran@951 650 Si vous ne précisez pas de manière explicite de numéro de révision
belaran@951 651 la commande \hgcmd{update} mettra à jour votre espace de travail avec
belaran@960 652 le contenu de la révsion \textit{tip}, comme montré dans l'exemple
belaran@951 653 ci dessus lors du second appel à \hgcmd{update}.
belaran@951 654
belaran@951 655 \subsection{Transférer les modifications à un autre dépôt}
belaran@951 656
belaran@951 657 Mercurial vous laisse transférer les modifications à un autre
belaran@951 658 dépôt, depuis votre dépôt actuel. Comme dans l'exemple du
Wilk@956 659 \hgcmd{pull} ci-dessus, nous allons créer un dépôt temporaire
belaran@951 660 vers lequel transférer\footnote{NdT: Les francophones disent souvent
belaran@951 661 ``pousser'' tout simplement} nos modifications.
bos@92 662 \interaction{tour.clone-push}
belaran@951 663 La commande \hgcmd{outgoing} nous indique quels changements nous
huguesfrachon@955 664 allons transférer vers l'autre serveur ?
bos@92 665 \interaction{tour.outgoing}
belaran@951 666 Et la commande \hgcmd{push} effectue réellement le transfert.
bos@92 667 \interaction{tour.push}
belaran@951 668 Comme avec \hgcmd{pull}, la commande \hgcmd{push} ne met pas à jour
belaran@951 669 le répertoire de travail du dépôt dans lequel il transfère les
belaran@951 670 modifications. (À l'inverse de \hgcmd{pull}, \hgcmd{push} ne fournit
belaran@951 671 pas d'option \texttt{-u} pour forcer la mise à jour de l'espace
belaran@951 672 de travail cible).
belaran@951 673
belaran@951 674 Qu'est ce qui se passe lorsque vous essayez de récupérer ou de transférer
belaran@951 675 vos modifications et que le dépôt cible a déjà reçu ces modifications ?
belaran@951 676 Rien de bien excitant.
bos@92 677 \interaction{tour.push.nothing}
bos@92 678
belaran@951 679 \subsection{Partager ses modifications à travers le réseau}
belaran@951 680
huguesfrachon@955 681 Les commandes que nous avons étudiées dans les sections précédentes
huguesfrachon@955 682 ne sont pas limitées aux dépôt locaux. Chacune fonctionne de la même
belaran@951 683 manière à travers une connexion réseau, il suffit de lui passer une
Wilk@956 684 URL à la place d'un chemin de fichier local.
belaran@951 685
bos@93 686 \interaction{tour.outgoing.net}
belaran@951 687 Dans cet exemple, nous allons voir quels changements nous pourrions
belaran@951 688 transférer vers le dépôt distant, mais le dépôt est, de manière tout
belaran@951 689 à fait compréhensible, pas configuré pour accepter des modifications
belaran@951 690 d'utilisateurs anonymes.
bos@93 691 \interaction{tour.push.net}
bos@93 692
bos@84 693 %%% Local Variables:
bos@84 694 %%% mode: latex
bos@84 695 %%% TeX-master: "00book"
bos@84 696 %%% End: