简体中文 ▾ 主题 ▾ 最新版本 ▾ git-update-index 最后更新于 2.52.0

名称

git-update-index - 将工作树中的文件内容注册到索引

概要

git update-index
	     [--add] [--remove | --force-remove] [--replace]
	     [--refresh] [-q] [--unmerged] [--ignore-missing]
	     [(--cacheinfo <mode>,<object>,<file>)…​]
	     [--chmod=(+|-)x]
	     [--[no-]assume-unchanged]
	     [--[no-]skip-worktree]
	     [--[no-]ignore-skip-worktree-entries]
	     [--[no-]fsmonitor-valid]
	     [--ignore-submodules]
	     [--[no-]split-index]
	     [--[no-|test-|force-]untracked-cache]
	     [--[no-]fsmonitor]
	     [--really-refresh] [--unresolve] [--again | -g]
	     [--info-only] [--index-info]
	     [-z] [--stdin] [--index-version <n>]
	     [--show-index-version]
	     [--verbose]
	     [--] [<file>…​]

描述

修改索引。提到的每个文件都会更新到索引,并且任何未合并需要更新的状态都会被清除。

有关执行某些最常用索引操作的更用户友好的方法,请参阅 git-add[1]

git update-index 处理其被告知的文件的方式可以使用各种选项进行修改

选项

--add

如果指定的文件尚未在索引中,则将其添加。默认行为是忽略新文件。

--remove

如果指定的文件在索引中但已丢失,则将其删除。默认行为是忽略已删除的文件。

--refresh

查看当前索引,并通过检查 stat() 信息来确定是否需要合并或更新。

-q

安静。如果 --refresh 发现索引需要更新,则默认行为是报错退出。此选项使 git update-index 仍然继续。

--ignore-submodules

不要尝试更新子模块。此选项仅在传入 --refresh 之前才有效。

--unmerged

如果 --refresh 发现索引中有未合并的更改,则默认行为是报错退出。此选项使 git update-index 仍然继续。

--ignore-missing

在 --refresh 期间忽略丢失的文件

--cacheinfo <模式>,<对象>,<路径>
--cacheinfo <模式> <对象> <路径>

直接将指定的信息插入索引。为了向后兼容,您也可以将这三个参数作为三个单独的参数提供,但鼓励新用户使用单个参数的形式。

--index-info

从标准输入读取索引信息。

--chmod=(+|-)x

设置更新文件的执行权限。

--assume-unchanged
--no-assume-unchanged

指定此标志时,不会更新为路径记录的对象名称。相反,此选项会设置/取消设置这些路径的“假定未更改”位。当“假定未更改”位开启时,用户承诺不更改文件,并允许 Git 假定工作树文件与索引中记录的内容一致。如果您想更改工作树文件,则需要取消设置该位以告知 Git。这有时在使用文件系统具有非常慢的 lstat(2) 系统调用的(例如 cifs)的大型项目时很有用。

如果 Git 需要修改索引中的该文件(例如在合并提交时),它将(优雅地)失败;因此,如果假定的未跟踪文件在 upstream 中被更改,您将需要手动处理这种情况。

--really-refresh

类似于 --refresh,但无条件地检查 stat 信息,而不考虑“假定未更改”设置。

--skip-worktree
--no-skip-worktree

指定这些标志之一时,不会更新为路径记录的对象名称。相反,这些选项会设置和取消设置这些路径的“skip-worktree”位。有关更多信息,请参阅下面的“Skip-worktree 位”部分。

--ignore-skip-worktree-entries
--no-ignore-skip-worktree-entries

即使指定了 --remove 选项,也不会删除 skip-worktree(又名“仅索引”)条目。

--fsmonitor-valid
--no-fsmonitor-valid

指定这些标志之一时,不会更新为路径记录的对象名称。相反,这些选项会设置和取消设置这些路径的“fsmonitor valid”位。有关更多信息,请参阅下面的“文件系统监视器”部分。

-g
--again

对索引条目与 HEAD 提交中的条目不同的路径,重新运行 git update-index 本身。

--unresolve

在合并过程中,如果意外清除了文件的未合并需要更新状态,则将其恢复。

--info-only

不要为该标志后面的所有 <file> 参数在对象数据库中创建对象;只将它们的对象 ID 插入索引。

--force-remove

即使工作目录仍然存在该文件,也将其从索引中删除。(隐含 --remove。)

--replace

默认情况下,当文件 path 存在于索引中时,git update-index 会拒绝添加 path/file 的尝试。类似地,如果存在文件 path/file,则无法添加文件 path。使用 --replace 标志,与要添加的条目冲突的现有条目会自动删除并发出警告消息。

--stdin

不要从命令行获取路径列表,而是从标准输入读取路径列表。默认情况下,路径由 LF 分隔(即每行一个路径)。

--verbose

报告正在添加到索引和从索引中移除的内容。

--index-version <n>

将生成的索引以指定的磁盘格式版本写出。支持的版本是 2、3 和 4。当前默认版本是 2 或 3,具体取决于是否使用了附加功能,例如 git add -N。使用 --verbose 时,还会报告此命令之前和之后索引文件使用的版本。

版本 4 执行简单的路径名压缩,可将大型存储库的索引大小减小 30%-50%,从而加快加载时间。Git 自 2012 年 10 月发布的 1.8.0 版本起就支持该版本,libgit2 于 2016 年增加了支持,JGit 于 2020 年增加了支持。此手册页的旧版本称其“相对较新”,但如今应将其视为成熟技术。

--show-index-version

报告磁盘索引文件使用的索引格式版本。请参阅上面的 --index-version

-z

仅当与 --stdin--index-info 一起使用时才有意义;路径由 NUL 字符而不是 LF 分隔。

--split-index
--no-split-index

启用或禁用拆分索引模式。如果拆分索引模式已启用且再次给出 --split-index,则 $GIT_DIR/index 中的所有更改都将推回共享索引文件。

无论 core.splitIndex 配置变量的值如何,这些选项都会生效(请参阅 git-config[1])。但是,当更改与配置值相反时会发出警告,因为配置值将在下次读取索引时生效,这将消除该选项的预期效果。

--untracked-cache
--no-untracked-cache

启用或禁用未跟踪缓存功能。请在启用它之前使用 --test-untracked-cache

无论 core.untrackedCache 配置变量的值如何,这些选项都会生效(请参阅 git-config[1])。但是,当更改与配置值相反时会发出警告,因为配置值将在下次读取索引时生效,这将消除该选项的预期效果。

--test-untracked-cache

仅对工作目录执行测试,以确保可以使用未跟踪缓存。如果您确实想使用它,则之后必须手动使用 --untracked-cache--force-untracked-cachecore.untrackedCache 配置变量来启用未跟踪缓存。如果测试失败,退出代码为 1,并显示一条消息解释问题所在,否则退出代码为 0 并打印 OK。

--force-untracked-cache

--untracked-cache 相同。为了向后兼容较旧的 Git 版本,其中 --untracked-cache 曾经隐含 --test-untracked-cache,但此选项将无条件启用扩展。

--fsmonitor
--no-fsmonitor

启用或禁用文件系统监视器功能。无论 core.fsmonitor 配置变量的值如何,这些选项都会生效(请参阅 git-config[1])。但是,当更改与配置值相反时会发出警告,因为配置值将在下次读取索引时生效,这将消除该选项的预期效果。

--

不再将任何后续参数解释为选项。

<文件>

要操作的文件。请注意,以 . 开头的文件会被丢弃。这包括 ./filedir/./file。如果您不想要此行为,请使用更清晰的名称。目录以 / 结尾和路径包含 // 的情况也一样。

使用 --REFRESH

--refresh 不会计算新的 sha1 文件或将索引更新到最新的模式/内容更改。但它做的是将文件的 stat 信息与索引“重新匹配”,以便您可以刷新一个未更改但 stat 条目已过期的文件的索引。

例如,在执行 git read-tree 后,您会希望执行此操作,以将 stat 索引详细信息与正确的文件关联起来。

使用 --CACHEINFO 或 --INFO-ONLY

--cacheinfo 用于注册当前工作目录中不存在的文件。这对于最小签出合并很有用。

要假装您在路径处拥有一个具有特定模式和 sha1 的文件,请说:

$ git update-index --add --cacheinfo <mode>,<sha1>,<path>

--info-only 用于注册文件而不将其放入对象数据库。这对于仅状态存储库很有用。

--cacheinfo--info-only 的行为相似:索引会更新,但对象数据库不会。当对象存在于数据库中但本地没有该文件时,--cacheinfo 非常有用。当文件可用,但您不想更新对象数据库时,--info-only 非常有用。

使用 --INDEX-INFO

--index-info 是一种更强大的机制,它允许您从标准输入馈送多个条目定义,并且是专门为脚本设计的。它可以接受三种格式的输入:

  1. 模式 空格 类型 空格 sha1 制表符 路径

    此格式用于将 git ls-tree 的输出存入索引。

  2. 模式 空格 sha1 空格 阶段 制表符 路径

    此格式用于将更高级别的阶段放入索引文件,并匹配 git ls-files --stage 的输出。

  3. 模式 空格 sha1 制表符 路径

    此格式不再由任何 Git 命令生成,但 update-index --index-info 支持它,并且将来也会继续支持。

要将更高阶段的条目放入索引,应首先通过馈送该路径的模式=0 条目来删除该路径,然后使用第三种格式馈送必要的输入行。

例如,从这个索引开始

$ git ls-files -s
100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0       frotz

您可以向 --index-info 馈送以下输入:

$ git update-index --index-info
0 0000000000000000000000000000000000000000	frotz
100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1	frotz
100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2	frotz

输入的第一行馈送 0 作为模式以删除路径;只要格式正确,SHA-1 就不重要。然后第二行和第三行馈送该路径的阶段 1 和阶段 2 条目。完成以上操作后,我们将得到如下结果:

$ git ls-files -s
100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1	frotz
100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2	frotz

使用 “假定未更改” 位

Git 中的许多操作都依赖于文件系统具有高效的 lstat(2) 实现,以便可以廉价地检查工作树文件的 st_mtime 信息,以确定文件内容是否与索引文件中记录的版本发生更改。不幸的是,一些文件系统具有低效的 lstat(2)。如果您的文件系统属于此类,则可以为未更改的路径设置“假定未更改”位,以使 Git 不执行此检查。请注意,为路径设置此位并不意味着 Git 将检查文件内容以查看其是否已更改——它会使 Git 忽略任何检查并假定其更改。当您更改工作树文件时,您必须通过删除“假定未更改”位来显式告知 Git,可以在修改它们之前或之后执行。

为了设置“假定未更改”位,请使用 --assume-unchanged 选项。要取消设置,请使用 --no-assume-unchanged。要查看哪些文件已设置“假定未更改”位,请使用 git ls-files -v(请参阅 git-ls-files[1])。

该命令查看 core.ignorestat 配置变量。当此变量为 true 时,使用 git update-index paths... 更新的路径以及使用其他 Git 命令更新索引和工作树的路径(例如 git apply --indexgit checkout-index -ugit read-tree -u)将自动标记为“假定未更改”。请注意,如果 git update-index --refresh 发现工作树文件与索引匹配,则不会设置“假定未更改”位(如果您想将它们标记为“假定未更改”,请使用 git update-index --really-refresh)。

有时用户会混淆 assume-unchanged 位和 skip-worktree 位。请参阅下面的“Skip-worktree 位”部分的最后一段,了解它们之间的区别。

示例

仅更新和刷新已签出文件的操作

$ git checkout-index -n -f -a && git update-index --ignore-missing --refresh
在具有 core.ignorestat 设置的低效文件系统上
$ git update-index --really-refresh              (1)
$ git update-index --no-assume-unchanged foo.c   (2)
$ git diff --name-only                           (3)
$ edit foo.c
$ git diff --name-only                           (4)
M foo.c
$ git update-index foo.c                         (5)
$ git diff --name-only                           (6)
$ edit foo.c
$ git diff --name-only                           (7)
$ git update-index --no-assume-unchanged foo.c   (8)
$ git diff --name-only                           (9)
M foo.c
  1. 强制 lstat(2) 为与索引匹配的路径设置“假定未更改”位。

  2. 将路径标记为待编辑。

  3. 执行 lstat(2) 并发现索引与路径匹配。

  4. 执行 lstat(2) 并发现索引与路径匹配。

  5. 将新版本注册到索引会设置“假定未更改”位。

  6. 并假定其未更改。

  7. 即使在编辑之后。

  8. 您可以在事后告知更改。

  9. 现在它通过 lstat(2) 进行检查,发现它已被更改。

跳过工作树位

Skip-worktree 位可以用一个(长)句子来定义:告诉 git 在合理可能的情况下避免将文件写入工作目录,并在文件不在工作目录中时将其视为未更改。

请注意,并非所有 git 命令都会关注此位,有些命令仅部分支持它。

update-index 标志和与 skip-worktree 位相关的 read-tree 功能在 git-sparse-checkout[1] 命令引入之前就已存在,该命令提供了一种更简便的方法来配置和处理 skip-worktree 位。如果您想将工作目录限制为只处理存储库中的部分文件,我们强烈建议优先使用 git-sparse-checkout[1] 而不是底层的 update-index 和 read-tree 原语。

skip-worktree 位的主要目的是启用稀疏签出,即拥有只有部分路径存在的工作目录。当设置 skip-worktree 位时,Git 命令(例如 switchpullmerge)将避免写入这些文件。但是,在发生重要情况(例如合并或 rebase 期间的冲突)时,这些命令有时仍会写入这些文件。Git 命令还将避免将这些文件的缺失视为有意删除;例如 git add -u 不会为这些文件暂存删除,git commit -a 也不会通过提交来删除它们。

尽管此位看起来与 assume-unchanged 位相似,但其目标不同。assume-unchanged 位用于保留工作树中的文件,但让 Git 忽略对其的更改检查,并假定文件未被更改(尽管如果 Git 在不 stat 文件的情况下就能确定它已更改,则它可以记录更改)。skip-worktree 告诉 Git 忽略文件的缺失,在可能的情况下避免使用通常会更新大部分工作目录的命令(例如 checkoutswitchpull 等)来更新它,并且不将其缺失记录在提交中。请注意,在稀疏签出(由 git sparse-checkout 设置或通过将 core.sparseCheckout 配置为 true)中,如果索引中标记了 skip-worktree 的文件在工作树中找到,Git 将清除该文件的 skip-worktree 位。

拆分索引

此模式专为具有非常大索引的存储库设计,旨在减少重复写入这些索引所需的时间。

在此模式下,索引被分成两个文件:$GIT_DIR/index 和 $GIT_DIR/sharedindex.<SHA-1>。更改累积在 $GIT_DIR/index(拆分索引)中,而共享索引文件包含所有索引条目并保持不变。

当拆分索引中的条目数量达到 splitIndex.maxPercentChange 配置变量指定 的级别时(请参阅 git-config[1]),所有拆分索引中的更改都会推回到共享索引文件。

每次创建新的共享索引文件时,旧的共享索引文件将在其修改时间早于 splitIndex.sharedIndexExpire 配置变量指定 的时间时被删除(请参阅 git-config[1])。

为了避免删除仍在使用的共享索引文件,每次创建或读取基于该共享索引文件的新拆分索引时,其修改时间都会更新为当前时间。

未跟踪缓存

此缓存旨在加快涉及确定未跟踪文件的命令(例如 git status)的速度。

此功能通过记录工作树目录的 mtime 来工作,然后跳过读取那些 mtime 未发生更改的目录中的目录和对文件的 stat 调用。为了使其正常工作,底层操作系统和文件系统必须更改目录的 st_mtime 字段(如果目录中的文件被添加、修改或删除)。

您可以使用 --test-untracked-cache 选项测试文件系统是否支持此功能。在较旧版本的 Git 中,--untracked-cache 选项会隐式执行此测试,但现在已不再如此。

如果您想启用(或禁用)此功能,使用 core.untrackedCache 配置变量(请参阅 git-config[1])比在每个存储库中使用 git update-index--untracked-cache 选项更容易,特别是如果您想跨所有使用的存储库执行此操作,因为您可以将配置变量设置为 true(或 false)在您的 $HOME/.gitconfig 中只需一次,它就会影响您接触到的所有存储库。

core.untrackedCache 配置变量更改时,下次命令读取索引时,未跟踪缓存将被添加到索引或从索引中删除;而当使用 --[no-|force-]untracked-cache 时,未跟踪缓存会立即添加到索引或从索引中删除。

在 2.17 之前,未跟踪缓存存在一个错误,即用目录的符号链接替换目录可能导致其错误地将 Git 跟踪的文件显示为未跟踪。请参阅 git.git 中“status: add a failing test showing a core.untrackedCache bug”提交。一个解决方法是(这可能对未来未发现的其他错误也有效):

$ git -c core.untrackedCache=false status

这个错误也被证明会影响非符号链接的情况下用文件替换目录,但没有报告过这种情况导致了错误的“git status”输出。

此外,还存在 2.17 之前的 git 版本写入的现有索引引用不存在的目录的情况,这可能导致在“git status”时打印大量“无法打开目录”警告。这些是先前被静默忽略的现有问题的新的警告。

与上述错误一样,解决方案是执行一次“git status”运行,并将 core.untrackedCache 设置为 false,以清除残留的坏数据。

文件系统监视器

此功能旨在加快具有大型工作目录的存储库的 git 操作速度。

它使 git 能够与文件系统监视器(请参阅 git-fsmonitor--daemon[1]githooks[5] 的“fsmonitor-watchman”部分)协同工作,该监视器可以告知它哪些文件已被修改。这使 git 能够避免 lstat() 每个文件来查找已修改的文件。

与未跟踪缓存结合使用时,它可以进一步提高性能,避免扫描整个工作目录以查找新文件的开销。

如果您想启用(或禁用)此功能,使用 core.fsmonitor 配置变量(请参阅 git-config[1])比在每个存储库中使用 git update-index--fsmonitor 选项更容易,特别是如果您想跨所有使用的存储库执行此操作,因为您可以将配置变量设置在您的 $HOME/.gitconfig 中只需一次,它就会影响您接触到的所有存储库。

core.fsmonitor 配置变量更改时,下次命令读取索引时,文件系统监视器将被添加到索引或从索引中删除。当使用 --[no-]fsmonitor 时,文件系统监视器会立即添加到索引或从索引中删除。

配置

该命令遵循 core.filemode 配置变量。如果您的存储库位于一个可执行位不可靠的文件系统上,则应将其设置为 false(请参阅 git-config[1])。这将导致该命令忽略在索引中记录的文件模式和文件系统上的文件模式之间的差异,如果它们仅在可执行位上不同。在这种不幸的文件系统上,您可能需要使用 git update-index --chmod=

同样,如果 core.symlinks 配置变量设置为 false(请参阅 git-config[1]),符号链接将被签出为普通文件,并且此命令不会将记录的文件模式从符号链接更改为常规文件。

该命令查看 core.ignorestat 配置变量。请参阅上面的“使用‘假定未更改’位”部分。

该命令还查看 core.trustctime 配置变量。当 inode 更改时间经常被 Git 之外的某些东西修改时(文件系统爬虫和备份系统使用 ctime 来标记已处理的文件),这可能很有用(请参阅 git-config[1])。

未跟踪缓存扩展可以通过 core.untrackedCache 配置变量启用(请参阅 git-config[1])。

注意事项

用户经常尝试使用 assume-unchanged 和 skip-worktree 位来告诉 Git 忽略已跟踪文件的更改。这并不能按预期工作,因为 Git 在执行某些操作时仍可能将工作树文件与索引进行比较。总的来说,Git 无法提供忽略已跟踪文件更改的方法,因此建议采用其他解决方案。

例如,如果想要更改的文件是某种配置文件,则存储库可以包含一个示例配置文件,然后可以将其复制到要忽略的名称并进行修改。存储库甚至可以包含一个脚本,将示例文件用作模板,自动修改并复制它。

GIT

Git[1] 套件的一部分