git blame

Polecenie git blame to wszechstronne narzędzie do rozwiązywania problemów, które ma liczne zastosowania. Wysokopoziomową funkcją git blame jest wyświetlanie metadanych autora dołączonych do określonych zatwierdzonych wierszy w pliku. Służy do zbadania konkretnych punktów historii pliku i uzyskania kontekstu, kto był ostatnim autorem modyfikacji wiersza. Służy do zbadania historii określonego kodu i odpowiedzi na pytania dotyczące kodu, który został dodany do repozytorium, dlaczego i w jaki sposób.

Polecenie git blame jest często używane z wyświetlaczem graficznego interfejsu użytkownika. Witryny hostingowe systemu Git online, np. Bitbucket, oferują widoki szukania powodu błędów, które są otokami polecenia git blame w interfejsie użytkownika. Widoki te są przywoływane we wspólnych dyskusjach na temat pull requestów i commitów. Dodatkowo większość IDE, które mają integrację z Git, ma również dynamiczne widoki szukania powodu błędów.

Zasada działania

Aby zademonstrować działanie polecenia git blame, potrzebujemy repozytorium z historią. Użyjemy projektu open source git-blame-example. Ten projekt typu open source jest prostym repozytorium zawierającym plik README.md, który ma kilka commitów od różnych autorów. Pierwszym krokiem naszego przykładu użycia polecenia git blame jest wykonanie polecenia git clone w celu sklonowania przykładowego repozytorium.

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

Teraz, gdy mamy kopię przykładowego kodu, możemy zacząć go badać przy użyciu polecenia git blame. Stan przykładowego repozytorium można sprawdzić za pomocą polecenia git log. Historia commitów powinna wyglądać następująco:

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

Polecenie git blame działa tylko na pojedynczych plikach. Aby uzyskać użyteczne dane wyjściowe, wymagana jest ścieżka pliku. Domyślne wykonanie polecenia git blame spowoduje po prostu wyświetlenie menu pomocy poleceń. W tym przykładzie będziemy pracować na pliku README.MD. Powszechną praktyką oprogramowania open source jest dołączenie pliku README w katalogu głównym repozytorium git jako źródła dokumentacji dla projektu.

1git blame README.MD

Wykonanie powyższego polecenia da nam pierwszą próbkę danych wyjściowych narzędzia blame. Poniższy wynik jest podzbiorem pełnych danych wyjściowych blame w przypadku pliku README. Dodatkowo te dane wyjściowe są statyczne, co odzwierciedla stan repozytorium z chwili pisania tego tekstu.

1$ git blame README.md
2    82496ea3 (kevzettler     2018-02-28 13:37:02 -0800  1) # Git Blame example
3    82496ea3 (kevzettler     2018-02-28 13:37:02 -0800  2)
4    89feb84d (Albert So      2018-03-01 00:54:03 +0000  3) This repository is an example of a project with multiple contributors making commits.
5    82496ea3 (kevzettler     2018-02-28 13:37:02 -0800  4)
6    82496ea3 (kevzettler     2018-02-28 13:37:02 -0800  5) The repo use used elsewhere to demonstrate `git blame`
7    82496ea3 (kevzettler     2018-02-28 13:37:02 -0800  6)
8    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
9    89feb84d (Albert So      2018-03-01 00:54:03 +0000  8)
10    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.
11    eb06faed (Juni Mukherjee 2018-03-01 19:53:23 +0000 10)
12    548dabed (Juni Mukherjee 2018-03-01 19:55:15 +0000 11) Creating a line to support documentation needs for git blame.
13    548dabed (Juni Mukherjee 2018-03-01 19:55:15 +0000 12)
14    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.

Jest to próbka pierwszych 13 wierszy pliku README.md. Aby lepiej zrozumieć te dane wyjściowe, przeanalizujmy wiersz. W poniższej tabeli wyświetlana jest zawartość wiersza 3, a kolumny tabeli wskazują zawartość.

Jeśli przejrzymy listę danych wyjściowych narzędzia blame, możemy dokonać pewnych obserwacji. Na liście jest trzech autorów. Oprócz opiekuna projektu, którym jest Kev Zettler, wymienieni są również Albert So i Juni Mukherjee. Autorzy są generalnie najcenniejszą częścią danych wyjściowych polecenia git blame. Kolumna znacznika czasu zwykle również jest pomocna. Zmianę wskazuje kolumna „Zawartość wiersza”.

Często używane opcje

1git blame -L 1,5 README.md

Opcja -L ograniczy dane wyjściowe do żądanego zakresu wierszy. Tutaj ograniczyliśmy wyjście do wierszy od 1 do 5.

1git blame -e README.md

Opcja -e pokazuje adres e-mail autorów zamiast nazw użytkowników.

1git blame -w README.md

Opcja -w ignoruje zmiany w znakach odstępu. Jeśli poprzedni autor zmodyfikował odstępy w pliku, zamieniając je z tabulatorów na spacje lub dodając nowe wiersze, utrudnia to odczyt danych wyjściowych polecenia git blame, ponieważ zmany te są wyświetlane.

1git blame -M README.md

Opcja -M wykrywa przeniesione lub skopiowane wiersze wewnątrz tego samego pliku. Spowoduje to zgłoszenie oryginalnego autora wierszy zamiast ostatniego autora, który przeniósł lub skopiował wiersze.

1git blame -C README.md

Opcja -C wykrywa wiersze, które zostały przeniesione lub skopiowane z innych plików. Spowoduje to zgłoszenie oryginalnego autora wierszy zamiast ostatniego autora, który przeniósł lub skopiował wiersze.

Porównanie poleceń git blame i git log

Polecenie git blame wyświetla autora ostatniej modyfikacji wiersza, ale często możesz chcieć się dowiedzieć, kiedy pierwotnie dodano wiersz. Osiągnięcie tego przy użyciu polecenia git blame może być uciążliwe. Wymaga to kombinacji opcji -w, -C i -M. Korzystanie z polecenia git log może być znacznie wygodniejsze.

Aby wyświetlić wszystkie oryginalne commity, w których dodano lub zmodyfikowano określony fragment kodu, uruchom polecenie git log z opcją -S. Dołącz opcję -S z kodem, którego szukasz. Jako przykład weźmy jeden z wierszy z powyższych danych wyjściowych pliku README. Skorzystajmy z tekstu „CSS3D i WebGL renderery” z wiersza 12 danych wyjściowych pliku README.

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

Te dane wyjściowe pokazują nam, że zawartość pliku README została dodana lub zmodyfikowana 3 razy przez 3 różnych autorów. Pierwotnie została dodana w ramach commita cb20237cc przez autora Mr.doob. W tym przykładzie polecenie git log zostało również poprzedzone opcją --pretty-format. Ta opcja konwertuje domyślny format danych wyjściowych polecenia git log na zgodny z formatem polecenia git log. Więcej informacji na temat opcji użycia i konfiguracji można znaleźć na stronie dotyczącej polecenia git log.

Podsumowanie

Polecenie git blame służy do analizowania zawartości pliku wiersz po wierszu i sprawdzania, kiedy ostatnio zmodyfikowano każdy wiersz i kto był autorem zmiany. Format danych wyjściowych polecenia git blame można zmienić za pomocą różnych opcji wiersza poleceń. Rozwiązania hostingowe systemu Git online, np. Bitbucket, oferują widoki szukania powodu błędu, które znacznie ułatwiają pracę w porównaniu z korzystaniem z polecenia git blame w wierszu poleceń. Poleceń git blame i git log można używać razem, aby łatwiej poznać historię zawartości pliku. Polecenie git log ma podobną funkcję szukania przyczyn błędów. Aby dowiedzieć się więcej, odwiedź stronę z informacjami ogólnymi o poleceniu git log.