hgbook

annotate fr/tour-merge.tex @ 959:b3cb66d935cf

Finished tour-merge.tex
author Romain PELISSE <belaran@gmail.com>
date Mon Feb 23 23:53:18 2009 +0100 (2009-02-23)
parents 2cd5d582c956
children bac1c207c76d
rev   line source
belaran@953 1 \chapter{Un rapide tour de Mercurial: fusionner les travaux}
bos@95 2 \label{chap:tour-merge}
bos@94 3
belaran@954 4 Nous avons maintenons étudié comment cloner un dépôt, effectuer
belaran@953 5 des changements dedans, et récupérer ou transférer depuis un
belaran@953 6 autre dépôt. La prochaine étape est donc de \emph{fusionner} les
belaran@953 7 modifications de différents dépôts.
belaran@953 8
belaran@953 9 \section{Fusionner différents travaux} %%%TODO: better translation
belaran@953 10 %%% for 'Merging streams of work' ?
belaran@953 11 La fusion\footnote{NdT: Je garde fusion mais le jargon professionnel
belaran@954 12 emploiera généralement le terme \textit{merge}.} est un aspect
belaran@953 13 fondamental lorsqu'on travail avec un gestionnaire de source
belaran@954 14 distribué.
bos@94 15 \begin{itemize}
belaran@953 16 \item Alice et Bob ont chacun une copie personnelle du dépôt d'un
belaran@953 17 projet sur lequel ils collaborent. Alice corrige un \textit{bug}
belaran@953 18 dans son dépôt, et Bob ajoute une nouvelle fonctionnalité dans le
belaran@953 19 sien. Ils veulent un dépôt partagé avec à la fois le correctif du
belaran@953 20 \textit{bug} et la nouvelle fonctionnalité.
belaran@953 21 \item Je travaille régulièrement sur plusieurs tâches différentes sur
belaran@953 22 un seul projet en même temps, chacun isolée dans son propre dépôt.
belaran@953 23 Travailler ainsi signifie que je dois régulièrement fusionner une
belaran@953 24 partie de mon code avec celui des autres.
bos@94 25 \end{itemize}
bos@94 26
belaran@953 27 Parce que la fusion est une opération si commune que je dois réaliser,
belaran@954 28 Mercurial la rend facile. Étudions ensemble le déroulement des opérations.
belaran@954 29 Nous commencerons par faire un clone de encore un autre dépôt (vous voyez
belaran@953 30 comment on fait ça tout le temps ?) puis nous ferons quelques modifications
belaran@953 31 dessus.
bos@94 32 \interaction{tour.merge.clone}
belaran@953 33 Nous devrions avoir maintenant deux copies de \filename{hello.c} avec
belaran@953 34 des contenus différents. Les historiques de ces deux dépôts ont aussi
belaran@953 35 divergés, comme illustré dans la figure~\ref{fig:tour-merge:sep-repos}.
belaran@953 36
bos@94 37 \interaction{tour.merge.cat}
bos@94 38
bos@99 39 \begin{figure}[ht]
bos@99 40 \centering
bos@99 41 \grafix{tour-merge-sep-repos}
belaran@953 42 \caption{Historiques récent divergents des dépôts \dirname{my-hello}
belaran@953 43 et \dirname{my-new-hello}}
bos@99 44 \label{fig:tour-merge:sep-repos}
bos@99 45 \end{figure}
bos@99 46
belaran@953 47 Nous savons déjà que récupérer les modifications depuis notre dépôt
belaran@953 48 \dirname{my-hello} n'aura aucun effet sur l'espace de travail.
belaran@953 49
bos@94 50 \interaction{tour.merge.pull}
belaran@953 51
belaran@954 52 Néanmoins, la commande \hgcmd{pull} nous indique quelque chose au
belaran@953 53 sujet des ``heads''.
belaran@953 54
belaran@953 55 \subsection{\textit{Head changesets}} %%%TODO: Hard (too?) to translate
belaran@953 56
belaran@953 57 Une \textit{head}\footnote{NdT: Je garde \textit{head} que j'accorde
belaran@953 58 au féminin comme la coutume oral l'a imposée.} est un \textit{changeset}
belaran@953 59 sans descendants, ou enfants, comme on les désigne parfois. La révision
belaran@953 60 \textit{tip} est une \textit{head}, car la dernière révision dans un dépôt
belaran@953 61 n'a aucun enfant, mais il est important de noter qu'un dépôt peut contenir
belaran@953 62 plus d'une \textit{head}.
bos@99 63
bos@99 64 \begin{figure}[ht]
bos@99 65 \centering
bos@99 66 \grafix{tour-merge-pull}
belaran@953 67 \caption{Contenu d'un dépôt après avoir transférer le contenu du dépôt
belaran@953 68 \dirname{my-hello} dans le dépôt \dirname{my-new-hello}}
bos@99 69 \label{fig:tour-merge:pull}
bos@99 70 \end{figure}
bos@99 71
belaran@953 72 Dans la figure~\ref{fig:tour-merge:pull}, vous pouvez constater l'effet
belaran@953 73 d'un \textit{pull} depuis le dépôt \dirname{my-hello} dans le dépôt
belaran@953 74 \dirname{my-new-hello}. L'historique qui était déjà présent dans le dépôt
belaran@953 75 \dirname{my-new-hello} reste intact, mais une nouvelle révision a été
belaran@953 76 ajoutée. En vous reportant à la figure~\ref{fig:tour-merge:sep-repos},
belaran@953 77 vous pouvez voir que le \textit{\emph{changeset ID}} reste le même dans
belaran@953 78 le nouveau dépôt, mais que le \emph{numéro de révision} reste le même.
belaran@953 79 (Ceci est un parfait exemple de pourquoi il n'est fiable d'utiliser les
belaran@953 80 numéro de révision lorsque l'on discute d'un \textit{changeset}.) Vous
belaran@953 81 pouvez voir les \texit{heads} présente dans le dépôt en utilisant la
belaran@953 82 commande \hgcmd{heads}.
bos@94 83 \interaction{tour.merge.heads}
bos@102 84
belaran@953 85 \subsection{Effectuer la fusion}
belaran@953 86
belaran@953 87 Que se passe-t-il quand vous essayez d'utiliser la commande \hgcmd{update}
belaran@953 88 pour mettre à jour votre espace de travail au nouveau \textit{tip}.
bos@94 89 \interaction{tour.merge.update}
belaran@953 90 Mercurial nous prévient que la commande \hgcmd{update} n'effectuera pas
belaran@953 91 la fusion, il ne veut pas mettre à jour l'espace de travail quand il
belaran@953 92 estime que nous pourrions avoir besoin d'une fusion, à moins de lui
belaran@953 93 forcer la main. À la place, il faut utiliser la commande \hgcmd{merge}
belaran@953 94 pour fusionner les deux \textit{heads}.
bos@94 95 \interaction{tour.merge.merge}
bos@100 96
bos@100 97 \begin{figure}[ht]
bos@100 98 \centering
bos@100 99 \grafix{tour-merge-merge}
belaran@953 100 \caption{Espace de travail et dépôt lors d'une fusion, et dans le
belaran@953 101 \textit{commit} qui suit.}
bos@100 102 \label{fig:tour-merge:merge}
bos@100 103 \end{figure}
bos@100 104
belaran@953 105 Ceci met à jour de l'espace de travail de manière à ce qu'il contienne
belaran@954 106 les modifications des \emph{deux} \textit{heads}, ce qui apparaît dans
belaran@953 107 les sorties de la commande \hgcmd{parents} et le contenu de
belaran@953 108 \filename{hello.c}.
bos@94 109 \interaction{tour.merge.parents}
bos@102 110
belaran@954 111 \subsection{Effectuer le \textit{commit} du résultat de la fusion}
belaran@954 112
belaran@954 113 Dès l'instant où vous avez effectuer une fusion, \hgcmd{parents} vous
belaran@954 114 affichera deux parents, avant que vous n'exécuter la commande
belaran@954 115 \hgcmd{commit} sur le résultat de la fusion.
bos@94 116 \interaction{tour.merge.commit}
belaran@953 117 Nous avons maintenant un nouveau \textit{tip}, remarquer qu'il contient
belaran@953 118 \emph{à la fois} nos anciennes \textit{heads} et leurs parents. Ce sont
belaran@953 119 les mêmes révisions que nous avions affichés avec la commande
belaran@953 120 \hgcmd{parents}.
belaran@953 121
bos@94 122 \interaction{tour.merge.tip}
belaran@953 123 Dans la figure~\ref{fig:tour-merge:merge}, vous pouvez voir une représentation
belaran@953 124 de ce qui se passe dans l'espace de travail pendant la fusion, et comment ceci
belaran@953 125 affecte le dépôt lors du \textit{commit}. Pendant la fusion, l'espace de travail,
belaran@953 126 qui a deux \texit{changesets} comme parents, voit ces derniers devenir le parent
belaran@953 127 d'un nouveau \textit{changeset}.
belaran@953 128
belaran@953 129 \section{Fusionner les modifications en conflit}
belaran@953 130
belaran@953 131 La plupart des fusions sont assez simple à réaliser, mais parfois
belaran@954 132 vous vous trouverez à fusionner des fichiers où la modification touche
belaran@953 133 la même portion de code, au sein d'un même fichier. À moins que ces
belaran@953 134 modification ne soient identiques, ceci aboutira à un \emph{conflit},
belaran@954 135 et vous devrez décider comment réconcilier les différentes modifications
belaran@953 136 dans un tout cohérent.
bos@103 137
bos@103 138 \begin{figure}[ht]
bos@103 139 \centering
bos@103 140 \grafix{tour-merge-conflict}
belaran@953 141 \caption{Modifications conflictuelles dans un document}
bos@103 142 \label{fig:tour-merge:conflict}
bos@103 143 \end{figure}
bos@103 144
belaran@953 145 La figure~\ref{fig:tour-merge:conflict} illustre un cas de modifications
belaran@953 146 conflictuelles dans un document. Nous avons commencé avec une version simple
belaran@953 147 de ce fichier, puis nous avons ajoutés des modifications, pendant que
belaran@953 148 quelqu'un d'autre modifie le même texte. Notre tâche dans la résolution
belaran@953 149 du conflit est de décider à quoi le fichier devrait ressembler.
belaran@953 150
belaran@953 151 Mercurial n'a pas de mécanisme interne pour gérer les conflits.
belaran@954 152 À la place, il exécute un programme externe appelé \command{hgmerge}.
belaran@953 153 Il s'agit d'un script shell qui est embarqué par Mercurial, vous
belaran@953 154 pouvez le modifier si vous le voulez. Ce qu'il fait par défaut est
belaran@953 155 d'essayer de trouver un des différents outils de fusion qui seront
belaran@953 156 probablement installé sur le système. Il commence par les outils
belaran@953 157 totalement automatique, et si ils échouent (parce que la résolution
belaran@953 158 du conflit nécessite une intervention humaine) ou si ils sont absents,
belaran@953 159 le script tente d'exécuter certains outils graphiques de fusion.
belaran@953 160
belaran@953 161 Il est aussi possible de demander à Mercurial d'exécuter un autre
belaran@953 162 programme ou un autre script au lieu de la commande \command{hgmerge},
belaran@954 163 en définissant la variable d'environnement \envar{HGMERGE} avec le nom
belaran@953 164 du programme de votre choix.
belaran@953 165
belaran@953 166 \subsection{Utiliser un outil graphique de fusion}
belaran@953 167
belaran@953 168 Mon outil de fusion préféré est \command{kdiff3}, que j'utilise ici
belaran@953 169 pour illustré les fonctionnalités classiques des outils graphiques
belaran@953 170 de fusion. Vous pouvez voir une capture d'écran de l'utilisation de
belaran@953 171 \command{kdiff3} dans la figure~\ref{fig:tour-merge:kdiff3}. Cet outil
belaran@953 172 effectue une \emph{fusion \textit{three-way}}, car il y a trois différentes
belaran@953 173 versions du fichier qui nous intéresse. Le fichier découpe la partie
belaran@953 174 supérieure de la fenêtre en trois panneaux:
belaran@953 175
bos@103 176 \begin{itemize}
belaran@953 177 \item A gauche on la version de \emph{base} du fichier, soit ~la plus
belaran@953 178 récente version des deux versions qu'on souhaite fusionner.
belaran@953 179 \item Au centre, il y a ``notre'' version du fichier, avec le contenu
belaran@953 180 que nous avons modifié.
belaran@953 181 \item Sur la droite, on trouve ``leur'' version du fichier, celui qui qui
belaran@953 182 contient le \textit{changeset} que nous souhaitons intégré.
bos@103 183 \end{itemize}
belaran@953 184
belaran@953 185 Dans le panneau en dessous, on trouve le \emph{résultat} actuel de notre
belaran@953 186 fusion. Notre tâche consiste donc à remplacement tout les textes en rouges,
belaran@953 187 qui indiquent des conflits non résolus, avec un fusion manuel et pertinente
belaran@953 188 de ``notre'' version et de la ``leur''.
belaran@953 189
belaran@954 190 Tout les quatre panneaux sont \emph{accrochés ensemble}, si nous déroulons
belaran@953 191 les ascenseurs verticalement ou horizontalement dans chacun d'entre eux, les
belaran@953 192 autres sont mise à jours avec la section correspondantes dans leurs fichiers.
bos@103 193
bos@103 194 \begin{figure}[ht]
bos@103 195 \centering
bos@103 196 \grafix{kdiff3}
belaran@953 197 \caption{Utilisation de \command{kdiff3} pour fusionner différents versions
belaran@953 198 d'un fichier.}
bos@103 199 \label{fig:tour-merge:kdiff3}
bos@103 200 \end{figure}
bos@103 201
belaran@953 202 Pour chaque portion de fichier posant problème, nous pouvons choisir
belaran@954 203 de résoudre le le conflit en utilisant en utilisant une combinaison
belaran@953 204 de texte depuis la version de base, la notre, ou la leur. Nous pouvons
belaran@953 205 aussi éditer manuellement les fichiers à tous moments, si c'est
belaran@953 206 nécessaire.
belaran@953 207
belaran@953 208 Il y a \emph{beaucoup} d'outils de fusion disponibles, bien trop pour
belaran@954 209 en parler de tous ici. Leurs disponibilités varient selon les plate formes
belaran@954 210 ainsi que leurs avantages et inconvénients. La plupart sont optimisé pour
belaran@953 211 la fusion de fichier contenant un texte plat, certains sont spécialisé
belaran@954 212 dans un format de fichier précis (généralement XML).
belaran@954 213
belaran@954 214 \subsection{A worked example} %TODO: Find a translation for this !
belaran@954 215
belaran@954 216 Dans cet exemple, nous allons reproduire la modification de l'historique
belaran@954 217 du fichier de la figure~\ref{fig:tour-merge:conflict} ci dessus. Commençons
belaran@954 218 par créer un dépôt avec une version de base de notre document.
belaran@954 219
bos@103 220 \interaction{tour-merge-conflict.wife}
belaran@954 221 Créons un clone de ce dépôt et faisons une modification dans le fichier.
bos@103 222 \interaction{tour-merge-conflict.cousin}
belaran@954 223 Et un autre clone, pour simuler que quelqu'un d'autre effectuer une
belaran@954 224 modification sur le fichier. (Ceci pour suggérer qu'il n'est pas rare
belaran@954 225 de devoir effectuer des \textit{merge} avec vos propres travaux quand
belaran@954 226 vous isoler les tâches dans des dépôts distincts. En effet, vous
belaran@954 227 aurez alors à trouver et résoudre certains conflits).
bos@103 228 \interaction{tour-merge-conflict.son}
belaran@954 229 Maintenant que ces deux versions différentes du même fichier sont
belaran@954 230 créées, nous allons configurer l'environnement approprié pour exécuter
belaran@954 231 notre \textit{merge}.
bos@103 232 \interaction{tour-merge-conflict.pull}
bos@103 233
belaran@954 234 Dans cette exemple, je n'utiliserais pas la commande Mercurial
belaran@954 235 habituelle \command{hgmerge} pour effectuer le \textit{merge},
belaran@954 236 car il me faudrait abandonner ce joli petit exemple automatisé
belaran@954 237 pour utiliser un outil graphique. À la place, je vais définir
belaran@954 238 la variable d'environnement \envar{HGMERGE} pour indiquer à
belaran@954 239 Mercurial d'utiliser la commande non-interactive \command{merge}.
belaran@954 240 Cette dernière est embarqué par de nombreux systèmes ``à la Unix''.
belaran@954 241 Si vous exécuter cet exemple depuis votre ordinateur, ne vous
belaran@954 242 occupez pas de définir \envar{HGMERGE}.
bos@103 243 \interaction{tour-merge-conflict.merge}
belaran@954 244 Parce que \command{merge} ne peut pas résoudre les modifications
belaran@954 245 conflictuelles, il laisse des \emph{marqueurs de différences}
belaran@954 246 \footnote{NdT: Oui, je traduis \textit{merge markers} par un sens
belaran@954 247 inverse en Français, mais je pense vraiment que c'est plus clair
belaran@954 248 comme ça...} à l'intérieur du fichier qui a des conflits, indiquant
belaran@954 249 clairement quelles lignes sont en conflits, et si elles viennent de
belaran@954 250 notre fichier ou du fichier externe.
belaran@954 251
belaran@954 252 Mercurial peut distinguer, à la manière dont la commande \command{merge}
belaran@954 253 se termine, qu'elle n'a pas été capable d'effectuer le \textit{merge},
belaran@954 254 alors il nous indique qu'il faut devons effectuer de nouveau cette
belaran@954 255 opération. Ceci peut être très utile si, par exemple, nous exécutons un
belaran@954 256 outil graphique de fusion et que nous le quittons sans se rendre compte
belaran@954 257 qu'il reste des conflits ou simplement par erreur.
belaran@954 258
belaran@954 259 Si le \textit{merge} automatique ou manuel échoue, il n'y a rien pour
belaran@954 260 nous empêcher de ``corriger le tir'' en modifiant nous même les fichiers,
belaran@954 261 et enfin effectuer le \textit{commit} du fichier:
bos@103 262 \interaction{tour-merge-conflict.commit}
bos@103 263
belaran@959 264 \section{Simplifier l'enchaînement de \textit{pull-merge-commit} }
bos@224 265 \label{sec:tour-merge:fetch}
bos@102 266
belaran@959 267 Le processus de fusion des modifications, comme indiqué ci dessus,
belaran@959 268 est simple, mais il requiert d'exécuter 3 commandes de suite.
bos@102 269 \begin{codesample2}
bos@102 270 hg pull
bos@102 271 hg merge
bos@102 272 hg commit -m 'Merged remote changes'
bos@102 273 \end{codesample2}
belaran@959 274 Dans le cas d'un \textit{commit} final, vous avez aussi besoin
belaran@959 275 de saisir un message, qui sera presque systématiquemetn un texte
belaran@959 276 sans grand interêt, juste pour mentionner qu'un \textit{merge} a
belaran@959 277 eu lieu.
belaran@959 278
belaran@959 279 Il serait agréable de pouvoir réduire le nombre d'étape nécessaire.
belaran@959 280 En effet, Mercurial est distribué avec une extension nommée \hg{fetch}
belaran@959 281 qui le permet.
belaran@959 282
belaran@959 283 Mercurial fournit un méchanisme flexible d'extension qui permet à
belaran@959 284 quiquonque d'ajouter des fonctionnalités, tout en conservant le
belaran@959 285 coeur de Mercurial relativement petit et facile à maintenir. Quelques
belaran@959 286 extensions ajoutent des nouvelles commandes que vous pouvez utiliser
belaran@959 287 depuis votre terminal, alors que d'autres opèrent ``dans les coulisses'',
belaran@959 288 pour ajouter par exemple des fonctionnalités au server.
belaran@959 289
belaran@959 290 L'extension \hgext{fetch} ajoute une nouvelle commande appelée, sans
belaran@959 291 surprise, \hgcmd{fetch}. Cette extension agit comme une combinaison
belaran@959 292 de \hgcmd{pull}, \hgupdate{update} et \hgcmd{merge}. Elle commence
belaran@959 293 par faire un \textit{pull} des modifications depuis un autre dépôt dans
belaran@959 294 le dépôt local. Si elle trouve des modifications ajoutés à la \textit{head}
belaran@959 295 du dépôt, elle commencera à effectuer le \textit{merge}, puis elle
belaran@959 296 déclenchera le \textit{commit} du résultat avec un message généré
belaran@959 297 automatiquement. Si aucune nouvell \textit{head} n'est ajouté elle
belaran@959 298 met à jour l'espace de travail avec le nouveau \textit{tip}.
belaran@959 299
belaran@959 300 Activé l'extension \hgext{fetch} est très facile. Ouvrez le fichier
belaran@959 301 \sfilename{.hgrc}, et, soit allez dans la section \rcsection{extensions}
belaran@959 302 ou créer une section \rcsection{extensions} si elle absente. Ensuite,
belaran@959 303 ajoutée une ligne qui contient simplement ``\Verb+fetch +''.
bos@102 304 \begin{codesample2}
bos@102 305 [extensions]
bos@102 306 fetch =
bos@102 307 \end{codesample2}
belaran@959 308 (Normalement, à droite du signe ``\texttt{=}'' on verrait apparaître
belaran@959 309 l'adresse de l'extension sur le système, mais comme \hgext{fetch} est
belaran@959 310 une extension distribué avec Mercurial, ce dernier sait où la
belaran@959 311 retrouver.)
bos@102 312
bos@84 313 %%% Local Variables:
bos@84 314 %%% mode: latex
bos@84 315 %%% TeX-master: "00book"
bos@84 316 %%% End: