tuteurs.ens.fr/logiciels/cvs/index.tml

587 lines
16 KiB
Text
Raw Normal View History

<?xml version="1.0" encoding="UTF-8"?>
2002-12-20 18:38:42 +01:00
<!DOCTYPE html
PUBLIC "-//ENS/Tuteurs//DTD TML 1//EN"
"tuteurs://DTD/tml.dtd">
<html>
<head>
<title>CVS</title>
</head>
<body>
<h1>Le contrôle de versions avec CVS</h1>
2002-12-20 18:38:42 +01:00
<p><code>CVS</code> est un logiciel Unix pour gérer différentes versions
de beaucoup de fichiers produits éventuellement par de multiples
2005-09-16 00:48:08 +02:00
utilisateurs.</p>
2002-12-20 18:38:42 +01:00
<p>
Par exemple, les tuteurs informatique utilisent <code>CVS</code> pour
gérer ce site.
2002-12-20 18:38:42 +01:00
</p>
<h2>Pourquoi CVS ?</h2>
2005-09-16 00:48:08 +02:00
<h3>L'enfer, c'est les autres</h3>
<p>
Supposons par exemple que vous conceviez un mémoire de maîtrise en
collaboration avec un camarade, ou encore que vous écriviez un programme
informatique en collaboration avec une équipe de développeurs. Plusieurs
scénarii-catastrophes peuvent être envisagés, et vous pouvez être sûr
qu'au moins l'un d'entre eux se réalisera tôt ou tard :
2005-09-16 00:48:08 +02:00
</p>
<ol>
<li> l'un des contributeurs efface par erreur tout ou partie du travail
commun mené jusque là, alors même que vous approchiez de son
terme ;</li>
2005-09-16 00:48:08 +02:00
<li> un contributeur apporte des corrections à une version obsolète du
travail commun, car il ne savait pas où trouver la version la plus
récente ;</li>
2005-09-16 00:48:08 +02:00
<li> deux contributeurs travaillaient simultanémlent sans le savoir, et
le deuxième a effacé sans le vouloir tout le travail du
premier ;</li>
2005-09-16 00:48:08 +02:00
<li> un contributeur a commis de nombreuses erreurs, et l'on doit
revenir sur chacune de ses modifications, en espérant ne pas laisser
d'erreurs ; </li>
2005-09-16 00:48:08 +02:00
<li>etc., etc.</li>
</ol>
<h3>La solution : CVS</h3>
2005-09-16 00:48:08 +02:00
<p>
L'idéal, pour éviter ces problèmes, serait de pouvoir concilier deux
exigences apparemment contradictoires :
2005-09-16 00:48:08 +02:00
</p>
<ol>
<li> centraliser les versions officielles pour éviter toute
ambiguïté ;</li>
2005-09-16 00:48:08 +02:00
<li> décentraliser les versions de travail, sur lesquelles les
2005-09-16 00:48:08 +02:00
contributeurs apportent leurs modifications.</li>
</ol>
<p>
CVS réunit ces deux avantages, en respectant les principes
suivants :
2005-09-16 00:48:08 +02:00
</p>
<ol>
<li> centralisation des versions officielles ;</li>
<li> numérotation des versions ;</li>
<li> possibilité de retour à une version antérieure ;</li>
2005-09-16 00:48:08 +02:00
<li> gestion des conflits entre deux modifications contradictoires des
mêmes fichiers ;</li>
<li> décentralisation des répertoires de travail, ce qui permet à
plusieurs utilisateurs de travailler simultanément, et de ne pas
officialiser les modifications tant qu'elles ne sont pas terminées.</li>
2005-09-16 00:48:08 +02:00
</ol>
<p>
Pour vous initier à CVS, nous allons successivement vous présenter
2005-09-16 00:48:08 +02:00
comment mettre un projet sous CVS, puis comment travailler au quotidien
sous CVS.
</p>
<h2>Préliminaires à l'utilisation de CVS</h2>
2005-09-16 00:48:08 +02:00
<p>
Pour mettre des projets sous CVS, il faut procéder en deux temps :
2005-09-16 00:48:08 +02:00
</p>
<ol>
<li> créer un répertoire de dépôt CVS (en anglais
<em>repository</em>), où seront stockées toutes les versions officielles
et leurs modifications ;</li>
2005-09-16 00:48:08 +02:00
<li> ajouter à ce répertoire les différents projets que vous voulez
mener à l'aide de CVS.</li>
2005-09-16 00:48:08 +02:00
</ol>
<h3>Créer un répertoire de dépôt CVS (<em>repository</em>)</h3>
2005-09-16 00:48:08 +02:00
<p>
Commençons par créer un répertoire de dépôt, c'est-à-dire un répertoire
où CVS stocke toutes les versions et leurs
modifications. Rassurez-vous : CVS investit toute son ingéniosité
pour réduire au maximum l'espace disque utilisé, en ne retenant <em>que
les modifications</em>, au lieu de recopier à chaque fois l'intégralité
2005-09-16 00:48:08 +02:00
des fichiers d'un projet.
</p>
<p>
Pour cela, il faut d'abord créer matériellement ce répertoire, par
exemple <code>$HOME/cvs</code>, puis créer la variable d'environnement
CVSROOT :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~ $</span> mkdir $HOME/cvs
<span class="prompt">bireme ~ $</span> CVSROOT="$HOME/cvs"
2005-11-04 15:59:12 +01:00
<span class="prompt">bireme ~ $</span> export CVSROOT
2005-09-16 00:48:08 +02:00
</pre>
<p>
Mais attention ! dans ce cas, la variable CVSROOT disparaîtra quand
vous vous déloguerez ou fermerez le terminal courant. Aussi faut-il
écrire dans votre fichier <code>.profile</code> (au moins dans le cas de la
configuration des machines de l'ENS ; sur une machine personnelle ça peut
être différent) :
2005-09-16 00:48:08 +02:00
</p>
<pre>
2005-11-04 15:59:12 +01:00
CVSROOT="$HOME/cvs"; export CVSROOT
2005-09-16 00:48:08 +02:00
</pre>
<p class="continue">
Une fois que ce répertoire existe, il faut « faire les
présentations » avec CVS. Tapez :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~ $</span> cd cvs
<span class="prompt">bireme ~/cvs $</span> cvs init
</pre>
<p>
Maintenant, vous avez un répertoire de dépôt prêt à recevoir et à
stocker les différents projets. Il ne reste plus qu'à le remplir !
2005-09-16 00:48:08 +02:00
</p>
2005-09-16 10:42:45 +02:00
<p>
Plusieurs fois, <strong>cvs ouvrira un éditeur de texte</strong> en vous
demandant de commenter ce que vous êtes en train de
2005-09-16 10:42:45 +02:00
faire. <strong>Commentez vos modifications d'une avec un peu de
précision</strong> : évitez par exemple d'écrire simplement
« modifications diverses », mais plutôt « orthographe,
typographie, paragraphe sur X ou Y, fontion Z ou T,
etc. » L'objectif est qu'un autre contributeur (ou vous-même à une
date ultérieure) puisse ne lire <em>que</em> ce commentaire et savoir la
2005-09-16 10:42:45 +02:00
nature de vos modifications.
</p>
2005-09-16 00:48:08 +02:00
<h3>Créer un projet</h3>
2005-09-16 00:48:08 +02:00
<p>
Supposons que vous soyez en train de concevoir un projet nommé
« turing-test », dont tous les fichiers sont réunis dans le
répertoire <code>$HOME/programmation/turing-test</code>.
2005-09-16 00:48:08 +02:00
</p>
<p>
Tapez :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~ $</span> cd programmation/turing-test
<span class="prompt">bireme ~/programmation/turing-test $</span> cvs import turing votre_nom version0
</pre>
<p>
Ainsi est créé un répertoire <code>$HOME/cvs/turing</code>
contenant des fichiers correspondant à ceux du répertoire
2005-09-16 00:48:08 +02:00
<code>$HOME/programmation/turing-test</code>.
</p>
<p>
La mention <code>votre_nom</code> vous désigne ; vous pouvez mettre
votre login, ou autre chose si vous préférez.
2005-09-16 00:48:08 +02:00
</p>
<p>
Quant à la mention <code>version0</code>, il s'agit juste d'un nom pour
la version initiale : vous pouvez tout aussi bien mettre
<code>start</code>, <code>debut</code>, etc. Seule contrainte : le
premier caractère doit être une lettre.
2005-09-16 00:48:08 +02:00
</p>
<h3>Créer un répertoire de travail</h3>
2005-09-16 00:48:08 +02:00
<p>
Maintenant que vous avez créé votre projet sous CVS, vous pouvez vous
créer un répertoire de travail.
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~ $</span> mkdir rep-travail
<span class="prompt">bireme ~ $</span> cd rep-travail
<span class="prompt">bireme ~/rep-travail $</span> cvs checkout turing
</pre>
<p>
La commande <code>cvs checkout <em>projet</em></code> crée un
répertoire de travail pour le projet indiqué. <strong>Vous pouvez en
créer autant que vous voulez</strong> (si vous en avez vraiment
l'utilité...). En particulier, plusieurs utilisateurs différents peuvent
en créer : c'est précisément ce qui fait l'intérêt de CVS.
2005-09-16 00:48:08 +02:00
</p>
<h2>CVS au quotidien</h2>
<h3>Mettre à jour son répertoire de travail</h3>
2005-09-16 00:48:08 +02:00
<p>
Avant de modifier les fichiers mis sous CVS, vous devrez à chaque fois
les mettre à jour, ce qui vous permet de partir de versions récentes de
ces fichiers. Pour mettre à jour votre répertoire de travail,
tapez :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs update turing
</pre>
<p class="continue">
Vous serez alors sûr d'avoir des fichiers à jour.
2005-09-16 00:48:08 +02:00
</p>
<p>
Vous pouvez aussi ne mettre à jour qu'un fichier, ou une liste de
fichiers :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs update <em>fichier1 fichier2 etc</em>
</pre>
<p>
Vous pouvez encore indiquer en ligne de commande quel répertoire mettre
à jour :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs update -d ~/programmation/turing-test
</pre>
<p>
Cette dernière commande peut être intégrée à un script, ce qui est très
pratique si vous voulez que les modifications soient prises en compte à
plusieurs endroits différents (par exemple, dans votre répertoire de
2005-09-16 00:48:08 +02:00
travail et sur votre page web, si vous avez mis votre page web
sous CVS).
2005-09-16 00:48:08 +02:00
</p>
<h3>Ajouter des fichiers</h3>
<p>
Un projet est rarement fixé dès sa première version ; aussi des
fichiers peuvent-ils s'ajouter aux fichiers intégrés à l'origine (avec
la commande <code>cvs import</code>), d'autres en être retirés.
2005-09-16 00:48:08 +02:00
</p>
<p>
Pour ajouter des fichiers, la façon de s'y prendre dépend de la nature
2005-09-16 00:48:08 +02:00
du fichier en question. En effet, si le fichier est un fichier binaire,
il ne sert à rien que CVS le lise ligne à ligne à chaque partage de
modifications pour vérifier s'il a changé ; tandis que s'il s'agit
d'un fichier texte, CVS est là pour ça.
2005-09-16 00:48:08 +02:00
</p>
<p>
Par conséquent, si c'est un <strong>fichier texte</strong> (un texte
2005-09-16 00:48:08 +02:00
simple, un script, le code source d'un programme, un fichier TeX, etc.),
tapez :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs add <em>fichier1 fichier2 etc</em>
</pre>
<p class="continue">
En revanche, si vous voulez <strong>ajouter un fichier binaire</strong>
(un fichier exécutable, un document PS, PDF, une image JPEG, PNG, etc.),
tapez :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs add -kb <em>fichier1 fichier2 etc</em>
</pre>
<p>
Vous pouvez <strong>vérifier le statut</strong> des fichiers (binaires
ou non) avec la commande :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs status <em>fichier</em>
</pre>
<p class="continue">
Lisez le champ « Sticky Options ». Si sa valeur est
« (none) », c'est que votre fichier n'est pas déclaré comme
binaire ; s'il vaut « -kb », c'est qu'il l'est.
2005-09-16 00:48:08 +02:00
</p>
<p>
Il arrive parfois que l'on oublie de déclarer comme binaires certains
2005-09-16 00:48:08 +02:00
fichiers, notamment lors de l'enregistrement du projet dans le
répertoire de dépôt CVS. Il n'est pas trop tard pour se
rattraper :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs update -kb <em>fichier1 fichier2 etc</em>
</pre>
<p class="continue">
Ce qui équivaut à la succession de commandes suivante :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs admin -kb <em>fichier1 fichier2 etc</em><br/>
<span class="prompt">bireme ~/turing-test $</span> cvs update <em>fichier1 fichier2 etc</em>
</pre>
<h3>Retirer des fichiers</h3>
<p>
Pour retirer des fichiers, utilisez la commande :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs remove <em>fichier1 fichier2 etc</em>
</pre>
<h3>Partager les modifications</h3>
<p>
Quand vous avez terminé vos modifications et que vous estimez que le
monde est prêt à les recevoir, partagez-les :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs commit
</pre>
<p class="continue">
Les modifications seront alors enregistrées dans le répertoire de dépôt.
2005-09-16 00:48:08 +02:00
</p>
<p>
Vous pouvez aussi ne partager qu'un fichier, ou une liste de
fichiers :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs commit <em>fichier1 fichier2 etc</em>
</pre>
2005-09-16 10:42:45 +02:00
<p>
Quand vous partagez vos modifications, un éditeur de texte s'ouvre et
vous demande de les commenter. Vous n'êtes pas obligé d'être bavard,
mais soyez relativement précis.
2005-09-16 10:42:45 +02:00
</p>
2005-09-16 00:48:08 +02:00
<h3>Nettoyer son répertoire de travail</h3>
2005-09-16 00:48:08 +02:00
<p>
Si vous ne contribuez qu'occasionnellement à tel ou tel projet, vous
2005-09-16 00:48:08 +02:00
pouvez vouloir ne pas conserver en permanence une version d'un projet
donné dans votre répertoire de travail. Pour vous en débarrasser, vous
avez bien sûr la possibilité d'effacer les fichiers d'une manière
« traditionnelle », au moyen de la commande
<code>rm</code>. Mais CVS propose un outil plus puissant :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs release -d turing
</pre>
<p>
Cette commande <strong>vérifie que vous avez bien partagé toutes vos
modifications avant d'effacer les fichiers de votre répertoire de
travail</strong>. Ceci vous épargne bien des migraines !
2005-09-16 00:48:08 +02:00
</p>
<p>
2005-09-16 10:06:05 +02:00
Si vous ne voulez pas effacer vos fichiers, mais simplement
<strong>vérifier qu'aucun fichier n'a été modifié sans être
partagé</strong>, tapez simplement :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs release turing
</pre>
<p class="continue">
Cette commande annule le <code>cvs checkout</code>.
</p>
<h2>Fonctionnalités avancées de CVS</h2>
2005-09-16 00:48:08 +02:00
<h3>Historique des modifications</h3>
<p>
CVS garde l'historique de toutes les modifications. Si vous voulez voir
l'historique complet, tapez :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs log
</pre>
<p>
Vous pouvez aussi ne consulter l'historique que d'un fichier, ou d'une
liste de fichiers :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs log <em>fichier1 fichier2 etc</em>
</pre>
<p>
Devant vos yeux ébahis s'affichera alors la liste de toutes les versions
de ces fichiers, accompagnées des commentaires déposés par les
2005-09-16 00:48:08 +02:00
contributeurs.
</p>
<h3>Comparer des versions</h3>
<p>
Vous voulez savoir précisément en quoi telle version d'un fichier
diffère de telle autre ; pour cela, tapez :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs diff -r 1.2 fichier
</pre>
<p>
Ainsi, vous pourrez comparer l'état actuel du fichier avec sa
version 1.2. Mais vous pouvez aussi comparer deux versions
quelconques :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs diff -r 1.1 -r 1.2 fichier
</pre>
<h3>Revenir sur des modifications</h3>
<p>
Oups ! Vous avez fait une erreur, et dans votre précipitation, vous
l'avez déjà partagée. Heureusement, CVS permet de revenir à des versions
antérieures. Tapez :
2005-09-16 00:48:08 +02:00
</p>
<pre>
<span class="prompt">bireme ~/turing-test $</span> cvs update -A fichier
<span class="prompt">bireme ~/turing-test $</span> rm fichier
<span class="prompt">bireme ~/turing-test $</span> cvs update -p -r1.1 fichier > fichier
<span class="prompt">bireme ~/turing-test $</span> cvs commit fichier
</pre>
<h3>Astuce : utiliser l'outil <code>make</code></h3>
2005-09-16 10:42:45 +02:00
<p>
Imaginons la situation suivante : vous avez un site web sur lequel
vous voulez travailler à l'aide de CVS. Vous avez donc un répertoire de
dépôt (par exemple <code>~/cvs/www</code>) et un répertoire de travail
2005-09-16 10:42:45 +02:00
(par exemple <code>~/cvs-travail/www</code>). Mais vous voulez aussi
mettre à jour le site en lui-même lorsque vous partagez des
modifications, et ce site est dans le répertoire <code>~/www</code>. Ce
répertoire ne peut pas être le même que pour le dépôt, car celui-ci
doit lui être exclusivement consacré ; et il ne peut pas non plus
être votre répertoire de travail, car la moindre modification (et
surtout la moindre erreur) serait immédiatement publiée...
2005-09-16 10:42:45 +02:00
</p>
<p>
Vous devrez donc taper, à chaque fois que vous voudrez partager vos
modifications, les lignes suivantes :
2005-09-16 10:42:45 +02:00
</p>
<pre>
<span class="prompt">bireme ~/cvs-travail/www $</span> cvs commit
<span class="prompt">bireme ~/cvs-travail/www $</span> cvs update -d ~/www
</pre>
<p class="continue">
Le problème, c'est que cette séquence de commandes sera toujours la même
2005-09-16 10:42:45 +02:00
et que vous risquerez toujours d'en oublier une sur les deux... Aussi
avez-vous la possibilité d'utiliser l'utilitaire <code>make</code>,
outil très puissant, notamment dans ces circonstances (il est très
utilisé par les programmeurs).
2005-09-16 10:42:45 +02:00
</p>
<p>
Commencez donc par <strong>éditer un fichier Makefile</strong> dans le répertoire souche
de votre projet dans le répertoire de travail ; dans notre exemple,
il s'agit de ~/cvs-travail/www. Dans ce fichier, écrivez :
2005-09-16 10:42:45 +02:00
</p>
<pre>
install:
cvs commit
cvs update -d /users/<em>ma_promo</em>/<em>ma_section</em>/<em>mon_login</em>/www
</pre>
<p>
Ensuite, ajoutez ce fichier Makefile au CVS :
2005-09-16 10:42:45 +02:00
</p>
<pre>
<span class="prompt">bireme ~/cvs-travail/www $</span> cvs add Makefile
</pre>
<p>
Et à partir de maintenant, au lieu de taper <code>cvs commit</code>
pour partager vos modifications, vous taperez simplement :
2005-09-16 10:42:45 +02:00
</p>
<pre>
<span class="prompt">bireme ~/cvs-travail/www $</span> make install
</pre>
<p class="continue">
et <code>make</code> se chargera de tout à votre place !
2005-09-16 10:42:45 +02:00
</p>
2005-09-16 00:48:08 +02:00
<p>
Vous êtes maintenant prêt à utiliser CVS. Sa puissance est telle que cet
2005-09-16 00:48:08 +02:00
outil est devenu l'un des standards incontournables. Profitez-en
bien !
2005-09-16 00:48:08 +02:00
</p>
<h2>Bibliographie</h2>
2002-12-20 18:38:42 +01:00
<p>
Vous pouvez accéder à la petite documentation rédigée par David Monniaux
2002-12-20 18:38:42 +01:00
<a href="doc-cvs.ps.gz">(au format <code>.ps.gz</code>)</a>.
</p>
<p>
La documentation officielle se trouve <a
href="http://www.cvshome.org/docs/manual/">là-bas</a>.
2002-12-20 18:38:42 +01:00
</p>
<div class="metainformation">
Auteurs : Baptiste Mélès, Joël Riou. <date value="from git" />
2002-12-20 18:38:42 +01:00
</div>
</body>
</html>