Installation et utilisation des clients CVS

Ce document a pour objectif de :

• présenter rapidement l'outil de gestion de version CVS ;
• présenter les programmes clients associés à CVS ;
• aider à l'installation et à la configuration des clients ;
• expliquer les opérations classiques ;
• expliquer quelques opérations plus complexes.

Note de l'auteur : pour l'instant, seul CVS et le client WinCVS seront expliqués dans ce document. Il sera mis à jour plus tard pour intégrer un client alternatif TortoiseCVS.

CVS, versionning, gestion de version, update, commit, tag, projet, logiciel, conflit.

Le site de CVS : https://www.cvshome.org/https://www.cvshome.org/

Le site de WinCVS : http://www.wincvs.org/http://www.wincvs.org/

Le site de TortoiseCVS : http://www.tortoisecvs.org/http://www.tortoisecvs.org/

CVS (Concurrent Versions System) est un logiciel permettant de travailler à plusieurs de manière concurrente sur un projet. Son principe est simple : les utilisateurs travaillent sur une copie locale du projet et ajoutent les modifications au Repository, le répertoire qui contient toutes les versions de tous les fichiers du projet.

CVS est un logiciel libre et gratuit, distribué sous licence GNU GPL. Il est disponible sous GNU/Linux, Unix, et Windows.

• Travailler à plusieurs sur le même projet.
• Travailler à plusieurs sur le même fichier (par exemple sur des fonctions différentes).
• Fusion automatique des modifications (sans conflit).
• Consulter l'historique des modifications d'un fichier (qui a fait quoi, quand, dans quelle version ?).
• Consulter les différences entre deux versions d'un fichier.
• Récupérer n'importe quelle version d'un projet ou d'un fichier.
• Gérer différentes versions d'un projet (par des branches).

Le Repository désigne le système logique où sont archivés les fichiers des différents projets, ainsi que les informations relatives à chaque version.

Nom caractérisant un projet/sous-projet disponible sur le serveur CVS.

La commande update permet de synchroniser votre copie locale (working copy) avec le repository. Il s'agit de prendre en compte dans votre copie locale les modifications que d'autres ont pu valider entre-temps dans le repository.

La commande commit permet de mettre à jour le Repository avec les modifications faites en local.

La commande checkout permet d'obtenir une copie locale (working copy) de la version la plus récente des fichiers du module dans votre répertoire courant

Add est une commande qui permet d'ajouter des éléments. Elle est purement locale et n'a pas d'incidence immédiate sur le repository. Elle est généralement suivie d'une commit pour que la synchronisation avec le repository soit faite.

Pour indiquer qu'un ou plusieurs fichiers ne doivent plus être pris en compte dans le repository. Attention, remove est, comme add, une commande purement locale, on ne peut donc pas se passer du commit qui suit.

À certaines étapes du développement, il est utile de poser un jalon qui permettra, plus tard, de retrouver l'ensemble des fichiers figés dans un état précis (en terme de version). Ceci correspond à créer une livraison. Une livraison est créée en posant un tag (ou identificateur de livraison).

Cette commande est en quelque sorte l'inverse de import : elle fournit une copie de distribution et donne la même chose que checkout, mais sans les informations de gestion interne de CVS. Cette copie n'est donc pas destinée à être modifiée.

Cette commande permet d'importer un nouveau projet dans le repository. C'est la première opération à effectuer pour initialiser un projet.

CVS mémorise chaque version successive d'un même fichier. On peut retrouver une version précise d'un fichier grâce à son numéro de version. Les numéros de versions des fichiers (et leurs contenus) sont gérés implicitement par CVS. Ce sont des numéros du genre 1.1 ou 2.1.3.4. À chaque commit d'un fichier une nouvelle version est créée (seulement si le fichier a été réellement modifié). Par défaut les commandes d'extraction checkout et export donnent la version la plus récente d'un fichier.

En général, on ne manipule pas un fichier individuellement, mais plutôt l'ensemble des fichiers constituant un projet. Pour cela, CVS permet de gérer les livraisons successives d'un même projet. Une livraison est identifiée par un tag du genre appli_v1_0 qui doit être posé explicitement avec la commande tag. Une livraison est un ensemble de couples (fichier, numéro de version). Les différents fichiers d'une livraison n'ont pas forcément le même numéro de version. Par exemple la livraison appli_v1_0 pourrait correspondre aux fichiers « util.h, 1.1 », « util.c, 1.3 » et « main.c, 1.2 ». Un tag devrait avoir une forme standard définie clairement par l'équipe projet. Par défaut les commandes d'extraction checkout et export donnent la livraison la plus récente.

La version de tête désigne la version la plus récente dans le tronc principal d'un projet.

Il est parfois utile de vouloir bloquer un fichier à une révision particulière (ancienne) dans sa copie locale, sans qu'il soit remplacé par une version plus récente. Cette opération s'appelle mettre un TAG collant sur un fichier. Un update classique ne modifiera jamais ce fichier. Pour supprimer un TAG collant, il faut demander un update en cochant « Remove any sticky TAG ».

Le fichier d'installation de la dernière version de WinCVS se trouve à cette adresse : http://sourceforge.net/project/showfiles.php?group_id=10072&package_id=12664http://sourceforge.net/project/showfiles.php?group_id=100727&package_id=12664

Seule exception, pour Windows 95, il faut utiliser celui-ci : http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip?downloadhttp://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip?download

Utiliser les options d'installation par défaut (Full installation, Create contextual menu)

Le fichier d'installation de la dernière version de Tortoise se trouve à cette adresse : http://www.tortoisecvs.org/download.shtmlhttp://www.tortoisecvs.org/download.shtml

Suit une illustration du Menu Admin > Preference, onglet par onglet

Onglet General

Onglet Globals

Onglet CVS Setup

Onglet WinCVS

En travaillant avec WinCVS, il est intéressant d'avoir une vue rapide des fichiers nouveaux et modifiés en local depuis le dernier commit. Pour cela, voici les quelques options à activer :

View > File Filter > Show all commitable files only : permet de ne voir que les fichiers « commitable », ceux qui ont été modifiés par rapport au repository ;

View > File Filter > Show Missing only : permet d'afficher les fichiers effacés en local, mais encore présents dans le répository. Cette vue permet de vérifier qu'un fichier n'a pas été effacé par erreur dans la copie locale ;

View > File Filter > Show Unknown only : affiche les fichiers inconnus de CVS, qui ne sont pas dans le repository. Cela représente éventuellement des fichiers nouveaux à intégrer au repository.

Note : il est aussi possible de masquer à l'affichage certains types de fichiers par extension, ou des répertoires, à l'aide de la commande CVSIGNORE.

Menu > View > Flat view : permet d'avoir une vue récursive du répertoire courant, c'est-à-dire incluant les fichiers de tous les sous répertoires.

Nous admettrons que WinCVS est en cours d'exécution.
La plupart des commandes du menu sont disponibles en cliquant simplement sur le bouton droit de la souris après avoir sélectionné un élément.

VII-A-1. Connexion au serveur CVS - Login▲

VII-A-2. Déconnexion du serveur CVS - Logout▲

VII-A-3. Importer un projet - Import▲

No conflicts created by this import
***** CVS exited normally with code 0 *****

VII-A-4. Obtenir une copie locale d'un projet - Checkout▲

VII-A-5. Mettre à jour sa copie locale - Update▲

VII-A-6. Archiver - Commit▲

Objectif : archiver des modifications faites en local.
Prérequis : disposer d'une version du projet dans le repository, et d'une copie locale modifiée.

Généralement, avant tout commit, il est important de faire un update avant pour s'assurer d'avoir la dernière version en cours. Dans WinCVS, les fichiers modifiés en local apparaissent en rouge avec un état « modified ».

Pour intégrer ces modifications dans le repository, il suffit de sélectionner un élément (généralement le répertoire racine) et de lancer la commande commit.

Menu > Modify > Commit

Onglet Commit settings : Log message : Entrer le commentaire associé aux modifications effectuées. Confirmer par OK.

Les modifications vont être intégrées au repository. Le numéro de révision des fichiers modifiés sera incrémenté d'une unité.

VII-A-7. Obtenir une synthèse des versions d'un fichier - Log & Graph▲

----------------------------
Revision : 1.21
Date : 2005/5/25 21:7:58
Author : 'trident'
State : 'Exp'
Lines : +5 -3
Description :
Added Conditional defines option
Fixed parsing of conditional defines inside source code
Fixed parsing error on an ELSEIF directive (Tracker 1203034)
----------------------------
Revision : 1.20
Date : 2005/4/25 21:38:27
Author : 'trident'
State : 'Exp'
Lines : +4 -2
Description :
Fixed Library issue (memory leak)
Added a new nice wizard
Added list of include and exclude files/folders in project configuration (Tracker
971492)

VII-A-8. Ajouter des éléments - Add▲

Objectif : ajouter des éléments au repository.
Prérequis : disposer d'une version du projet dans le repository, d'une copie locale et de nouveaux éléments, fichier(s) et/ou dossier(s).

Si les fichiers à ajouter sont dans un nouveau répertoire, il faut d'abord ajouter le répertoire au repository, et ensuite les fichiers.

Nouveau fichier

Dans WinCVS, le nouveau fichier sera marqué comme « Unknown »

Sélectionner le fichier, puis Menu > Modify > Add selection Si le fichier est de type binaire, il est préférable d'utiliser « Add binary ». Dans le cas d'un fichier unicode, utiliser « Add Unicode ».
Le fichier est maintenant marqué comme « Modified » avec une icône « A » pour Added.

Pour l'intégrer définitivement au repository, il faut lancer la commande commit.

Nouveau répertoire

Dans WinCVS, le nouveau répertoire aura une icône non cochée. Cela indique qu'il n'appartient pas au repository. Sélectionner le répertoire. Menu > Modify > Add selection

Le répertoire est maintenant marqué avec une coche, et sera donc inclus dans le repository.
Il est maintenant possible d'ajouter les nouveaux fichiers du répertoire comme indiqué plus haut.

VII-A-9. Supprimer des fichiers - Delete▲

Objectif : supprimer un élément du projet dans le repository Prérequis : Disposer d'une version du projet dans le repository, d'une copie locale, et d'un élément à effacer.

Le fichier ne sera pas vraiment effacé du repository, mais marqué comme tel dans les révisions suivantes.
Ainsi, il sera toujours possible de récupérer une version ancienne avec ce fichier.

Sélectionner l'élément à supprimer.
Menu > Modify > Remove

Le fichier est alors noté en rouge avec comme état « Removed ».

Le fichier sera marqué comme effacé dans le repository lors du prochain commit.
Note : si l'élément a déjà été physiquement effacé du répertoire de travail, il sera toujours présent dans la liste, mais noté comme « missing ». La procédure pour l'effacer du repository reste la même.

VII-A-10. Marquer une livraison - Tag▲

VII-A-11. Voir les différences entre deux versions - Diff▲

VII-A-12. Résoudre les conflits - Conflict▲

Objectif : changer le nom d'un répertoire déjà archivé.
Prérequis : disposer d'une version du projet dans le repository et d'un répertoire.

Aujourd'hui, avec la version actuelle de CVS, il n'est pas possible de renommer directement un répertoire et d'en garder l'historique. Cette opération se résume donc à une suppression du répertoire actuel (remove), suivie de la création du nouveau répertoire (add). L'historique n'est pas gardé comme on le voudrait, mais il est toujours possible de récupérer une ancienne version.

Objectif : Changer le nom d'un fichier déjà archivé.Prérequis : Disposer d'une version du projet dans le repository et d'un fichier.

Comme pour les répertoires, il n'est pas possible avec la version actuelle de CVS de renommer directement un fichier. Il faut donc supprimer le fichier actuel (remove) puis ajouter le fichier avec le nouveau nom (add).
L'historique n'est pas gardé comme on le voudrait, mais il est toujours possible de récupérer une ancienne version.

Objectif : obtenir une version livrable d'un module.
Prérequis : disposer d'une version du projet dans le repository.

Le terme « copie propre » signifie en fait une copie sans données d'archivage.
Un checkout sert à avoir une copie locale de travail, donc avec les répertoires CVS, un export sert à livrer une version sans ces répertoires CVS.

Objectif : voir ce que donnerait une commande Update sans la lancer.Prérequis : Disposer d'une version du projet dans le repository.

L'intérêt de simuler un Update sans le réaliser permet de ne pas modifier les fichiers en local. Sélectionner le répertoire ou le module impacté, puis Menu > Query > Query Update

Le résultat est visible dans la fenêtre de messages :

cvs -n update -P (in directory D:\Projets\Ex\DelphiCodeToDoc\Test\)
? .cvsignore
? TestCases.todo
? UnitaryTests
? TestCases/WarnWhenEmptyTag/WarnWhenEmptyTAG.out
cvs update: Updating .
cvs update: Updating IntegrationTests
A IntegrationTests/ThingsAfterEnd.pas
cvs update: Updating IntegrationTests/DotNETSyntax
A IntegrationTests/DotNETSyntax/DelphiNetClass.pas
cvs update: Updating IntegrationTests/Options
cvs update: Updating IntegrationTests/Tags
cvs update: Updating TestCases

Les répertoires et fichiers sont scannés, préfixés du code lettre correspondant. Voir Annexe CODE_LETTRE

Objectif : créer une version en parallèle du tronc commun .
Prérequis : disposer d'une version du projet dans le repository.

À venir …

Objectif : récupérer une version spécifique en local.
Prérequis : disposer d'une version du projet dans le repository et d'une branche existante.

À venir …

Objectif : fusionner les modifications de deux versions.
Prérequis : disposer de deux versions d'un module dans le repository.

À venir …

Objectif : fusionner les modifications de plusieurs versions.Prérequis : Disposer de plusieurs versions d'un module dans le repository.

À venir …

Objectif : gérer la modification des fichiers.
Prérequis : disposer d'une version du projet dans le repository.

Généralement, lors d'un checkout ou après un commit, les fichiers du module passent en lecture-seule. Il faut donc demander pour chaque fichier à passer en lecture-écriture . Cette méthode permet de verrouiller les fichiers qui n'ont pas à évoluer et d'éviter une modification accidentelle.

Pour modifier l'attribut de lecture-seule d'un fichier, il existe deux méthodes :

• dans WinCVS par la commande Edit ;
• dans l'explorateur ou tout autre éditeur.
• Par WinCVS, cette commande permet de notifier au serveur CVS qu'une personne édite ce fichier, et permet de voir la liste des éditeurs par exemple.
• Par l'explorateur, le serveur CVS ne sera pas au courant de la modification du fichier, et ne pourra donner d'information à ce sujet.

Conseil d'utilisation : il est recommandé de n'utiliser que la commande Reserved Edit pour certains types de fichiers. La commande Edit ne présente pas forcément davantage dans le cas de fichier texte mergeable.

Objectif : gérer la réservation des fichiers.
Prérequis : disposer d'une version du projet dans le repository.

Il est parfois utile de savoir si une personne édite un fichier avant de l'éditer soi-même. Dans le cas des fichiers binaires, cette information est vitale pour éviter des conflits difficiles à gérer. Une des solutions est donc d'utiliser la commande d'édition réservée. Cette commande vérifie si une personne a déjà demandé une édition, par un Edit ou Reserved Edit, et autorise la modification dans le cas contraire.

Menu > Trace > Reserved Edit

Si un fichier est déjà en cours d'édition, CVS renverra une erreur en donnant des informations sur l'éditeur, comme le nom, la date et l'heure de la demande d'édition :

cvs edit -c "Serveur.doc" (in directory D:\PreDev\WinCVS\DocumentsOutils\)
Serveur.doc trident Tue Oct 5 13:24:32 2004 GMT pc-dev
D:\PreDev\WinCVS\Copie de DocumentsOutils
cvs [edit aborted]: Files being edited!
***** CVS exited normally with code 1 *****

Objectif : voir ce que donnerait une commande Update sans la lancer.
Prérequis : disposer d'une version du projet dans le repository.

À venir …

Objectif : masquer des fichiers dans l'explorateur de WinCVS.Prérequis : Disposer d'une version du projet dans le repository.

Objectif : voir ce que donnerait une commande Update sans la lancer.
Prérequis : disposer d'une version du projet dans le repository.

Objectif : voir ce que donnerait une commande Update sans la lancer.
Prérequis : disposer d'une version du projet dans le repository.

L'utilisation la plus commune de CVS est d'archiver des fichiers texte. Avec ce genre de fichiers, CVS peut fusionner des révisions, afficher les différences entre les révisions visuellement. Cependant CVS a aussi la capacité d'archiver les fichiers binaires. Par exemple, on pourrait archiver dans CVS un site Web comprenant des fichiers texte et des images binaires.

IX-B-1. Le problème des fichiers binaires▲

IX-B-2. Travailler avec les fichiers binaires▲