Communiquez avec le SVN

Eh oui, il faut d'abord comprendre tous les messages que nous envoie SVN avant d'agir !

Des informations qui viennent à nous

Presque tout le temps en fait. Vous l'avez déjà remarqué, quand vous faites un Checkout, un Update, un Commit ou un Export, à chaque fois, que ce soit sous UNIX ou sous Windows, SVN vous donne des informations sur l'action en cours. Nous allons maintenant étudier ces informations.

Code : Bash



Le message est beaucoup plus compréhensible sur la fenêtre tortoiseSVN, on comprend bien que l'on est à la cinquième révision (version) et que cinq fichiers et dossiers ont été ajoutés.
On comprend donc également qu'en ligne de commande, un 'A' dans la première colonne signifie Added (Ajouté).

Comme dit précédemment, on retrouve ces fenêtres lors d'une action de modification sur le serveur (commit, update, add ou autre). Bien sûr, il y a un code complet (eh oui, on ne fait pas qu'ajouter des éléments ).

Aller chercher ces informations

Pour comprendre tout ce que l'on va pouvoir trouver, on va utiliser la commande "status".
Cette commande permet, étrangement, d'obtenir le statut des fichiers et dossiers.

Pour utiliser la commande, vous allez donc taper :
Code : Bash
Et là, si vous n'avez rien touché depuis votre dernier update, vous devriez ne trouver... RIEN. Déception...

Il faut en fait ajouter quelques options :
-u pour comparer son Working Copy (sa copie locale) avec le repository,
-v pour afficher tous les éléments (même ceux qui n'ont pas été modifiés).
Il faut comprendre que status vous fait un bilan des modifications qu'ont subies vos éléments, il va seulement vous afficher les éléments qu'il est utile de montrer. Par défaut, il ne va donc pas montrer les éléments qui n'ont pas été modifiés.

Reprenons la commande avec les options -uv :
Code : Bash
On obtient ici, grâce au -v (pour verbose), le détail de tous les dossiers et fichiers dans l'arborescence à partir du dossier choisi.
Le premier chiffre que l'on voit est celui de la version globale de l'élément (du dernier update fait sur l'élément), le deuxième est la version de l'élément (combien de fois il a été modifié). "Fichier 1.txt" a donc été modifié deux fois depuis le début, mais il a déjà "traversé" cinq versions (où d'autres fichiers ont été commités).

Bien comprendre les informations

Cet espace libre est là pour les informations en cas de modification. Allons donc voir la documentation (ça doit devenir un réflexe).
Code : Bash
Secret (cliquez pour afficher)

Que faut-il comprendre de ce manuel ? Il y a énormément d'informations, je ne vais donc en traiter qu'une partie (rassurez-vous ce sera déjà amplement suffisant).

Premièrement, on voit la différence entre l'appel sans argument, avec -u et/ou avec -v :

• sans argument : il ne montre que les éléments modifiés depuis le dernier update,
• -u : il compare les éléments avec ceux sur le serveur (connexion avec le serveur nécessaire, SVN n'est pas devin),
• -v : il affiche toutes les informations, même pour les éléments non modifiés.

Ensuite sont présentées les valeurs que peuvent prendre chacune des huit premières colonnes. Nous n'allons nous intéresser qu'à trois d'entre elles : la première, la septième et la huitième.
Commençons par la plus simple : la septième est toujours vide, c'est juste un espace.

Continuons un peu plus sérieusement. La première colonne présente les modifications apportées localement aux éléments :

• ' ' : aucune modification,
• A : ajouté,
• D : supprimé,
• C : en conflit,
• I : ignoré,
• M : modifié,
• R : remplacé,
• ? : non-versionné,
• ! : manquant.

La huitième colonne, quant à elle, présente l'état de l'élément sur le serveur par rapport à notre version (cette colonne n'apparaît que si on active -u) :

• ' ' : aucune nouvelle version sur le serveur (votre fichier est à jour),
• '*' : une nouvelle version est disponible sur le serveur.

On comprend donc vite d'après ces définitions qu'obtenir la ligne suivante n'est pas très bon signe :
Code : Bash
On est ici dans le cas d'un éventuel futur conflit. Etant donné que l'on a modifié le fichier depuis sa récupération, mais qu'une autre version a été envoyée au serveur, si on envoie notre version, le serveur devra supprimer celle anciennement commitée et les modifications apportées par l'autre personne ne seront plus. Ceci ne peut bien sûr pas être un comportement par défaut. Le serveur va refuser votre commit. Il va donc falloir résoudre le problème localement avant de commiter la solution.

Et pour Windows...

Eh bien pour Windows, c'est pareil, mais en plus lisible. En effet toutes ces informations sont récupérables via l'interface graphique.
Clic droit >> TortoiseSVN >> Check for Modifications.
On obtient un tableau, sauf que tout est écrit entièrement (et non pas par abréviation), donc beaucoup plus simple.


On retrouve ici les champs que l'on pouvait trouver dans les huit colonnes sous UNIX. Comme on peut le voir tout est écrit. Petit luxe, on a même un résumé du nombre de fichiers dans chaque catégorie ainsi que le numéro des versions maximum et minimum.


Tout simplement parce que, lors du commit, je n'ai pas commité le dossier racine (Tuto SdZ) mais seulement le fichier. SVN a donc modifié les propriétés du fichier (sa version), mais pas celle du reste (du dossier racine par exemple). Cela fonctionne de la même façon sous UNIX. N'hésitez donc pas à faire régulièrement des update sur la racine.

Enfin, on ne le voit pas bien sur mon exemple, mais il y a un code de couleurs pour les éléments.

• Bleu : élement modifié localement.
• Violet : élément ajouté.
• Rouge foncé : élément manquant.
• Vert : élément modifié localement et sur le serveur. Ils seront mergés lors d'un update, ou alors ils génèreront un conflit.
• Rouge clair : élément modifié localement et supprimé sur le serveur, ou inversement. Il y aura forcément un conflit lors de l'update.
• Noir : aucun changement, ou fichier non versionné.

Nous allons voir ici quels sont les moyens d'obtenir encore plus d'informations.

Nous venons de voir, dans la première partie, que si nous voulions des informations sur l'état des éléments présents sur notre répertoire local par rapport au serveur, il fallait utiliser la commande "status". Mais il existe d'autres commandes pour obtenir d'autres informations. Pour vous en convaincre et obtenir une liste de toutes les commandes accessibles :
Code : Bash
Code : Bash

Dans cette liste, vous reconnaissez les commandes que l'on a déjà utilisées :
add, checkout, commit, copy, delete, export, help, mkdir, move, status, update.
Et celles que l'on n'a pas encore vues :
blame, cat, cleanup, diff, import, info, list, lock, log, merge, prop*, resolved, revert, switch, unlock.

Ici, nous allons voir list, log, info et cat.

Cat et List

Ces deux commandes sont très simples, elles font la même chose qu'en shell...

Cat

Cat permet d'afficher le contenu d'un fichier :
Code : Bash
Pour l'afficher, il faut préciser un fichier ou bien une URL si le fichier ne se trouve pas sur notre répertoire local. Comme il faut accéder au serveur, il est possible (si on ne les a pas gardés dans le cache) de renseigner son login et mot de passe. Il reste une nouvelle option que nous allons voir, la possibilité de préciser dans quelle version (révision) on souhaite voir le fichier. Cette version peut être demandée de diverses façons :

• par le numéro de la version si on le connaît (1, 2, 13, 40...),
• en utilisant {DATE} : la date entre accolades pour avoir la plus récente des versions disponibles de l'instant,
• avec HEAD : la dernière version en date dans le repository (sur le serveur),
• grâce à BASE : la version du dernier update fait sur la Working Copy (BASE sera utile par la suite lorsqu'on voudra comparer deux versions),
• avec COMMITTED : la dernière version pour laquelle un commit a été effectué (mais inférieure ou égale à la version de la copie locale),
• enfin avec PREV, pour la version juste avant COMMITTED.

List (ls)

List permet, comme en shell, de lister le contenu d'un répertoire. Et bien sûr, comme pour cat, on a des options en plus :
Code : Bash
Dans ces options, on retrouve :

• le dossier cible s'il est différent du dossier dans lequel on se trouve,
• la révision si on veut un aperçu des fichiers à une autre version,
• le login et le mot de passe pour l'accès au serveur,
• le -v (pour verbose) que nous avons déjà rencontré avec status et qui permet d'afficher toutes les informations sur les éléments.

Il reste le -R que je n'ai pas encore présenté. Il permet, tout simplement, de descendre récursivement l'arborescence à partir du dossier choisi (c'est la même option en shell, pour vous en convaincre essayez : 'man ls | grep -e -R'). Cette option est donc très utile si vous voulez obtenir la liste de tous les éléments disponibles dans une arborescence sans avoir à faire "svn ls" sur tous les sous-dossiers.

Et pour Windows

Eh bien, cat et list n'ont pas vraiment lieu d'être étant donné que l'on utilise une interface graphique. Cependant, il est utile de pouvoir consulter l'état du repository aux différentes versions. Pour ça, on trouve le "Repository Browser".
Clic droit >> TortoiseSVN >> Repo-browser :

Info

La commande info vous donne... des informations.
Nous allons donc voir les informations que l'on peut obtenir.
Comme vous devriez en prendre l'habitude, on tape :
Code : Bash
Et on obtient le manuel d'utilisation de la commande. De ce manuel, on déduit que la commande se lance de la façon suivante :
Code : Bash
Eh oui, plus on avance, et plus je présente d'options !
Alors, dans toutes ces options vous connaissez déjà : Target (fichier, dossier ou URL cible), -r (révision), -R (Récursif), --username (login) et --password (mot de passe).
Nous avons un petit nouveau qui s'invite : --target. Cette option est un peu... bizarre, spéciale. Elle permet de spécifier un fichier qui contient des liens vers d'autres fichiers, fichiers que vous voulez ajouter en argument de la commande.
Pas très bien compris...
Un petit exemple et tout va rentrer dans l'ordre.

Je lance le code suivant :
Code : Bash
Avec comme fichier argInfo :
Code : Autre
Et j'obtiens comme résultat :
Code : Bash
On remarque que les fichiers indiqués dans le fichier target on été pris en compte (voici donc l'utilité de cette option).


Intéressons-nous maintenant au contenu du résultat obtenu.

• Path : donne le chemin vers l'élément.
• Name : nom du fichier (uniquement pour les fichiers).
• URL : donne l'URL de l'élément sur le serveur.
• Repository Root : donne l'URL de la racine du repository.
• Repository UUID : IDentifiant Universellement Unique du repository (tout ce dont vous devez vous rappeler est qu'il s'agit d'un identifiant unique, nous verrons son utilité dans l'utilisation avancée de SVN).
• Revision : version de l'élément.
• Node Kind : type de l'élément.
• Schedule : prévision pour l'élément (il est possible de donner des prévisions de ce que l'on va faire à l'élément).
• Last Changed Author : dernière personne à l'avoir modifié (commité).
• Last Changed Rev : dernière version à laquelle l'élément a été modifié.
• Last Changed Date : dernière date à laquelle l'élément a été modifié.
• Text Last Updated : dernier update du fichier effectué (par notre working copy).
• Checksum : somme de contrôle pour vérifier la validité des données. Comprenez bien que le contrôle effectué par un checksum n'est pas une garantie de la validité des données (si vous voulez comprendre le fonctionnement d'une somme de contrôle : http://fr.wikipedia.org/wiki/Checksum et http://en.wikipedia.org/wiki/Checksum).

Log

Voici la commande la plus importante de toutes (ou tout du moins celle que vous devriez utiliser le plus souvent). Log permet d'afficher les messages de log laissés.
Pour apprendre à utiliser la commande, comme ce devrait devenir une habitude, on regarde le manuel :
Code : Bash
Le manuel nous informe que l'utilisation de la commande se fait comme suit :
Code : Bash
Dans ces options, nous n'avons pas vu --limit et -r Revision qui cette fois-ci ne s'utilisent pas de la même façon.

Commençons par -r Revision. Cette fois, on ne demande pas une révision, mais un ensemble de révisions. À la place de faire -r rev, il faut faire -r Rev1:Rev2 avec Rev1 la révision de laquelle on part, et Rev2 la révision à laquelle on veut arriver.
Par défaut, si rien n'est précisé, les révisions affichées seront BASE:1, ce qui signifie de la version actuellement sur la Working Copy à la première version.



--limit nb_dentré_max, quant à lui, informe du nombre maximum de messages de log à afficher. --limit 10 dit au SVN qu'on ne veut au maximum que 10 messages de log affichés (s'il y en a moins, il en affichera moins).

Eh bien... NON !
Bon, j'en fais peut-être un peu trop là...

Mais pourquoi non ? Eh bien pour vous convaincre, prenons un exemple. Si je demande les messages de log d'un sous-dossier seulement et non plus du dossier racine. Rien ne dit qu'à chaque fois que quelqu'un aura fait un commit il aura modifié des choses dans ce dossier. Et justement, pour ces versions où rien n'aura été modifié dans le dossier, la commande log ne va pas afficher le log. Il en découle que, même si vous demandez les logs pour les versions allant de 1 à 100 d'un élément, il se peut très bien que SVN ne vous affiche que quelques logs.

Maintenant que nous savons comment s'en servir, utilisons-la (je suis dans le dossier racine) :
Code : Bash

On trouve comme informations :

• le numéro de version ;
• l'auteur du commit ;
• la date du commit (notez comment les dates sont affichées, c'est le même format qu'il faut utiliser pour renseigner une date avec -r) ;
• le nombre de lignes du commentaire ;
• et plus bas, le commentaire lui même ;
• puis une ligne de '-' pour délimiter l'autre message de log.

Voici un autre exemple de log :
Code : Bash
On voit bien ici ce que je disais plus haut : bien que je demande d'afficher toutes les versions (BASE:1), le Dossier 2 n'a été modifié qu'aux 1^ère et 12^ème révisions. Seules ces deux versions sont affichées. On notera aussi que le verbose (-v) nous affiche en plus les informations sur les actions effectuées.

Et pour Windows

La fenêtre de log avec TortoiseSVN est accessible de diverses manières. La plus standard est :
clic droit >> TortoiseSVN >> Show log

La façon la plus utilisée est : suite à un update, cliquez sur le bouton "Show log...".

Quelle que soit la manière, on obtient la fenêtre suivante :



Cette fenêtre, amis zéro, est une véritable mine d'informations.
Regardons d'abord les boutons. On voit que l'on peut sélectionner les dates de départ et de fin pour l'affichage des logs (comme pour -r {DATE} en fait), mais aussi que l'on peut tout afficher ("Show All"), ou seulement les 100 logs suivants, ou encore uniquement un ensemble de révisions ("Show Range...", appuyez sur la petite flèche à droite de "Show All"), et que l'on peut enfin rafraîchir la fenêtre. Notons la barre de recherche en haut à droite, très bien faite, elle permet d'effectuer une recherche sur le champ de votre choix (cliquez sur la loupe pour voir) et accepte les expressions régulières.
Enfin, le bouton "help" donne accès à l'aide de TortoiseSVN pour le log (cette aide est EXTRÊMEMENT bien faite, n'hésitez pas à la consulter) et le bouton "statistic" vous affichera des graphiques sur le nombre de commits par login et par date.

On voit aussi trois "check boxes", tout ce que vous avez besoin de savoir est que "stop on copy/rename" ne va afficher les logs de l'élément demandé que jusqu'à ce qu'il ait été copié ou renommé (mais ne va pas chercher les logs du fichier copié ou avant qu'il ait été renommé).

Maintenant passons au plus important. Les trois champs centraux :

• le premier affiche un résumé de tous les logs demandés,
• le deuxième affiche le commentaire de la version sélectionnée dans le premier champ,
• le troisième affiche les actions qui ont eu lieu lors de la version sélectionnée dans le premier champ.

Pas grand chose à dire sur le deuxième et le troisième champ. En revanche, le premier champ offre un résumé assez complet et disponible en un rapide coup d'oeil. Analysons colonne par colonne.

• La première colonne donne le numéro de la version.
• La deuxième donne un aperçu des actions qui ont eu lieu.
  Un fichier avec un '!' signifie qu'un fichier (au moins) a été modifié.
  Un fichier avec un '+' signifie qu'un fichier (au moins) a été ajouté.
  Un fichier avec un 'x' signifie qu'un fichier (au moins) a été supprimé.
  En réalité, il y a une quatrième icône mais on ne va pas la voir maintenant. Si vous êtes curieux la doc est par là. ==>
• La troisième donne l'auteur du commit.
• La quatrième donne la date du commit.
• La cinquième enfin donne le commentaire du commit (mais sans afficher les retours chariots).

Vous voyez bien qu'avec ce premier tableau, vous obtenez déjà un très bon résumé des changements ayant eu lieu lors du commit.