Aujourd’hui, place à un billet invité. C’est mon ami Grégory Soutadé qui propose un petit tutoriel pour apprendre à utiliser les différentes commandes de GIT, le gestionnaire de versions, pour un usage personnel. J’ai modestement aidé à la rédaction et mise en forme de ce document que vous trouverez très bientôt au format PDF.

Vous vous lancez dans un petit projet perso ? Vous aurez toutes les clés en main pour que GIT soit votre gestionnaire de versions sur ce projet.

Cet article ne se veut pas exhaustif mais reflète le résultat d’un usage quotidien par un autodidacte. Si vous souhaitez corriger une éventuelle erreur ou partager une connaissance, n’hésitez pas à laisser un commentaire.
Il est recommandé pour la bonne compréhension de cet article de connaitre SVN.
L’auteur du tutoriel est un utilisateur Linux et certaines commandes peuvent poser problème sur d’autres système (notamment gitk).

Note à nos amis sous Windows: vous pouvez utiliser git sur Windows à l’aide de msysgit disponible ici.

Tout d’abord qu’est ce que git ?! Et bien avant d’être un logiciel de gestion de versions décentralisé (ou DSCM pour Distributed Source Code Management) il a été conçu comme un système de fichiers avec un système de versionning, le tout construit pour la performance. Et quoi de plus normal quand on sait qu’il était destiné à être le système de gestion de versions du noyau Linux en remplacement de BitKeeper. Git a été écrit par Junio Hamano et Linus Torvald lui même. Bref on a entre les mains un gros bébé, pourtant simple à utiliser et performant : tout est instantané !
On entend par décentralisé le fait de pouvoir « commiter » et faire évoluer un bout de code en local indépendamment d’un serveur central (contrairement à svn qui nécessite un serveur central), cela offre un confort de développement très important car on ne commite que ce qui marche VRAIMENT. Bien sûr on a tout le loisir de travailler avec un serveur central, il est même possible de faire des ponts avec un serveur svn, mais l’aspect collaboratif ne sera pas abordé ici.

Comme pour svn, chaque commit donne lieu à une nouvelle version (ou révision). Git a choisit non pas d’utiliser des numéros de révision, mais un identifiant unique SHA-1 pour chaque commit (donc révision). Cela évite d’avoir des conflits entre les différentes révisions de toutes les branches de tous les clones du dépôt. Il n’est pas toujours nécessaire d’indiquer le SHA-1 complet d’un objet, mais seulement les premiers octets qui le différencie des autres objets. Si j’ai deux commits :
3bdc6feaa01b6b86a0f94acab32bc3ad4c207a5d
3bdc4d695b90545c891392a486da9a9e07c053b
je peux identifier le premier avec 3bdc6 et le second avec 3bdc4

Chaque commande git peut être appelée de deux manières différentes :

git commande

Après ces petites notions théoriques passons à la pratique !!

Par où qu’on commence ?

Et bien pour commencer il faut initialiser ou récupérer un dépôt. Avant d’initialiser un dépôt il faut renseigner quelques variables permettant de vous identifier lors des commit. Donc :

git config –global user.name Grégory
git config –global user.email greg@wordpress.com
git config –global core.editor emacs
mkdir MonDepot
cd MonDepot
git init

L’avant dernière ligne est importante si vous ne savez/voulez pas utiliser vim comme éditeur de messages lors des commits. Un joli fichier ~/.gitconfig contiendra votre configuration pour les projets suivants. Si vous omettez le –global, les informations ne seront inscrites que pour le dépôt crée.

Il est aussi possible de récupérer un dépôt git déjà existant depuis : ssh, système de fichier local, internet (http://, ftp://, git://) :

git clone soutade@monserveur:/mondepot mondepot
git clone /mon/de/pot mondepot
git clone http://www.kernel.org/mondepot
…

Et maintenant qu’on a un beau dépôt ?!

Et bien il faut faire des opérations sur les fichiers :

Modification

emacs MonFichier.c

Ajout au dépôt

git add MonFichier.c

Renomage du fichier

git mv [-f] MonFichier.c MonFichier2.c

Si vous ne passez par cette commande, git considère que le fichier aura été supprimé et il faudra faire un git add sur le nouveau fichier.
-f pour forcer le rennomage (si le fichier existe)

Suppression

git rm [-f] [--cached] MonFichier.c

Si vous ajoutez l’option –cached, le fichier sera uniquement supprimé du gestionnaire de versions, mais pas du système de fichier.

Oui, mais maintenant ça compile !

Si ça compile, c’est que ça marche (…). Bref il est temps de commiter ! Mais avant j’effectue toujours deux opérations :

git status

Cela permet de voir les fichiers ajoutés/supprimés/modifiés, voir si on n’a rien oublié (un nouveau fichier par exemple). « Untracked files » correspond aux fichiers qui existent mais qui ne sont pas (encore) pris en compte dans le gestionnaire de versions.

git diff [--color]

Avec cette opération on peut visualiser les modifications (au format « patch ») effectuées sur nos fichiers, cela va nous aider à renseigner le message du commit.

Cette commande peut prendre plusieurs options :

git diff [--color] [<commit1>..<commit2>] [--] [paths]

et toutes les options de diff

<commit1>..<commit2> est un intervalle de commits, sachant que <commit> peut être désigné sous la forme :

• le SHA-1 d’un commit
• le tag
• une référence depuis le commit courant

paths correspond à n fichiers

Apparté : Le commit courant

Dans git, le commit courant (ou dernier commit avant modifications) s’appelle HEAD. On peut accéder aux commits précédents en les référençant par rapport à HEAD :
HEAD^ : Père du commit courant
HEAD^^ : Grand père du commit courant
HEAD~n : ancêtre de nième génération de HEAD (grand grand … grand parent de HEAD)

Apparté : .gitignore

.gitignore est un fichier à créer dans le dépôt git pour ignorer un certains nombre de fichiers (dans git status). Par exemple tous les fichiers « MonFichier~ » crées par emacs. A chaque ligne on intègre une expression régulière pour le ou les fichiers à ignorer (*~ pour emacs):
Si la ligne fini par /, cela désigne un répertoire et tous ce qu’il y a dessous.
Si la ligne commence par !, on a la négation de l’expression.
Si la ligne est vide ou qu’elle commence par #, elle est ignorée.

Étant donné qu’on ne va pas re créer ce fichier pour chaque dépôt, on peut en spécifier un qui sera réutilisé à chaque fois (qui peut être composé avec un .gitignore interne au dépôt). Pour cela il faut créer un fichier quelconque avec les même règles que .gitignore et inscrire la variable globale core.excludesfile :

git config –global core.excludesfile CheminFichier

Attention toutefois, le chemin ne supporte pas ~ (Référence à la racine du répertoire personnel).

Et le tant attendu :

git commit [-a] [-m « message »] [paths]

L’option -a (recommandée) permet d’ajouter toutes les modifications au dépôt, sinon il faut spécifier les fichiers dans paths ou faire explicitement un git add (même sur des fichiers modifiés) pour chaque fichier à intégrer au commit.
Si vous ne précisez pas le message sur la ligne de commande (-m), un éditeur va s’ouvrir (vim par défaut) pour que vous entriez le message du commit. Le message du commit est obligatoire !

Si Bob s’est trompé dans son message de commit, il est toujours possible de le modifier avec :

git commit –amend -c <commit>

Un peu d’histoire

Maintenant qu’on a fait plusieurs commits et que notre projet grossi il peut être intéressant d’avoir un résumé de l’état du projet. Pour cela deux commandes :

git log [options] [<commit1>..<commit2>] [--] [paths]

Liste des commits avec leurs message influant sur les fichiers paths.

git show [options] <commit> [--] [paths]

Contenu de tous les fichiers modifiés ou seulement ceux dans paths.
Les options sont celles de git diff.

En ligne de commande la visualisation n’est pas aisée, c’est pourquoi je recommande l’utilisation de la commande gitk qui permettra d’avoir une vue graphique et synthétique du dépôt.

Eh Bob, j’ai une idée !

Oui, mais les idées de Bob c’est pas toujours terrible, heureusement git permet de créer FACILEMENT des branches, pas besoin d’appeler la gconf et d’imputer sur le budget du projet déjà en déficit …
Bref pour créer un branche :

git branch NomDeLaBranche [BrancheInitiale]

Et voilà la branche est crée à partir de HEAD ou de BrancheInitiale.

ATTENTION vous êtes toujours dans la branche de départ, pour pouvoir changer de branche il faut faire un :

git checkout NomDeLaBranche

Pour récupérer uniquement un fichier d’une autre branche :

git checkout AutreBranche paths

Ces deux actions peuvent être combinée en :

git checkout -b NomDeLaBranche [BrancheInitiale]

Bon ben en fait Bob il a des idées toutes pourries, suppression de la branche :

git branch -d NomDeLaBranche

ATTENTION la branche sera détruite sans confirmation, toutes les modifications seront perdues et il ne sera pas possible de les retrouver !!

On peut lister les branches avec :

git branch

Pour voir le contenu d’un fichier d’une autre branche :

git show MaBranche:MonFichier

Oui, mais mon idée était beaucoup plus classe que celle de Bob, je vais donc l’intégrer dans la branche principale (master) :

git checkout master
git merge MesBranches

(on peut merger depuis plusieurs branches)
S’il n’y a pas de conflit, l’opération est commitée (sauf option –no-commit).

Ah il y a un conflit que git n’est pas capable de résoudre: il nous l’indique et il faut le résoudre  manuellement. Le fichier accusé sera de la forme :

<<<<<<< HEAD:test.c
printf(« Hello world 2\n ») ;
=======
printf(« Hello world 1\n ») ;
>>>>>>> test:test.c

HEAD, c’est la branche actuelle ! test est ici une branche de test. Le fichier en conflit sera affiché dans git status comme unmerged.

Pas très lisible ?  On peut voir séparément les différences introduites par les deux commits sur le fichier en conflit :

git log –merge -p test.c

Une autre option très pratique pour choisir entre telle et telle version quand on est fainéant et qu’on n’a pas envie de tout éditer à la main (de toutes façons c’est ma version la meilleure) :

git show :z:test.c

où z correspond à :

• l’ancêtre commun des deux branches
• branche actuelle
• branche distante

Qui montre la version z du fichier test.c. On redirige ensuite la sortie dans le fichier test.c

Ne pas oublier de commiter les changements introduits par le merge (en cas de conflits) !

On a enfin une version stable !!

Il est possible de la tagger pour avoir une référence un peu plus explicite que son SHA-1.

git tag MonTag [<commit>]

Par défaut HEAD de la branche courante. Un commit peut avoir plusieurs tags.

Ah, en fait non, Bob avait laissé un buffer overflow, supprimer un tag :

git tag -d MonTag

Ouais, en fait la v1 c’était le top. Il est possible de revenir à une version précédente (et heureusement) via trois techniques.

Je m’appelle Rambo et rien ne me fait peur

git reset [--mixed | --soft | --hard] [<commit>]

Ici on revient à un commit précédent en SUPPRIMANT tous les commits suivants
–mixed : les changements n’affectent que le gestionnaire de versions et pas le système de fichier
–soft : On revient simplement au commit <commit> au niveau du gestionnaire de versions, mais les fichiers ne sont pas changés sur le disque (un prochain commit n’effacera pas le commit suivante [i.e qu'on a reseté])
–hard : Le gestionnaire de versions et les fichiers sur le disque se retrouvent en position <commit>, les commits suivants sont perdus.

Méthode propre

git revert <commit>

Cette méthode est « propre » car elle permet de conserver les changements introduits (même si on veut s’en séparer) en introduisant un commit faisant le travail inverse de ce qui a été cassé.

Méthode pour un ensemble restreint de fichiers

git checkout <commit> paths

Cela permet de retrouver ponctuellement un fichier d’une ancienne version.

J’te jure ça marchait et j’ai rien touché !

12 commits ont été réalisé pendant que vous étiez en vacances et maintenant plus rien ne compile (Bob ??). Bref, git offre un mécanisme très puissant pour identifier le commit qui a tout fait planter : bisect ! On va pouvoir faire une recherche semi-automatique voir même automatique du commit fautif, git se chargera tout seul de mettre l’espace de travail tel qu’il était à chaque commit (sinon il aurait fallu jouer avec reset/revert).

On commence par démarrer une session de bisect en identifiant le point où ça bloque (en général HEAD) et le point où on est sûr que c’était bon:

git bisect start [<commit-bad>] [<commit-good>]

Puis on va identifier les différents commits (la recherche est dichotomique, c’est à dire qu’il prend toujours le commit intermédiaire dans l’intervalle good-bad afin de trouver au plus vite la version responsable du problème) avec :

git bisect bad
git bisect good

Chaque appel de cette commande « tag » le commit avec good ou bad et passe au commit suivant jusqu’à tomber sur le fautif (ou qu’on en ais marre). Si on sait qu’un commit (ou un intervalle de commits (ie : v1..v2)) est bon par avance on peux l’ignorer avec :

git bisect skip [<commit>[..<commit>]]

good et bad ne sont que des marqueurs, il appartient ensuite au développeur d’effectuer les actions pour retrouver un environnement correct/stable/sans bugs. On peut visualiser l’état des marqueurs (dans gitk) avec :

git bisect visualize

Une fois qu’on a fini le boulot on peut revenir au point de départ (effacer les tags et retour à HEAD) avec :

git bisect reset

Il est possible d’enregistrer toutes les opérations (ou au moins les « visualiser ») avec :

git bisect log

Et on peut ensuite les rejouer avec :

git bisect replay <fichier créée par git bisect log>

Mais là où git est très intéressant c’est avec le mode tout automatique :

git bisect run cmd

cmd est une commande (ou un script) qui va être appliqué sur tous les commits entre bad et good et qui va les marquer selon son code de retour :

• 0 : good
• 125 : skip
• autre : bad

Une fois qu’on a le commit fautif on peut savoir exactement qui a fait quoi dans le fichier qui a fait que et quand il l’a fait :

git blame <paths>

Ce qui donne quelque chose comme :

1692b633 (Grégory 2009-09-19  1 ) #include <stdio.h>
1692b633 (Grégory 2009-09-19  2 )
1692b633 (Grégory 2009-09-19  3 )
1692b633 (Grégory 2009-09-19  4 )
1692b633 (Grégory 2009-09-19  5 ) int main()
1692b633 (Grégory 2009-09-19  6 ) {
795a06c9 (Grégory 2009-09-29 7 )   printf( « Hello world\n » ) ;
1692b633 (Grégory 2009-09-19  8 )
1692b633 (Grégory 2009-09-19  9 )   return 0 ;
1692b633 (Grégory 2009-09-19 10) }

Ça fait stash !

Vous êtes tranquillement en train de travailler sur l’ajout d’une fonctionnalité révolutionnaire quand Bob vous apprend catastrophé qu’il a trouvé un bug terrible dans le projet et qu’il faut le corriger dans la seconde. On peut bien évidement créer une branche pour reporter les modifications et merger par la suite d’une manière plus ou moins élégante, mais git introduit un concept très intéressant : le « stash ». Cela permet de mettre les modifications en cours dans une pile et de revenir à la dernière version (~ git reset –hard HEAD), faire les bonnes modifications, commiter et retrouver son espace de travail.

Créer le stash (éventuellement avec un message) :

git stash [save [message]]

Voir la liste des stashs :

git stash list

Récupérer les modifications du stash et le supprimer de la liste des stashs :

git stash pop [stash]

La syntaxe des stashs est : stash@{0}

Le stash le plus récent est toujours 0. Si aucun stash n’est précisé, le plus récent est celui par défaut

Voir les modifications du stash :

git stash show [stash]

Appliquer les modifications d’un stash sans le supprimer de la pile :

git stash apply [stash]

Supprimer tous les stashs :

git stash clear

Supprimer un stash sans l’appliquer :

git stash drop [stash]

Hooks

Les hooks sont des scripts appelés durant l’exécution de certaines tâches, ils se trouvent dans le répertoire .git/hooks. Cela permet de contrôler/valider certaines actions. Si la valeur de retour du script est différente de 0, alors l’action ne sera pas exécutée. Git propose les hooks suivants :

pre/post commit

[prepare-]commit-msg : invoqué lors de la création du message dans git commit

pre-rebase : invoqué avant un git rebase

post-checkout : invoqué après un git checkout

post-merge : après un merge et/ou un pull

pre/post receive : invoqué (sur le serveur uniquement) lors d’un git push

update : invoqué (sur le serveur uniquement) lors d’un git push

post-rewrite : invoqué lorsque le message d’un commit est modifié (git commit –amend ou git rebase)

Pour les différents paramètres que prennent les hooks, voir le man. Des exemples se trouvent dans le dossier (les .sample). Pour qu’un hook soit pris en compte il faut enlever l’extension .sample (attention à ne pas oublier les droits en exécution).

Git, mon couteau Suisse

Quelques commandes supplémentaires :

Exporter les sources du projet (sans le .git)

git archive –format=[tar|zip] –output=File <commit> [paths ...]

Appliquer un/des patch(s)

git apply <patchs>

Supprimer les fichiers qui sont dans le dépôt, mais pas dans le gestionnaire de versions (untracked files) :

git clean [-d] [fichiers]

Si l’argument fichiers est renseigné, seuls ces fichiers là seront supprimés.
-d : Supprimer aussi les dossiers

Optimiser le dépôt local pour de meilleures performances (à faire de temps en temps)

git gc

Pour aller plus loin

La documentation de git (en pages man) est très bien faite, il y a deux solutions :

git help command

Toutes les options pour les commandes présentées n’ont pas été spécifiées ici, je vous recommande donc pour certaines tâches spécifiques d’aller voir le man.
L’aspect travail collaboratif (pull, push, rebase) n’a pas été abordé, si vous êtes curieux il y a d’autres documentation qui en parlent (peut être pour une prochaine version de ce tutoriel).

Pour savoir pourquoi git est le meilleur gestionnaire de versions du noyau : http://www.youtube.com/watch?v=4XpnKHJAok8

Le Terminal c’est bien, mais bon

Vous devriez maintenant être capable d’utiliser git en ligne de commande pour vos besoins personnels. Le terminal … ça va bien un moment mais on aime aussi avoir un client graphique un peu plus convivial qui fait le boulot pour nous ! Faisons un petit tour d’horizon des solutions existantes. Malheureusement, je n’ai pas pu tester ces solutions, libre à vous donc de vous faire une opinion sur l’état d’avancement et la fiabilité de chacun, n’hésitez pas à laisser un commentaire pour partager vos retours.

QGit: Client Qt4 (donc pour les utilisateur KDE principalement). Hébergé par SourceForce avec une dernière version datée du 9 Mai de cette année. De bons retours indiqués sur le site.

TortoiseGIT: Client Windows se voulant le remplaçant de TortoiseSVN. Nécessite l’installation préalable de msysgit.

GitX: Application pour Mac OS X.

GitNub: Autre application pour Mac OS X écrite en RubyCocoa.

EGit: Plug-in pour eclipse, malheureusement peu avancé. Si vous avez du temps et de la motivation, n’hésitez pas à participer.

Ressources

http://git-scm.com/

http://fr.wikipedia.org/wiki/Git

http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html
http://linux.efrei.fr/doku.php/tutoriaux/git
http://github.com/
http://www.unixgarden.com/index.php/administration-systeme/git-pour-les-futurs-barbus
http://www.unixgarden.com/index.php/administration-systeme/git-les-mains-dans-le-cambouis

Tutoriel GIT by Grégory Soutadé est mis à disposition selon les termes de la licence Creative Commons Paternité-Partage des Conditions Initiales à l’Identique 2.0 France.