Git
英语 ▾ 主题 ▾ 最新版本 ▾ git-annotate 最后更新于 2.41.0

名称

git-annotate - 用提交信息注释文件行

概要

git annotate [<options>] [<rev-opts>] [<rev>] [--] <file>

描述

用引入该行的提交信息注释给定文件中的每一行。可以选择性地从给定版本进行注释。

此命令与 git-blame[1] 之间的唯一区别是它们使用略微不同的输出格式，并且此命令仅为了向后兼容性而存在，以支持现有的脚本，并为来自其他 SCM 系统的用户提供更熟悉的命令名称。

选项

-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> 可以采用以下形式之一

  • 数字

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

  • /regex/

    此形式将使用与给定 POSIX 正则表达式匹配的第一行。如果 <start> 是一个正则表达式，它将从先前 -L 范围的末尾开始搜索，如果没有，则从文件开头开始搜索。如果 <start> 是 ^/regex/，它将从文件开头开始搜索。如果 <end> 是一个正则表达式，它将从 <start> 给出的行开始搜索。

  • +offset 或 -offset

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

如果 :<funcname> 在 <start> 和 <end> 的位置给出，则它是一个正则表达式，表示从与 <funcname> 匹配的第一个 funcname 行开始，到下一个 funcname 行结束的范围。:<funcname> 从先前 -L 范围的末尾开始搜索，如果没有，则从文件开头开始搜索。^:<funcname> 从文件开头开始搜索。函数名称的确定方式与 git diff 如何确定补丁 hunk 标题相同（请参见 gitattributes[5] 中的 定义自定义 hunk 标题）。

-l

显示长修订版（默认：关闭）。

-t

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

-S <revs-file>

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

--reverse <rev>..<rev>

向前遍历历史记录，而不是向后遍历。此命令不是显示行出现的版本，而是显示行存在的最后一个版本。这需要一个版本范围，如 START..END，其中需要在 START 中进行 blame 的路径。为方便起见，git blame --reverse START 被视为 git blame --reverse START..HEAD。

--first-parent

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

-p
--porcelain

以适合机器读取的格式显示。

--line-porcelain

显示 porcelain 格式，但为每一行输出提交信息，而不仅仅是在第一次引用提交时输出。意味着 --porcelain。

--incremental

以适合机器读取的格式增量显示结果。

--encoding=<encoding>

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

--contents <file>

使用来自命名文件的內容进行注释，如果指定了 <rev>，则从 <rev> 开始，否则从 HEAD 开始。您可以指定 - 使命令从标准输入读取文件内容。

--date <format>

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

--[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 配置选项已设置，那么由被忽略的提交修改但我们无法归咎于其他版本的那些行将用 * 标记。

--ignore-revs-file <file>

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

--color-lines

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

--color-by-age

根据默认格式，根据线的年龄来对颜色线注释进行着色。color.blame.highlightRecent 配置选项控制每个年龄范围使用的颜色。

-h

显示帮助信息。

参见

git-blame[1]

GIT

git[1] 套件的一部分

scroll-to-top