简体中文 ▾ 主题 ▾ 最新版本 ▾ git-blame 最后更新于 2.53.0

名称

git-blame - 显示文件每一行最后一次修改的版本和作者

概要

git blame [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]
	  [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]
	  [--ignore-rev <rev>] [--ignore-revs-file <file>]
	  [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]
	  [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] <file>

描述

标注给定文件中每一行的信息，包括最后一次修改该行的版本信息。可选择从指定的版本开始标注。

当指定一次或多次 -L 时，会将标注限制在请求的行范围内。

行来源会自动追踪整个文件的重命名（目前没有选项可以关闭重命名跟踪）。要跟踪从一个文件移动到另一个文件的行，或跟踪从另一个文件复制粘贴的行等，请参阅 -C 和 -M 选项。

该报告不会告诉你任何关于已删除或已替换行的信息；你需要使用诸如 git diff 之类的工具，或者下一段简要提到的“pickaxe”界面。

除了支持文件标注外，Git 还支持在开发历史中搜索代码片段是在何时出现的。这使得追踪代码片段何时被添加到文件、在文件间移动或复制，以及最终被删除或替换成为可能。其工作原理是在 diff 中搜索文本字符串。下面是一个搜索 blame_usage 的 pickaxe 界面小示例

$ git log --pretty=oneline -S'blame_usage'
5040f17eba15504bad66b14a645bddd9b015ebb7 blame -S <ancestry-file>
ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output

选项

-b

为边界提交显示空白的 SHA-1。这也可以通过 blame.blankBoundary 配置选项来控制。

--root

不要将根提交视为边界。这也可以通过 blame.showRoot 配置选项来控制。

--show-stats

在 blame 输出的末尾包含额外统计信息。

-L <start>,<end>
-L :<funcname>

仅标注由 <start>,<end> 给出的行范围，或由函数名正则 <funcname> 给出的范围。可以多次指定。允许重叠的范围。

<start> 和 <end> 是可选的。-L <start> 或 -L <start>, 表示从 <start> 到文件末尾。-L ,<end> 表示从文件开头到 <end>。

<start> 和 <end> 可以采用以下形式之一

  • <number>

    如果 <start> 或 <end> 是一个数字，它指定一个绝对行号（行从 1 开始计数）。

  • /<regex>/

    此形式将使用第一个匹配给定 POSIX <regex> 的行。如果 <start> 是一个正则表达式，它将从上一个 -L 范围的末尾（如果存在）开始搜索，否则从文件开头开始搜索。如果 <start> 是 ^/<regex>/，它将从文件开头开始搜索。如果 <end> 是一个正则表达式，它将从 <start> 给定的行开始搜索。

  • +<offset> 或 -<offset>

    这仅对 <end> 有效，并将指定 <start> 给定行之前或之后的行数。

如果用 <start> 和 <end> 的位置给出了 :<funcname>，它是一个正则表达式，表示从第一个匹配 <funcname> 的 funcname 行到下一个 funcname 行的范围。:<funcname> 从上一个 -L 范围的末尾（如果存在）开始搜索，否则从文件开头开始搜索。^:<funcname> 从文件开头开始搜索。函数名的确定方式与 git diff 如何处理补丁块头相同（参见 gitattributes[5] 中的“定义自定义块头”）。

-l

显示长版本哈希（默认：关闭）。

-t

显示原始时间戳（默认：关闭）。

-S <revs-file>

使用 <revs-file> 中的版本，而不是调用 git-rev-list[1]。

--reverse <start>..<end>

向前而不是向后遍历历史。这显示的是某一行存在的最后一个版本，而不是该行首次出现的版本。这需要像 <start>..<end> 这样的版本范围，其中被 blame 的路径必须存在于 <start> 中。为方便起见，git blame --reverse <start> 被视为 git blame --reverse <start>..HEAD。

--first-parent

在遇到合并提交时，仅跟踪第一个父提交。此选项可用于确定某一行是何时引入到特定集成分支的，而不是它何时引入到整体历史中。

-p
--porcelain

以专为机器读取而设计的格式显示。

--line-porcelain

显示机器可读格式，但为每一行输出提交信息，而不仅仅是提交首次被引用时。隐含了 --porcelain。

--incremental

以专为机器读取而设计的格式增量显示结果。

--encoding=<encoding>

指定用于输出作者姓名和提交摘要的编码。将其设置为 none 会使 blame 输出未经转换的数据。有关更多信息，请参阅 git-log[1] 手册页中关于编码的讨论。

--contents <file>

使用 <file> 中的内容进行标注，如果指定了 <rev> 则从该版本开始，否则从 HEAD 开始。您可以指定 - 让命令从标准输入读取文件内容。

--date <format>

指定用于输出日期的格式。如果未提供 --date，则使用 blame.date 配置变量的值。如果未设置 blame.date 配置变量，则使用 iso 格式。有关支持的值，请参阅 git-log[1] 中关于 --date 选项的讨论。

--progress
--no-progress

即使没有连接到终端，也能在标准错误流上启用进度报告。默认情况下，只有在连接到终端时才会报告进度状态。不能将 --progress 与 --porcelain 或 --incremental 一起使用。

-M[<num>]

检测文件内移动或复制的行。当提交移动或复制了一块行（例如，原始文件有 A 然后是 B，而提交将其更改为 B 然后是 A）时，传统的 blame 算法只会注意到一半的移动，并且通常将向上移动的行（即 B）归咎于父提交，并将向下移动的行（即 A）归咎于子提交。使用此选项，通过运行额外的检查过程，两组行都将被归咎于父提交。

<num> 是可选的，它是 Git 必须检测到文件内移动/复制的字母数字字符数的下限，以便将这些行与父提交关联起来。默认值为 20。

-C[<num>]

除了 -M 之外，检测在同一个提交中从其他文件移动或复制的行。这在你重组程序并跨文件移动代码时很有用。当给出该选项两次时，该命令还会寻找在创建文件的提交中从其他文件进行的复制。当给出该选项三次时，该命令还会寻找在任何提交中从其他文件进行的复制。

<num> 是可选的，它是 Git 必须检测到文件间移动/复制的字母数字字符数的下限，以便将这些行与父提交关联起来。默认值为 40。如果给出了多个 -C 选项，则最后一个 -C 的 <num> 参数将生效。

--ignore-rev <rev>

在进行 blame 时忽略指定版本所做的更改，就好像该更改从未发生过一样。由被忽略的提交更改或添加的行将被归咎于上一个更改该行或附近行的提交。此选项可以多次指定以忽略多个版本。如果设置了 blame.markIgnoredLines 配置选项，则由被忽略的提交更改并归因于另一个提交的行将在 blame 输出中用 ? 标记。如果设置了 blame.markUnblamableLines 配置选项，则那些被忽略的提交触及但无法归因于另一个版本的行将用 * 标记。在机器可读模式下，我们分别在新行上打印 ignored 和 unblamable。

--ignore-revs-file <file>

忽略 <file> 中列出的版本，该文件必须与 fsck.skipList 的格式相同。此选项可以重复，并且这些文件将在处理完通过 blame.ignoreRevsFile 配置选项指定的任何文件之后进行处理。空文件名 "" 将清除之前处理文件中的版本列表。

--color-lines

如果行标注来自与前一行相同的提交，则在默认格式中以不同方式着色。这使得区分由不同提交引入的代码块变得更容易。颜色默认为青色，可以使用 color.blame.repeatedLines 配置选项进行调整。

--color-by-age

在默认格式中根据行的陈旧程度对行标注进行着色。color.blame.highlightRecent 配置选项控制每个时间范围使用的颜色。

-h

显示帮助信息。

-c

使用与 git-annotate[1] 相同的输出模式（默认：关闭）。

--score-debug

包含与文件间行移动（参见 -C）和文件内行移动（参见 -M）相关的调试信息。列出的第一个数字是得分。这是检测到在文件间或文件内移动的字母数字字符数。这必须高于某个阈值，git blame 才会认为这些代码行已被移动。

-f
--show-name

显示原始提交中的文件名。默认情况下，如果由于重命名检测导致任何行来自不同名称的文件，则会显示该文件名。

-n
--show-number

显示原始提交中的行号（默认：关闭）。

-s

从输出中抑制作者姓名和时间戳。

-e
--show-email

显示作者邮箱而不是作者姓名（默认：关闭）。这也可以通过 blame.showEmail 配置选项控制。

-w

在比较父版本和子版本以查找行来源时忽略空白。

--diff-algorithm=(patience|minimal|histogram|myers)

选择一种差异算法。变体如下：

default
myers

基本的贪婪差异算法。目前，这是默认值。

minimal

花费额外时间以确保生成最小的差异。

patience

生成补丁时使用“patience diff”算法。

histogram

此算法扩展了 patience 算法以“支持低出现率的常见元素”。

例如，如果您将 diff.algorithm 变量配置为非默认值，但希望使用默认值，则必须使用 --diff-algorithm=default 选项。

--abbrev=<n>

不使用默认的 7+1 个十六进制数字作为缩写对象名，而是使用 <m>+1 个数字，其中 <m> 至少为 <n> 但能确保提交对象名是唯一的。注意，1 列用于插入符号来标记边界提交。

默认格式

当未指定 --porcelain 和 --incremental 选项时，git blame 将为每一行输出包含以下信息的标注：

  • 该行来源提交的缩写对象名；

  • 作者标识（默认情况下为作者姓名和日期，除非指定了 -s 或 -e）；以及

  • 行号

在行内容之前。

机器可读（Porcelain）格式

在这种格式中，每一行在头部之后输出；头部至少包含第一行，其中有：

  • 该行归属提交的 40 字节 SHA-1；

  • 该行在原始文件中的行号；

  • 该行在最终文件中的行号；

  • 在开始一组来自与前一行不同提交的行的行上，显示该组的行数。在随后的行中，此字段缺失。

此标题行后面至少会为每个提交出现一次以下信息：

  • 作者姓名（author）、邮箱（author-mail）、时间（author-time）和时区（author-tz）；提交者信息同理。

  • 该行归属提交中的文件名。

  • 提交日志信息的第一行（summary）。

实际行的内容在上述头部之后输出，前缀为 TAB。这是为了以后可以添加更多的头部元素。

Porcelain 格式通常会抑制已经见过的提交信息。例如，归咎于同一个提交的两行都会被显示，但该提交的详细信息只会出现一次。特定于单个行的信息不会被分组在一起，例如标记为 ignored 或 unblamable 的版本。这更有效率，但可能需要读取器保持更多状态。--line-porcelain 选项可用于为每一行输出完整的提交信息，从而实现更简单（但效率较低）的使用方式，例如

# count the number of lines attributed to each author
git blame --line-porcelain file |
sed -n 's/^author //p' |
sort | uniq -c | sort -rn

指定范围

与旧版本 git 中的 git blame 和 git annotate 不同，标注的范围可以限制为行范围和版本范围。-L 选项将标注限制在一定的行范围内，可以多次指定。

当你想要查找文件 foo 第 40-60 行的来源时，你可以像这样使用 -L 选项（它们含义相同——都是请求从第 40 行开始的 21 行）：

git blame -L 40,60 foo
git blame -L 40,+21 foo

你也可以使用正则表达式来指定行范围

git blame -L '/^sub hello {/,/^}$/' foo

这会将标注限制在 hello 子程序的主体中。

当你对早于 v2.6.18 的版本或早于 3 周的更改不感兴趣时，可以使用类似于 git rev-list 的版本范围说明符

git blame v2.6.18.. -- foo
git blame --since=3.weeks -- foo

当使用版本范围说明符来限制标注时，自范围边界以来未更改的行（在上述示例中为提交 v2.6.18 或早于 3 周的最新提交）将归咎于该范围边界提交。

一个特别有用的方法是查看添加的文件是否包含从现有文件复制粘贴而来的行。有时这表明开发人员工作马虎，没有正确地重构代码。你可以先通过以下方式找到引入该文件的提交

git log --diff-filter=A --pretty=short -- foo

然后使用 commit^! 符号标注该提交与其父提交之间的更改

git blame -C -C -f $commit^! -- foo

增量输出

当使用 --incremental 选项调用时，命令会随着结果的构建而输出。输出通常会先讨论受近期提交影响的行（即行将乱序标注），旨在供交互式查看器使用。

输出格式类似于 Porcelain 格式，但不包含正在标注的文件中的实际行。

  1. 每个 blame 条目总是以一行开头：

    <40-byte-hex-sha1> <sourceline> <resultline> <num-lines>

    行号从 1 开始计数。

  2. 提交第一次出现在流中时，会打印关于它的各种其他信息，每行开头都有一个单词标签，描述额外的提交信息（作者、邮箱、提交者、日期、摘要等）。

  3. 与 Porcelain 格式不同，文件名信息总是会给出，并终止该条目

    filename <whitespace-quoted-filename-goes-here>

    因此对于某些面向行和单词的解析器来说，解析起来非常容易（这对大多数脚本语言来说应该是很自然的）。

    注意
    		 对于解析人员：为了使其更健壮，只需忽略第一行和最后一行（<40-byte-hex-sha1> 和 filename 行）之间任何你无法识别标签单词（或不关心该特定标签）的行。这样，如果以后有添加的信息（如提交编码或扩展提交注释），blame 查看器就不会关心。

作者映射

请参阅 gitmailmap[5]。

配置

本节中以下所有内容均从 git-config[1] 文档中选择性地包含。内容与彼处相同：

blame.blankBoundary

在 git-blame[1] 中为边界提交显示空白提交对象名。此选项默认为 false。

blame.coloring

这决定了应用于 blame 输出的着色方案。它可以是 repeatedLines、highlightRecent 或默认的 none。

blame.date

指定在 git-blame[1] 中用于输出日期的格式。如果未设置，则使用 iso 格式。有关支持的值，请参阅 git-log[1] 中关于 --date 选项的讨论。

blame.showEmail

在 git-blame[1] 中显示作者邮箱而不是作者姓名。此选项默认为 false。

blame.showRoot

不要在 git-blame[1] 中将根提交视为边界。此选项默认为 false。

blame.ignoreRevsFile

在 git-blame[1] 中忽略文件中列出的版本，每行一个未缩写的对象名。以 # 开头的空格和注释将被忽略。此选项可以重复多次。空文件名将重置被忽略版本列表。此选项将在命令行选项 --ignore-revs-file 之前处理。

blame.markUnblamableLines

在 git-blame[1] 的输出中，用 * 标记那些由被忽略版本更改但无法归因于另一个提交的行。

blame.markIgnoredLines

在 git-blame[1] 的输出中，用 ? 标记那些由被忽略版本更改并归因于另一个提交的行。

另请参阅

git-annotate[1]

GIT

Git[1] 套件的一部分