git update-index

名字

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]
             [--ignore-submodules]
             [--[no-]split-index]
             [--[no-|test-|force-]untracked-cache]
             [--really-refresh] [--unresolve] [--again | -g]
             [--info-only] [--index-info]
             [-z] [--stdin] [--index-version <n>]
             [--verbose]
             [--] [<file>…​]

描述

修改索引或目录缓存。提到的每个文件都更新到索引中，并清除任何unmerged或needs updating状态。

另请参阅 git-add [1] ，以更友好的方式对索引执行一些最常见的操作。

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

选项

--add

如果指定的文件不在索引中，则会添加它。默认行为是忽略新文件。

--remove

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

--refresh

查看当前索引，并通过检查 stat（）信息来检查是否需要合并或更新。

-q

quiet。如果--refresh发现索引需要更新，则默认行为是错误的。git update-index无论如何，这个选项会继续。

--ignore-submodules

不要尝试更新子模块。此选项仅在通过 --refresh 之前通过。

--unmerged

如果 --refresh 在索引中发现未合并的更改，则默认行为是错误的。git update-index无论如何，这个选项会继续。

--ignore-missing

在 --refresh 时忽略丢失的文件

--cacheinfo <mode>,<object>,<path> --cacheinfo <mode> <object> <path>

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

--index-info

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

--chmod=(+|-)x

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

--no-assume-unchanged

当指定此标志时，为路径记录的对象名称不会更新。相反，该选项设置/取消路径的“假定不变”位。当“假设不变”位打开时，用户承诺不更改文件，并允许 Git 假定工作树文件与索引中记录的内容匹配。如果你想改变工作树文件，你需要取消设置该位以告诉 Git 。当在一个非常缓慢的 lstat（2）系统调用的文件系统（例如 cifs ）上处理大项目时，这有时会很有帮助。

如果需要在索引中修改此文件，例如合并提交时，Git 将失败（正常）因此，如果假设未跟踪的文件在上游发生更改，则需要手动处理该情况。

--really-refresh

喜欢--refresh，但无条件地检查统计信息，而不考虑“假定不变”设置。

--no-skip-worktree

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

-g --again

git update-index在索引条目与HEAD提交不同的路径上运行。

--unresolve

如果文件被意外清除，则在合并期间恢复文件unmerged或needs updating状态。

--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。

版本4执行简单的路径名压缩，可减少大型存储库中的索引大小30％-50％，从而缩短加载时间。版本4相对年轻（2012年10月首次发布于1.8.0）。其他 Git 实现，如 JGit 和 libgit2 可能还不支持它。

-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-cache的core.untrackedCache配置变量手动启用未跟踪的缓存。如果测试失败，退出代码为1，并显示一条消息说明哪些功能无法正常工作，否则退出代码为0并打印 OK 。

--force-untracked-cache

和...一样--untracked-cache。提供与在旧版本的 Git 的向后兼容性--untracked-cache用来暗示--test-untracked-cache，但此选项将无条件地启用该扩展。

--

不要将更多的参数解释为选项。

<file>

要采取行动的文件。请注意，开头的文件将.被丢弃。这包括./file和dir/./file。如果你不想要这个，那么使用更清晰的名字。这同样适用于目录结尾/和路径//

Using --refresh

--refresh不会计算新的 sha1 文件或将索引更新为模式/内容更改。但它确实做的是“重赛”与索引文件的统计信息，这样就可以刷新指数尚未修改的文件，但在统计项是过时的。

例如，你想在做完之后这样做git read-tree，将 stat 索引详细信息与正确的文件关联起来。

Using --cacheinfo or --info-only

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

假设你有一个路径为 mode 和 sha1 的文件，说：

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

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

这两个--cacheinfo和--info-only的行为类似：该指数已经更新，但对象数据库是没有的。--cacheinfo对象位于数据库中但文件不在本地可用时非常有用。--info-only文件可用时非常有用，但不希望更新对象数据库。

Using --index-info

--index-info是一种更强大的机制，可让您从标准输入中提供多个条目定义，并专门为脚本设计。它可以采用三种格式的输入：

1. 模式SP sha1 TAB 路径第一种格式是“git-apply --index-info”报告的内容，并且用于在3路合并时重建用于伪合并基础树的部分树。
2. 模式 SP 类型 SP sha1 TAB 路径第二种格式是将git ls-tree输出填充到索引文件中。
3. 模式 SP sha1 SP 阶段 TAB 路径此格式用于将更高阶段放入索引文件并匹配git ls-files --stage输出。

要将更高级的条目放置到索引中，首先应通过为路径输入 mode = 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配置变量。如果这是真的，路径与更新git update-index paths...，并与其他 Git 的更新路径命令，同时更新索引和工作树（例如git apply --index，git checkout-index -u和git read-tree -u）被自动标记为“假设不变”。请注意，如果找到工作树文件与索引匹配（假如您想将它们标记为“假定不变”），则“假设不变”位未设置。git update-index --refreshgit update-index --really-refresh

例子

To update and refresh only the files already checked out:

$ 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 位可以在一个（长）句子中定义：当读取一个条目时，如果它被标记为 skip-worktree ，那么 Git 会假装它的工作目录版本是最新的并且读取索引版本。

详细说来，“reading” 是指检查文件是否存在，读取文件属性或文件内容。工作目录版本可能存在或不存在。如果存在，其内容可能与索引版本匹配。写作不受此位影响，内容安全仍然是第一要务。请注意，Git can更新工作目录文件，即标记为 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 未更改的目录中的文件。为此st_mtime，如果目录中的文件被添加，修改或删除，底层操作系统和文件系统必须更改目录字段。

您可以测试文件系统是否支持该--test-untracked-cache选项。--untracked-cache用于在 Git 的旧版本中隐式执行该测试的选项，但不再是这种情况。

如果要启用（或禁用）此功能，使用core.untrackedCache配置变量（请参阅 git-config [1] ）比在每个存储库中使用--untracked-cache选项更容易git update-index，尤其是如果您希望跨所有存储库使用此配置变量，因为您可以将配置变量设置为true（或false）$HOME/.gitconfig一次，并使其影响您所触摸的所有存储库。

当core.untrackedCache配置变量发生变化时，在下一次命令读取索引时，未追踪的缓存将添加到索引中或从索引中删除; 而在--[no-|force-]untracked-cache使用时，未跟踪的缓存立即添加到索引或从索引中删除。

组态

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

非常相似，如果core.symlinks配置变量设置为false（参见 git-config [1]），符号链接将作为纯文件检出，并且此命令不会修改从符号链接到常规文件的记录文件模式。

该命令查看core.ignorestat配置变量。参见Using "assume unchanged" bit上面的部分。

该命令还查看core.trustctime配置变量。当 inode 更改时间通过 Git 外部的某些东西（文件系统搜寻器和备份系统使用 ctime 标记处理的文件）定期修改时（参见 git-config [1] ），它会很有用。

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