La commande git blame est un utilitaire de dépannage polyvalent, qui dispose de nombreuses options d'utilisation. git blame a pour fonction générale d'afficher les métadonnées d'auteur associées à des lignes de commit spécifiques dans un fichier. Cela permet d'examiner des points spécifiques de l'historique d'un fichier et de mettre en contexte le dernier auteur qui a modifié la ligne. Cette approche est utilisée pour explorer l'historique d'un code spécifique et répondre aux questions « quel code a été ajouté à un dépôt », « comment » et « pourquoi ».

git blame est souvent utilisée avec un affichage GUI. Les sites d'hébergement Git en ligne, comme Bitbucket, proposent des vues blame qui sont des encapsuleurs d'interface utilisateur de git blame. Ces vues sont référencées dans les discussions collaboratives relatives aux pull requests et aux commits. De plus, la plupart des IDE présentant une intégration Git disposent également de vues blame dynamiques.

Fonctionnement

Afin de montrer comment fonctionne la commande git blame, nous avons besoin d'un dépôt présentant un certain historique. Nous utiliserons le projet open source git-blame-example. Il s'agit d'un dépôt simple, qui contient un fichier README.md comprenant quelques commits de différents auteurs. La première étape de notre exemple d'utilisation de git blame est la commande git clone, qui permettra de cloner l'exemple de dépôt.

git clone https://kevzettler@bitbucket.org/kevzettler/git-blame-example.git && cd git-blame-example

Maintenant que nous disposons d'une copie de l'exemple de code, nous pouvons commencer à l'explorer à l'aide de la commande git blame. L'état de l'exemple de dépôt peut être analysé à l'aide de la commande git log. L'historique de commit devrait se présenter comme suit :

$ git log
commit 548dabed82e4e5f3734c219d5a742b1c259926b2
Author: Juni Mukherjee <jmukherjee@atlassian.com>
Date: Thu Mar 1 19:55:15 2018 +0000
Another commit to help git blame track the who, the what, and the when
commit eb06faedb1fdd159d62e4438fc8dbe9c9fe0728b
Author: Juni Mukherjee <jmukherjee@atlassian.com>
Date: Thu Mar 1 19:53:23 2018 +0000
Creating the third commit, along with Kev and Albert, so that Kev can get git blame docs.
commit 990c2b6a84464fee153253dbf02e845a4db372bb
Merge: 82496ea 89feb84
Author: Albert So <aso@atlassian.com>
Date: Thu Mar 1 05:33:01 2018 +0000
Merged in albert-so/git-blame-example/albert-so/readmemd-edited-online-with-bitbucket-1519865641474 (pull request #2)
README.md edited online with Bitbucket
commit 89feb84d885fe33d1182f2112885c2a64a4206ec
Author: Albert So <aso@atlassian.com>
Date: Thu Mar 1 00:54:03 2018 +0000
README.md edited online with Bitbucket

La commande git blame fonctionne uniquement sur les fichiers individuels. Un chemin de fichier est requis pour toute sortie utile. L'exécution par défaut de la commande git blame affiche simplement le menu d'aide des commandes. Dans cet exemple, nous travaillerons sur le fichier README.MD. Les logiciels open source incluent fréquemment un fichier README à la racine d'un dépôt Git. Il fait office de source de documentation pour le projet.

git blame README.MD

L'exécution de la commande ci-dessus nous fournit notre premier échantillon de sortie blame. La sortie suivante constitue un sous-ensemble de la sortie blame complète du fichier README. En outre, cette sortie statique reflète l'état du dépôt au moment de la rédaction.

$ git blame README.md
82496ea3 (kevzettler 2018-02-28 13:37:02 -0800 1) # Git Blame example
82496ea3 (kevzettler 2018-02-28 13:37:02 -0800 2)
89feb84d (Albert So 2018-03-01 00:54:03 +0000 3) This repository is an example of a project with multiple contributors making commits.
82496ea3 (kevzettler 2018-02-28 13:37:02 -0800 4)
82496ea3 (kevzettler 2018-02-28 13:37:02 -0800 5) The repo use used elsewhere to demonstrate `git blame`
82496ea3 (kevzettler 2018-02-28 13:37:02 -0800 6)
89feb84d (Albert So 2018-03-01 00:54:03 +0000 7) Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod TEMPOR incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum
89feb84d (Albert So 2018-03-01 00:54:03 +0000 8)
eb06faed (Juni Mukherjee 2018-03-01 19:53:23 +0000 9) Annotates each line in the given file with information from the revision which last modified the line. Optionally, start annotating from the given revision.
eb06faed (Juni Mukherjee 2018-03-01 19:53:23 +0000 10)
548dabed (Juni Mukherjee 2018-03-01 19:55:15 +0000 11) Creating a line to support documentation needs for git blame.
548dabed (Juni Mukherjee 2018-03-01 19:55:15 +0000 12)
548dabed (Juni Mukherjee 2018-03-01 19:55:15 +0000 13) Also, it is important to have a few of these commits to clearly reflect the who, the what and the when. This will help Kev get good screenshots when he runs the git blame on this README.

Il s'agit d'un exemple des 13 premières lignes du fichier README.md. Pour mieux comprendre cette sortie, décomposons une ligne. Le tableau suivant affiche le contenu de la ligne 3, et les colonnes du tableau indiquent le contenu de ce dernier.

ID Auteur Horodatage Numéro de ligne Contenu de la ligne
89feb84d Albert So 01-03-2018 00:54:03 +0000 3 Ce dépôt est un exemple de projet pour lequel plusieurs contributeurs effectuent des commits.

Si nous examinons la liste de sorties blame, nous pouvons faire certaines observations. Trois auteurs sont cités. En plus du mainteneur de projet Kev Zettler, Albert So et Juni Mukherjee sont également mentionnés. Les auteurs constituent généralement la part la plus précieuse de la sortie git blame. La colonne de « Horodatage » est également particulièrement utile. La nature du changement est indiquée dans la colonne « Contenu de la ligne ».

Options communes

git blame -L 1,5 README.md

L'option -L limite la sortie à la plage des lignes demandée. Nous avons ici limité la sortie aux lignes 1 à 5.

git blame -e README.md

L'option -e indique l'adresse e-mail des auteurs au lieu du nom d'utilisateur.

git blame -w README.md

L'option -w ignore les changements apportés aux espaces. Si un ancien auteur a modifié l'espacement d'un fichier en passant des tabulations aux espaces ou en ajoutant de nouvelles lignes, la sortie de la commande git blame est cachée par l'affichage de ces changements.

git blame -M README.md

L'option -M détecte les lignes déplacées ou copiées dans un même fichier. Cette action signale l'auteur initial des lignes, plutôt que le dernier auteur qui a déplacé ou copié les lignes.

git blame -C README.md

L'option -C détecte les lignes déplacées ou copiées depuis d'autres fichiers. Cette action signale l'auteur initial des lignes, plutôt que le dernier auteur qui a déplacé ou copié les lignes.

Comparaison de git blame et git log

Bien que la commande git blame affiche le dernier auteur qui a modifié une ligne, vous souhaiterez souvent connaître la date d'ajout initial de cette ligne. Obtenir cette information s'avère parfois fastidieux en utilisant la commande git blame. Une combination des options -w, -C et -M est nécessaire. Utiliser la commande git log se révèle souvent bien plus pratique.

Pour répertorier tous les commits initiaux dans lesquels une portion de code spécifique a été ajoutée ou modifiée, exécutez la commande git log avec l'option -S. Ajoutez l'option -S avec le code que vous recherchez. Prenons l'une des lignes de la sortie README ci-dessus comme exemple : le passage « CSS3D and WebGL renderers » à la ligne 12.

$ git log -S"CSS3D and WebGL renderers." --pretty=format:'%h %an %ad %s'
e339d3c85 Mario Schuettel Tue Oct 13 16:51:06 2015 +0200 reverted README.md to original content
509c2cc35 Daniel Tue Sep 8 13:56:14 2015 +0200 Updated README
cb20237cc Mr.doob Mon Dec 31 00:22:36 2012 +0100 Removed DOMRenderer. Now with the CSS3DRenderer it has become irrelevant.

Cette sortie nous montre que le contenu du fichier README a été ajouté ou modifié à trois reprises par trois auteurs différents. Il a été ajouté initialement dans le commit cb20237cc par Mr.doob. Dans cet exemple, la commande git log a également été préfixée avec l'option --pretty-format. Cette option convertit le format de sortie par défaut de la commande git log en un format qui correspond à celui de la commande git log. Pour en savoir plus sur les options d'utilisation et de configuration, consultez la page git log.

Résumé

La commande git blame permet d'examiner le contenu d'un fichier ligne par ligne, et de savoir à quelle date chaque ligne a été modifiée pour la dernière fois et par qui. Le format de sortie de la commande git blame peut être modifié avec différentes options de ligne de commande. Les solutions d'hébergement Git en ligne, comme Bitbucket, proposent des vues blame, qui offrent une meilleure expérience utilisateur lorsque vous lancez git blame dans la ligne de commande. Les commandes git blame et git log peuvent être combinées pour découvrir l'historique du contenu d'un fichier. La commande git log présente certaines fonctionnalités blame. Pour en savoir plus, consultez la page de présentation de git log.

Prêt à découvrir Git ?

Essayez ce tutoriel interactif.

Démarrez maintenant