Setup and Config
Getting and Creating Projects
Basic Snapshotting
Branching and Merging
Sharing and Updating Projects
Inspection and Comparison
Patching
Debugging
External Systems
Server Admin
Guides
- gitattributes
- Command-line interface conventions
- Everyday Git
- Frequently Asked Questions (FAQ)
- Glossary
- Hooks
- gitignore
- gitmodules
- Revisions
- Submodules
- Tutorial
- Workflows
- All guides...
Administration
Plumbing Commands
- 2.43.0 11/20/23
- 2.42.1 11/02/23
- 2.42.0 08/21/23
- 2.41.0 06/01/23
- 2.40.1 no changes
- 2.40.0 03/12/23
- 2.39.1 → 2.39.3 no changes
- 2.39.0 12/12/22
- 2.38.3 → 2.38.5 no changes
- 2.38.2 12/11/22
- 2.38.1 no changes
- 2.38.0 10/02/22
- 2.37.3 → 2.37.7 no changes
- 2.37.2 08/11/22
- 2.37.1 no changes
- 2.37.0 06/27/22
- 2.36.1 → 2.36.6 no changes
- 2.36.0 04/18/22
- 2.35.1 → 2.35.8 no changes
- 2.35.0 01/24/22
- 2.34.1 → 2.34.8 no changes
- 2.34.0 11/15/21
- 2.33.3 → 2.33.8 no changes
- 2.33.2 03/23/22
- 2.33.1 10/12/21
- 2.32.1 → 2.33.0 no changes
- 2.32.0 06/06/21
- 2.31.1 → 2.31.8 no changes
- 2.31.0 03/15/21
- 2.30.1 → 2.30.9 no changes
- 2.30.0 12/27/20
- 2.29.1 → 2.29.3 no changes
- 2.29.0 10/19/20
- 2.28.1 no changes
- 2.28.0 07/27/20
- 2.27.1 no changes
- 2.27.0 06/01/20
- 2.26.1 → 2.26.3 no changes
- 2.26.0 03/22/20
概述
git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>] [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path] [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare] [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>] [--config-env=<name>=<envvar>] <command> [<args>]
描述
Git是一个快速、可扩展的分布式版本控制系统,它拥有异常丰富的命令集,可以提供高级操作和对内部的完全访问。
请参阅 gittutorial[7] 来开始,然后参阅 giteveryday[7] 获取有用的最小命令集。 Git用户手册 中拥有更为深入的介绍。
在掌握了基本概念之后,你可以回到本页了解Git提供的命令。 你可以通过“git help”命令了解更多关于单个Git命令的信息。 gitcli[7] 手册页面为您提供了命令行命令语法的概述。
最新Git文档的格式化和超链接副本可以在 https://git.github.io/htmldocs/git.html 或 https://git-scm.com/docs上查看。
选项
- -v
- --version
-
打印‘git’程序的Git套件版本。
此选项在内部转换为
git version ...
并接受与git-version[1] 命令相同的选项。如果`--version`后接`--help` 选项,则会优先展示`--version`选项的帮助信息。 - -h
- --help
-
打印概要和最常用的命令列表。如果给出选项`--all`或`--a`,则打印所有可用的命令。如果给出命令,该选项将调出该命令的手册页面。
还有其他选项可以控制手册页面的显示方式。参阅git-help[1]获取更多信息,因为
git --help ...
会在内部转换为git help ...
。 - -C <path>
-
运行时就像git在'<path>'而不是在当前工作目录下启动一样。 当给出多个`-C`选项时,每个后续的非绝对的`-C <path>
都是相对于前一个
-C <path>解释的。 如果'<path>'存在但为空,例如
-C ""`,那么就在当前工作目录启动。这个选项会影响到像`--git-dir`和`--work-tree`这样的需要路径名的选项,因为它们会用`-C`选项设置的工作目录进行相对路径的解释。例如,下面的调用是等价的:
git --git-dir=a.git --work-tree=b -C c status git --git-dir=c/a.git --work-tree=c/b status
- -c <name>=<value>
-
向命令传递一个配置参数。给出的值将覆盖配置文件的值。 <name>的格式应与’git config’列出的格式相同(子键由`.`分隔)。
Note that omitting the
=
ingit -c foo.bar ...
is allowed and setsfoo.bar
to the boolean true value (just like[foo]bar
would in a config file). Including the equals but with an empty value (likegit -c foo.bar= ...
) setsfoo.bar
to the empty string whichgit config --type=bool
will convert tofalse
. - --config-env=<name>=<envvar>
-
像`-c <name>=<value>
一样,给配置变量'<name>'一个值,其中<envvar>是一个环境变量的名字,可以从中获取该环境变量的值。与
-c`不同的是,没有直接将值设置为空字符串的快捷方式,除非环境变量本身就设置为空字符串。 如果`<envvar>在环境变量中不存在,则会报错。
<envvar>可能不包含等号,以避免与包含等号的
<name>`产生歧义。This is useful for cases where you want to pass transitory configuration options to git, but are doing so on operating systems where other processes might be able to read your command line (e.g.
/proc/self/cmdline
), but not your environment (e.g./proc/self/environ
). That behavior is the default on Linux, but may not be on your system.请注意,这可能会增加变量的安全性,例如`http.extraHeader`,因为他的敏感信息包含在值中,但并不会增加例如`url.<base>.insteadOf`这种变量的安全性,因为其敏感信息可能会包含在部分键中。
- --exec-path[=<path>]
-
安装Git核心程序的路径。 这也可以通过设置 GIT_EXEC_PATH 环境变量来控制。如果没有给出路径,'git’会打印当前的设置,然后退出。
- --html-path
-
打印Git的HTML文档的安装路径(尾部不带斜杠)然后退出。
- --man-path
-
打印该版本Git man page的manpath(参阅`man(1)`),然后退出。
- --info-path
-
打印记录该版本Git信息文件的安装路径并退出。
- -p
- --paginate
-
如果标准输出是一个终端,则将所有的输出输出到’less(git默认的分页器)'(如果设置,则为$PAGER)中。 这会覆盖`pager.<cmd>`配置选项(参阅下面的 "配置机制 "部分)。
- -P
- --no-pager
-
不使用分页器进行Git的输出。
- --git-dir=<path(文件路径)>
-
设置存储库的路径(".git "目录)。这也可以通过设置`GIT_DIR`环境变量来控制。<path>可以是绝对路径或是当前工作目录的相对路径。
使用该选项(或`GIT_DIR`环境变量)指定".git "目录的位置,这会关闭对带有".git "子目录仓库的扫描(这是找到仓库和顶级工作区的方式),并告诉 Git 当前在顶级工作区。 如果当前并不在工作区的顶级目录,你应该用`--work-tree=<path>`选项(或`GIT_WORK_TREE`环境变量)告诉Git顶级工作区在哪里。
如果你只是想在`<path>
中运行Git,可以使用`git -C <path>
。 - --work-tree=<path(文件路径)>
-
设置工作树的路径。<path>可以是一个绝对路径或与当前工作目录相对的路径。 这也可以通过设置 GIT_WORK_TREE 环境变量和 core.worktree 配置变量来控制(参阅git-config[1] 中的 core.worktree获取更为详细的论述)。
- --namespace=<path>
-
设置 Git 命名空间。 参阅 gitnamespaces[7] 以了解更多细节。 这相当于设置
GIT_NAMESPACE
环境变量。 - --bare
-
将该仓库视为裸仓库。 如果没有设置GIT_DIR环境变量,它将在当前工作目录生成仓库。
- --no-replace-objects
-
不使用候补引用来替换 Git 对象。更多信息参阅 git-replace[1]。
- --literal-pathspecs
-
按字面意思处理路径规格(即不使用通配符,不使用路径规范功能)。 这相当于将`GIT_LITERAL_PATHSPECS`环境变量设置为`1`。
- --glob-pathspecs
-
在所有的路径规范中添加 "glob"功能。这相当于将`GIT_GLOB_PATHSPECS`环境变量设置为`1`。在单个路径规格上禁用通配符可以用路径规范功能":(literal) "来完成。
- --noglob-pathspecs
-
在所有路径规范中添加 "literal"功能。这相当于将`GIT_NOGLOB_PATHSPECS`环境变量设为`1`。在单个路径规范上启用通配符功能,可以使用路径规范功能":(glob) "来完成。
- --icase-pathspecs
-
在所有的路径规范中添加 "icase "功能。这相当于将`GIT_ICASE_PATHSPECS`环境变量设置为`1`。
- --no-optional-locks
-
禁止执行需要锁的可选操作。这相当于将`GIT_OPTIONAL_LOCKS`设置为`0'。
- --list-cmds=group[,group…]
-
按组列出命令。这是一个内部/实验性的选项,将来可能会改变或删除。支持的组有:buildins、parseopt(使用parse-options的内置命令)、main(libexec目录下的所有命令)、others(`$PATH`中其他带有git-前缀的命令)、list-<category>(参阅command-list.txt中的目录【原文是这么说的,但是下面那个Git命令章节已经列出了所有命令列表】)、nohelpers(排除辅助命令)、alias和config(在配置completion.commands中检索命令列表)
- --attr-source=<tree-ish>
-
Read gitattributes from <tree-ish> instead of the worktree. See gitattributes[5]. This is equivalent to setting the
GIT_ATTR_SOURCE
environment variable.
上层封装命令(瓷件)
我们将瓷件命令分为主要命令和一些辅助性的用户工具。
主要瓷件命令
- git-add[1]
-
Add file contents to the index.
- git-am[1]
-
从一个邮箱中应用一系列的补丁。
- git-archive[1]
-
从一个命名的目录中创建一个文件档案。
- git-bisect[1]
-
使用二进制搜索查找引入错误的提交。
- git-branch[1]
-
列出、创建或删除分支。
- git-bundle[1]
-
通过存档移动对象和引用。
- git-checkout[1]
-
切换分支或恢复工作区文件。
- git-cherry-pick[1]
-
应用一些现有的提交所带来的变化。
- git-citool[1]
-
Graphical alternative to git-commit.
- git-clean[1]
-
从工作区上删除未跟踪的文件。
- git-clone[1]
-
Clone a repository into a new directory.
- git-commit[1]
-
记录对仓库的更改。
- git-describe[1]
-
根据一个可用的引用,给一个对象易于理解的名字。
- git-diff[1]
-
显示提交之间的变化,提交和工作区,等。
- git-fetch[1]
-
从另一个仓库下载对象和引用。
- git-format-patch[1]
-
为提交电子邮件准备补丁。
- git-gc[1]
-
清理不必要的文件,优化本地仓库。
- git-grep[1]
-
打印符合模式的行。
- git-gui[1]
-
Git的可移植图形界面。
- git-init[1]
-
Create an empty Git repository or reinitialize an existing one.
- git-log[1]
-
展示提交日志。
- git-maintenance[1]
-
运行任务来优化Git存储库的数据。
- git-merge[1]
-
将两个或更多的开发历史连接在一起。
- git-mv[1]
-
移动或重命名一个文件、一个目录或一个符号链接。
- git-notes[1]
-
添加或检查对象注释。
- git-pull[1]
-
从另一个仓库或本地分支获取并整合。
- git-push[1]
-
更新远程仓库引用和相关对象。
- git-range-diff[1]
-
比较两个提交范围(例如一个分支的两个版本)。
- git-rebase[1]
-
在另一个基础提示的基础上重新提交。
- git-reset[1]
-
重置当前HEAD到指定状态。
- git-restore[1]
-
恢复工作区文件。
- git-revert[1]
-
还原一些现有的提交。
- git-rm[1]
-
从工作区和索引中删除文件。
- git-shortlog[1]
-
Summarize git log output.
- git-show[1]
-
展示各种类型的对象。
- git-sparse-checkout[1]
-
将你的工作区减少到一个被跟踪的文件子集。
- git-stash[1]
-
把这些变化贮藏在一个脏工作目录中。
- git-status[1]
-
显示工作区状态。
- git-submodule[1]
-
初始化、更新或检查子模块。
- git-switch[1]
-
切换分支。
- git-tag[1]
-
Create, list, delete or verify a tag object signed with GPG.
- git-worktree[1]
-
管理多个工作区。
- gitk[1]
-
Git 仓库浏览器。
- scalar[1]
-
A tool for managing large Git repositories.
辅助命令
控制相关:
- git-config[1]
-
获取和设置存储库或全局选项。
- git-fast-export[1]
-
Git 数据导出器。
- git-fast-import[1]
-
快速 Git 数据导入器的后端。
- git-filter-branch[1]
-
重写分支。
- git-mergetool[1]
-
运行合并冲突解决工具来解决合并冲突。
- git-pack-refs[1]
-
包装头和标签用于有效的仓库访问。
- git-prune[1]
-
从对象数据库中修剪所有不可达的对象。
- git-reflog[1]
-
管理reflog信息。
- git-remote[1]
-
管理一组被跟踪的仓库。
- git-repack[1]
-
在存储库中打包未打包的对象。
- git-replace[1]
-
创建、列出、删除替换对象的引用。
审阅相关:
- git-annotate[1]
-
用提交信息来注释文件行。
- git-blame[1]
-
显示文件的每一行最后修改的版本和作者。
- git-bugreport[1]
-
收集信息,以便用户提交错误报告。
- git-count-objects[1]
-
计数对象的解包数量和它们的磁盘消耗。
- git-diagnose[1]
-
生成一个诊断信息的压缩文件。
- git-difftool[1]
-
使用常见的差异工具显示变化。
- git-fsck[1]
-
验证数据库中的对象的连接性和有效性。
- git-help[1]
-
显示有关Git的帮助信息。
- git-instaweb[1]
-
在gitweb中浏览您的工作存储库。
- git-merge-tree[1]
-
Perform merge without touching index or working tree.
- git-rerere[1]
-
重新使用记录的冲突合并的解决方案。
- git-show-branch[1]
-
显示分支和它们的提交。
- git-verify-commit[1]
-
检查提交的GPG签名。
- git-verify-tag[1]
-
检查tag的GPG签名。
- git-version[1]
-
Display version information about Git.
- git-whatchanged[1]
-
显示每次提交带来的差异的日志。
- gitweb[1]
-
Git web interface (web frontend to Git repositories).
与其他应用交互
这些命令是为了与外部SCM(源代码管理工具)以及通过电子邮件与其他人进行交互。
- git-archimport[1]
-
导入一个GNU Arch仓库到Git。
- git-cvsexportcommit[1]
-
导出单次commit到CVS checkout。
- git-cvsimport[1]
-
把你的数据从另一个人们爱恨交加的 SCM 中解救出来。
- git-cvsserver[1]
-
用于Git的CVS服务器模拟器。
- git-imap-send[1]
-
Send a collection of patches from stdin to an IMAP folder.
- git-p4[1]
-
从 Perforce 存储库导入和提交。
- git-quiltimport[1]
-
将 quilt 补丁集应用到当前分支
- git-request-pull[1]
-
生成一个悬而未决的更改摘要。
- git-send-email[1]
-
以电子邮件的形式发送补丁集合。
- git-svn[1]
-
Bidirectional operation between a Subversion repository and Git.
重置、恢复和还原
包括了三个名称相似的命令:git reset
、git restore`和`git revert
。
-
git-revert[1] 是关于进行新的提交,以还原其他提交所做的更改。
-
git-restore[1] 是有关从索引或其他提交中恢复工作区中文件的命令。这个命令不会更新你的分支。该命令也可以用来从另一个提交中恢复索引中的文件。
-
git-reset[1] 是有关更新分支、移动提示的命令,以便从分支中添加或删除提交。这个操作会修改提交历史。
`git reset`也可以用来恢复索引,这个功能`git restore`的功能有些重合。
底层核心命令(管件)
尽管 Git 包含了它自己的瓷件层,但它的底层核心命令足以支持替代瓷件的开发。 此类瓷件开发者可以从阅读 git-update-index[1] 和 git-read-tree[1] 开始。
这些底层命令的界面(输入、输出、选项集和语义)要比上层封装命令稳定得多,因为这些命令主要是用于脚本的使用。 另一方面,为了改善终端用户的体验,上层封装命令接口是可以改变的。
下面的描述将底层核心命令分为操作对象(在存储库、索引和工作树中)的命令、审阅和比较对象的命令,以及在存储库之间移动对象和引用的命令。
控制命令
- git-apply[1]
-
Apply a patch to files and/or to the index.
- git-checkout-index[1]
-
从索引中复制文件到工作目录。
- git-commit-graph[1]
-
编写并验证Git commit-graph文件。
- git-commit-tree[1]
-
创建一个新的提交对象。
- git-hash-object[1]
-
Compute object ID and optionally creates a blob from a file.
- git-index-pack[1]
-
为现有的打包档案建立打包索引文件。
- git-merge-file[1]
-
运行一个三向文件合并。
- git-merge-index[1]
-
为需要合并的文件运行合并程序。
- git-mktag[1]
-
创建一个具有额外验证功能的标签对象。
- git-mktree[1]
-
Build a tree-object from ls-tree formatted text.
- git-multi-pack-index[1]
-
编写和验证多包索引。
- git-pack-objects[1]
-
创建一个打包的对象档案。
- git-prune-packed[1]
-
删除已经存在于包文件中的额外对象。
- git-read-tree[1]
-
将目录树的信息读入索引。
- git-symbolic-ref[1]
-
读取、修改和删除符号引用。
- git-unpack-objects[1]
-
从打包的档案中解压对象。
- git-update-index[1]
-
将工作区中的文件内容登记到索引中。
- git-update-ref[1]
-
安全地更新存储在引用中的对象名称。
- git-write-tree[1]
-
从当前索引创建一个树形对象。
审阅命令
- git-cat-file[1]
-
为仓库对象提供内容或类型和大小信息。
- git-cherry[1]
-
查找尚未应用于上游仓库的提交。
- git-diff-files[1]
-
比较工作区和索引中的文件。
- git-diff-index[1]
-
将目录树与工作目录或索引进行比较。
- git-diff-tree[1]
-
Compares the content and mode of blobs found via two tree objects.
- git-for-each-ref[1]
-
Output information on each ref.
- git-for-each-repo[1]
-
在一个仓库列表上运行一个 Git 命令。
- git-get-tar-commit-id[1]
-
从使用git archive创建的存档中提取commit ID。
- git-ls-files[1]
-
显示索引和工作区中的文件信息。
- git-ls-remote[1]
-
列出远程仓库中的引用。
- git-ls-tree[1]
-
列出一个树对象的内容。
- git-merge-base[1]
-
尽可能找到好的共同祖先进行合并。
- git-name-rev[1]
-
为给定的 revs 寻找符号名称。
- git-pack-redundant[1]
-
寻找多余的包文件。
- git-rev-list[1]
-
按时间顺序倒序列出提交对象。
- git-rev-parse[1]
-
挑选并按摩参数。
- git-show-index[1]
-
显示打包的档案索引。
- git-show-ref[1]
-
列出本地仓库中的引用。
- git-unpack-file[1]
-
创建包含blob内容的临时文件。
- git-var[1]
-
Show a Git logical variable.
- git-verify-pack[1]
-
Validate packed Git archive files.
一般来说,审阅命令不接触工作区中的文件。
同步仓库
- git-daemon[1]
-
一个非常简单的Git存储库服务器。
- git-fetch-pack[1]
-
从另一个仓库接收丢失的对象。
- git-http-backend[1]
-
Server side implementation of Git over HTTP.
- git-send-pack[1]
-
通过Git协议将对象推送到另一个存储库。
- git-update-server-info[1]
-
更新辅助信息文件以帮助哑服务器。
以下是上面使用的辅助命令,终端用户一般不会直接使用这些命令。
- git-http-fetch[1]
-
通过HTTP从远程Git存储库下载。
- git-http-push[1]
-
通过HTTP/DAV将对象推送到另一个存储库。
- git-receive-pack[1]
-
接收推送到仓库的内容。
- git-shell[1]
-
Git-only SSH 通道使用的限制登录脚本。
- git-upload-archive[1]
-
将归档文件发送回git-archive。
- git-upload-pack[1]
-
将打包的对象发送回git-fetch-pack。
内部辅助命令
这些是其他命令使用的内部辅助命令;终端用户一般不会直接使用这些命令。
- git-check-attr[1]
-
显示属性信息。
- git-check-ignore[1]
-
调试gitignore/排除文件。
- git-check-mailmap[1]
-
显示联系人的规范名称和电子邮件地址。
- git-check-ref-format[1]
-
确保一个引用名称是否规范。
- git-column[1]
-
以列显示数据。
- git-credential[1]
-
检索和存储用户凭证。
- git-credential-cache[1]
-
用于在内存中临时存储密码的助手。
- git-credential-store[1]
-
帮助在磁盘上存储凭证。
- git-fmt-merge-msg[1]
-
产生一个合并提交信息。
- git-hook[1]
-
运行 git hooks。
- git-interpret-trailers[1]
-
在提交信息中添加或解析结构化信息。
- git-mailinfo[1]
-
从单一的电子邮件中提取补丁和作者。
- git-mailsplit[1]
-
简单的 UNIX mbox 拆分器程序。
- git-merge-one-file[1]
-
与git-merge-index一起使用的标准帮助程序。
- git-patch-id[1]
-
为补丁计算唯一的主键ID。
- git-sh-i18n[1]
-
Git的i18n(国际化)安装代码- shell脚本.
- git-sh-setup[1]
-
通用Git shell脚本安装代码。
- git-stripspace[1]
-
删除不必要的空白。
指南
以下文档页是关于Git概念的指南。
- gitcore-tutorial[7]
-
面向开发者的 Git 核心教程。
- gitcredentials[7]
-
向 Git 提供用户名和密码。
- gitcvs-migration[7]
-
为 CVS 用户提供的 Git。
- gitdiffcore[7]
-
调整差异输出。
- giteveryday[7]
-
一套有用的最小化 Git 命令集。
- gitfaq[7]
-
关于使用 Git 的常见问题。
- gitglossary[7]
-
A Git Glossary.
- gitnamespaces[7]
-
Git namespaces.
- gitremote-helpers[7]
-
与远程仓库互动的辅助程序。
- gitsubmodules[7]
-
将一个存储库挂载在另一个存储库内。
- gittutorial[7]
-
Git入门教程。
- gittutorial-2[7]
-
Git 的教程介绍:第二部分。
- gitworkflows[7]
-
推荐使用 Git 的工作流程概述。
仓库、命令和文件接口
本文档讨论了用户希望直接与之交互的仓库和命令接口。有关标准的更多细节,请参阅git-help[1]中的`--user-formats`。
Warning
|
Missing See original version for this content. |
文件格式、协议和其他开发者接口
本文档讨论了文件格式、线上协议和其他git开发者接口。参阅 git-help[1] 中的`--developer-interfaces`。
Warning
|
Missing See original version for this content. |
配置机制
Git 使用一种简单的文本格式来存储每个仓库和每个用户的定制内容。 这样的配置文件可能是像这样:
# # 符号 '#' 或是 ';' 表示本行是注释信息 # ; 核心变量 [core] ; 不信任文件模式 filemode = false ; 用户身份信息 [user] name = "Junio C Hamano" email = "gitster@pobox.com"
各种命令从配置文件中读取并相应地调整其操作。有关配置机制的列表和更多细节,请参阅 git-config[1]。
标识符术语
- <对象>
-
表示任何类型的对象的名称。
- <blob>
-
表示一个数据对象的名称。
- <tree>
-
表示一个树对象名称。
- <commit>
-
表示一个提交对象名称。
- <tree-ish>
-
表示一个树、提交或标签对象的名称。 一个需要<tree-ish>参数的命令最终会对<tree>对象进行操作,但会自动解除对指向<tree>对象的<commit>和<tag>对象的引用。
- <commit-ish>
-
表示一个提交或标记对象的名称。 一个需要<commit-ish>参数的命令最终要对<commit>对象进行操作,但会自动解除对指向<commit>的<tag>对象的引用。
- <类型>
-
表示需要一个对象类型。 目前是其中之一:
blob
、tree
、commit`或`tag
。 - <file>
-
表示一个文件名——几乎总是相对于`GIT_INDEX_FILE`描述的树状结构的根部文件。
符号标识符
文件/目录结构
请参阅 gitrepository-layout[5] 文档。
阅读 githooks[5] 了解关于每个钩子的更多细节。
更高级别的源代码管理工具(SCM)可以在"$GIT_DIR "中提供和管理额外的信息。
术语
请参阅gitglossary[7]。
Environment Variables
各种 Git 命令都会关注环境变量并改变它们的行为。 以"布尔 值"为标记的环境变量,其取值方式与布尔值配置变量相同,例如,"true"、"yes"、"on "和正数被视为 "yes"。
常规变量:
Git仓库
这些环境变量适用于 "所有 "核心的 Git 命令。注:值得注意的是,它们可能被位于Git之上的SCMS使用/覆盖,所以如果之前使用过其他的源代码管理工具。
-
GIT_INDEX_FILE
-
这个环境变量指定了一个备用的索引文件。如果没有指定,则默认使用`$GIT_DIR/index`。
-
GIT_INDEX_VERSION
-
这个环境变量指定在写出索引文件时使用什么版本。 它不会影响现有的索引文件。 默认情况下,索引文件的版本为 2 或 3。参见 git-update-index[1] 获取更多信息。
-
GIT_OBJECT_DIRECTORY
-
如果对象存储目录是通过这个环境变量指定的,那么sha1目录将在该目录下创建 - 否则将使用默认的`$GIT_DIR/objects`目录。
-
GIT_ALTERNATE_OBJECT_DIRECTORIES
-
由于Git对象的不可改变性,旧的对象可以被归档到共享的只读目录中。这个变量指定了一个由": "分隔(在Windows下为"; "分隔)的Git对象目录列表,可以用来搜索Git对象。新的对象将不会写入这些目录中。
以`"
(双引号)开头的条目将被解释为C语言风格字符串路径,去掉前导和后导的双引号,并支持反斜杠转义。例如,
"path-with-\"-and-:-in-it":vanilla-path`有两个路径:path-with-"-and-:-in-it`和`vanilla-path
。 -
GIT_DIR
-
如果设置了`GIT_DIR`环境变量,那么它指定了一个路径来代替默认的`.git`作为仓库库的基础。 `--git-dir`命令行选项也能够设置这个值。
-
GIT_WORK_TREE
-
设置到工作区的根部路径。 这也可以由`--work-tree`命令行选项和core.worktree配置变量设置。
-
GIT_NAMESPACE
-
设置 Git 命名空间;详见 gitnamespaces[7]。 `--namespace`命令行选项也可以设置这个值。
-
GIT_CEILING_DIRECTORIES
-
这应该是一个用冒号分隔的绝对路径列表。 如果设置了,它是一个目录列表,在寻找仓库目录时,Git不应该向上改变目录(chidir)(对于排除缓慢加载的网络目录很有用)。 它不会排除当前工作目录或在命令行或环境中设置的GIT_DIR。 通常情况下,Git 需要读取这个列表中的条目,并解析任何可能存在的符号链接,以便将它们与当前目录进行比较。 然而,如果连这个访问都很慢,你可以在列表中添加一个空条目,告诉Git后面的条目不是符号链接,不需要解析;例如,
GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink
。 -
GIT_DISCOVERY_ACROSS_FILESYSTEM
-
当在一个没有".git "仓库目录的目录下运行时,Git 会尝试在父目录中找到这样的目录来寻找工作区的顶端,但默认情况下它不会跨越文件系统的边界。 这个布尔环境变量可以被设置为 "true",以告诉Git不要在文件系统边界处停止。 和`GIT_CEILING_DIRECTORIES`一样,这不会影响通过`GIT_DIR`或在命令行中设置的明确的仓库目录。
-
GIT_COMMON_DIR
-
如果这个变量被设置为一个路径,通常在$GIT_DIR中的非工作树文件将被从这个路径中取出。工作树中特定的文件,如 HEAD 或 index,则从 $GIT_DIR 取出。详情见 gitrepository-layout[5] 和 git-worktree[1]。这个变量的优先级低于其他路径变量,如 GIT_INDEX_FILE、GIT_OBJECT_DIRECTORY…
-
GIT_DEFAULT_HASH
-
If this variable is set, the default hash algorithm for new repositories will be set to this value. This value is ignored when cloning and the setting of the remote repository is always used. The default is "sha1". See
--object-format
in git-init[1].
Git提交
-
GIT_AUTHOR_NAME
-
在创建提交、标签对象或在编写日志时,作者身份中使用的可读名称。这会覆盖`user.name`和`author.name`配置的值。
-
GIT_AUTHOR_EMAIL
-
在创建提交、标签对象或在编写引用日志时,用以表明作者身份所使用的电子邮件地址。这会覆盖`user.email`和`author.email`的配置值。
-
GIT_AUTHOR_DATE
-
在创建提交、标签对象或在编写引用日志时,用于标注作者修改的日期。有效格式见 git-commit[1]。
-
GIT_COMMITTER_NAME
-
在创建提交、标签对象或在编写引用日志时,提交者身份中使用的可读名称。这会覆盖`user.name`和`committer.name`的配置值。
-
GIT_COMMITTER_EMAIL
-
在创建提交、标签对象或在编写引用日志时,用以表明提交者所使用的电子邮件地址。这会覆盖`user.email`和`author.email`的配置值。
-
GIT_COMMITTER_DATE
-
在创建提交、标签对象或在编写 reflogs 时,用于标注提交者所作修改的日期。有效格式见 git-commit[1]。
-
EMAIL
-
如果没有设置其他相关的环境变量或配置设置,作者和提交者的电子邮件地址会参考该值。
Git差异比较(Diffs)
-
GIT_DIFF_OPTS
-
唯一有效的设置是"--unified=?? "或"-u??",用于设置创建统一的差异时显示的文本行数。 这优先于 Git diff 命令行中传递的任何 "-U" 或 "--unified" 选项值。
-
GIT_EXTERNAL_DIFF
-
当环境变量`GIT_EXTERNAL_DIFF`被设置时,由它命名的程序被调用来生成差异化文本,而不使用Git内置的diff工具。 对于一个被添加、删除或修改的操作,`GIT_EXTERNAL_DIFF`会被调用,一共接收7个参数:
path old-file old-hex old-mode new-file new-hex new-mode
使用:
- <old|new>-file
-
是GIT_EXTERNAL_DIFF用来读取<old|new>内容的文件,
- <old|new>-hex
-
是40个十六进制的SHA-1哈希值,
- <old|new>-mode
-
是文件模式的八进制表示法。
The file parameters can point at the user’s working file (e.g.
new-file
in "git-diff-files"),/dev/null
(e.g.old-file
when a new file is added), or a temporary file (e.g.old-file
in the index).GIT_EXTERNAL_DIFF
should not worry about unlinking the temporary file — it is removed whenGIT_EXTERNAL_DIFF
exits.`GIT_EXTERNAL_DIFF`被调用时,对于未合并的路径可通过<path>进行设置。
在调用每个路径
GIT_EXTERNAL_DIFF
时,都会设置两个环境变量GIT_DIFF_PATH_COUNTER
和GIT_DIFF_PATH_TOTAL
。 -
GIT_DIFF_PATH_COUNTER
-
以 1 为单位的计数器,每条路径递增 1。
-
GIT_DIFF_PATH_TOTAL
-
路径总数。
other
-
GIT_MERGE_VERBOSITY
-
一个数字,用于控制递归合并策略的输出量。 覆盖 merge.verbosity。 参见 git-merge[1]
-
GIT_PAGER
-
该环境变量优先于
$PAGER
。如果设置为空字符串或 "cat",Git 将不会启动分页器。 参见 git-config[1] 中的core.pager
选项。 -
GIT_PROGRESS_DELAY
-
一个数字,用于控制延迟多少秒后才显示可选的进度指示器。默认为 2。
-
GIT_EDITOR
-
该环境变量覆盖
$EDITOR
和$VISUAL
。 有几条 Git 命令在交互模式下启动编辑器时会用到它。参见 git-var[1] 和 git-config[1] 中的core.editor
选项。 -
GIT_SEQUENCE_EDITOR
-
在编辑交互式变基的待办事项列表时,该环境变量会覆盖配置的 Git 编辑器。参见 git-rebase[1] 和 git-config[1] 中的
sequence.editor
选项。 -
GIT_SSH
-
GIT_SSH_COMMAND
-
如果设置了这两个环境变量中的任何一个,git fetch 和 git push 在连接远程系统时就会使用指定的命令而不是 ssh。 传递给配置命令的命令行参数由 ssh 变量决定。 详见 git-config[1] 中的
ssh.variant
选项。$GIT_SSH_COMMAND
优先于$GIT_SSH
,由 shell 解释,允许包含额外参数。 另一方面,$GIT_SSH
必须是一个程序的路径(如果需要额外参数,可以是一个包装 shell 脚本)。通常,通过个人的
.ssh/config
文件配置任何所需的选项会更容易。 详情请查阅 ssh 文档。 -
GIT_SSH_VARIANT
-
如果设置了这个环境变量,Git 会自动检测
GIT_SSH
/GIT_SSH_COMMAND
/core.sshCommand`是否指向 OpenSSH、plink 或 tortoiseplink。该变量覆盖了具有相同作用的配置设置 `ssh.variant
。 -
GIT_SSL_NO_VERIFY
-
将此环境变量设置并导出为任意值,Git 就不会在通过 HTTPS 获取或推送数据时验证 SSL 证书。
-
GIT_ATTR_SOURCE
-
设置读取 gitattributes 的书对象。
-
GIT_ASKPASS
-
如果设置了这个环境变量,那么需要获取密码或口令的 Git 命令(例如用于 HTTP 或 IMAP 身份验证)就会调用这个程序,并将合适的提示符作为命令行参数,然后从其 STDOUT 中读取密码。参见 git-config[1] 中的
core.askPass
选项。 -
GIT_TERMINAL_PROMPT
-
如果将此布尔环境变量设为 false,git 将不会在终端上提示(例如,要求 HTTP 认证时)。
-
GIT_CONFIG_GLOBAL
-
GIT_CONFIG_SYSTEM
-
从给定文件中获取配置,而不是从全局或系统级配置文件中获取。如果设置了
GIT_CONFIG_SYSTEM
,则不会读取构建时定义的系统配置文件(通常是/etc/gitconfig
)。同样,如果设置了GIT_CONFIG_GLOBAL
,则既不会读取$HOME/.gitconfig
也不会读取$XDG_CONFIG_HOME/git/config
。可以设置为/dev/null
,以跳过读取相应级别的配置文件。 -
GIT_CONFIG_NOSYSTEM
-
是否跳过从系统范围内的
$(prefix)/etc/gitconfig
文件读取设置。 这个布尔环境变量可以与$HOME
和$XDG_CONFIG_HOME
一起使用,为挑剔的脚本创建一个可预测的环境,也可以设为 true 以暂时避免使用有错误的/etc/gitconfig
文件,等待有足够权限的人来修复它。 -
GIT_FLUSH
-
如果该环境变量设置为 "1",那么诸如 git blame(增量模式)、git rev-list、git log git check-attr 和 git check-ignore 等命令将 会在每条记录被刷新后强制刷新输出流。 强制刷新输出流。如果该 变量设置为 "0",这些命令的输出将使用完全缓冲的 I/O 方式进行 使用完全缓冲的 I/O 输出。 如果不设置这个环境变量 不设置,Git 将根据标准输出流是否重定向到文件,选择缓冲或面向记录的刷新方式 根据标准输出流是否被重定向到文件。
-
GIT_TRACE
-
启用一般跟踪信息,如别名扩展、内置命令执行和外部命令执行。
如果该变量设置为 "1"、"2" 或 "true"(比较不区分大小写),跟踪信息将被打印到标准错误流。
如果变量设置为大于 2 小于 10(严格意义上)的整数值,那么 Git 会将该值解释为一个打开的文件描述符,并尝试将跟踪信息写入该文件描述符。
另外,如果变量设置为绝对路径(以 / 字符开头),Git 会将其理解为文件路径,并尝试将跟踪信息附加到该路径上。
取消对变量的设置,或将其设置为空、"0" 或 "false"(不区分大小写),将禁用跟踪信息。
-
GIT_TRACE_FSMONITOR
-
启用文件系统监视器扩展的跟踪信息。 有关可用的跟踪输出选项,请参阅
GIT_TRACE
。 -
GIT_TRACE_PACK_ACCESS
-
启用对所有数据包访问的跟踪信息。每次访问都会记录包文件名和包中的偏移量。这可能有助于排除一些与包相关的性能问题。 有关可用的跟踪输出选项,请参阅
GIT_TRACE
。 -
GIT_TRACE_PACKET
-
启用对进出指定程序的所有数据包的跟踪信息。这有助于调试对象协商或其他协议问题。以 "PACK" 开头的数据包会关闭跟踪(但请参阅下文的
GIT_TRACE_PACKFILE
)。 有关可用的跟踪输出选项,请参见GIT_TRACE
。 -
GIT_TRACE_PACKFILE
-
可跟踪指定程序发送或接收的打包文件。与其他跟踪输出不同,这种跟踪是逐字的:没有标题,也不引用二进制数据。你几乎肯定希望将其直接存入一个文件(例如
GIT_TRACE_PACKFILE=/tmp/my.pack
),而不是显示在终端上或与其他跟踪输出混在一起。请注意,目前仅在克隆和获取的客户端实施了这一功能。
-
GIT_TRACE_PERFORMANCE
-
启用与性能相关的跟踪信息,例如每条 Git 命令的总执行时间。 有关可用的跟踪输出选项,请参见
GIT_TRACE
。 -
GIT_TRACE_REFS
-
启用引用数据库操作的跟踪信息。 有关可用的跟踪输出选项,请参见
GIT_TRACE
。 -
GIT_TRACE_SETUP
-
在 Git 完成设置阶段后,启用打印 .git、工作树和当前工作目录的跟踪信息。 有关可用的跟踪输出选项,请参见
GIT_TRACE
。 -
GIT_TRACE_SHALLOW
-
启用可帮助调试获取/克隆浅仓库的跟踪信息。 有关可用的跟踪输出选项,请参见
GIT_TRACE
。 -
GIT_TRACE_CURL
-
启用对 git 传输协议所有传入和传出数据(包括描述性信息)的 curl 完整跟踪转储。 这类似于在命令行上执行 curl
--trace-ascii
。 有关可用的跟踪输出选项,请参阅GIT_TRACE
。 -
GIT_TRACE_CURL_NO_DATA
-
启用 curl 跟踪时(见上文
GIT_TRACE_CURL
),不要转储数据(即只转储信息行和头文件)。 -
GIT_TRACE2
-
启用来自 "trace2" 库的更详细的跟踪信息。
GIT_TRACE2
的输出是一种简单的文本格式,便于人类阅读。如果该变量设置为 "1"、"2" 或 "true"(比较不区分大小写),跟踪信息将被打印到标准错误流。
如果变量设置为大于 2 小于 10(严格意义上)的整数值,那么 Git 会将该值解释为一个打开的文件描述符,并尝试将跟踪信息写入该文件描述符。
另外,如果变量设置为绝对路径(以 / 字符开头),Git 会将其理解为文件路径,并尝试将跟踪信息附加到该路径上。 如果路径已经存在且是一个目录,跟踪信息将被写入该目录下的文件(每个进程一个),文件名根据 SID 的最后一个分量和一个可选的计数器命名(以避免文件名冲突)。
此外,如果变量设置为
af_unix:[<套接字类型>:]<绝对文件路径>
,Git 将尝试以 Unix 域套接字的方式打开路径。 套接字类型可以是stream
或dgram
。取消对变量的设置,或将其设置为空、"0" 或 "false"(不区分大小写),将禁用跟踪信息。
详见 Trace2 文档。
-
GIT_TRACE2_EVENT
-
此设置会写入适合机器解释的基于 JSON 的格式。 有关可用的跟踪输出选项,请参阅
GIT_TRACE2
,以及 Trace2 文档 了解更多详情。 -
GIT_TRACE2_PERF
-
除了
GIT_TRACE2
中可用的基于文本的信息外,此设置还可写入基于列的格式,以了解嵌套区域。 有关可用的跟踪输出选项,请参阅GIT_TRACE2
,以及 Trace2 文档 了解更多详情。 -
GIT_TRACE_REDACT
-
默认情况下,启动跟踪后,Git 会编辑 cookie、"Authorization:"(授权:)标头、"Proxy-Authorization:"(代理授权:)标头和 packfile URI 的值。将此布尔环境变量设为 false,可阻止这种编辑。
-
GIT_LITERAL_PATHSPECS
-
将这个布尔环境变量设为 true 会导致 Git 按字面意思而非通配符模式来处理所有路径规范。例如,运行
GIT_LITERAL_PATHSPECS=1 git log -- '*.c'
将搜索涉及路径*.c
的提交,而不是任何与 glob*.c
匹配的路径。如果你正在向 Git 输入字面路径(例如,之前由git ls-tree
、--raw
差异输出等提供的路径),你可能需要这样做。 -
GIT_GLOB_PATHSPECS
-
将这个布尔环境变量设置为 true 会导致 Git 将所有路径规范视为通配符模式(又称 "glob" 魔法)。
-
GIT_NOGLOB_PATHSPECS
-
将这个布尔环境变量设置为 true,Git 就会将所有路径规范都视为字面意思(又称 "literal"(字面)魔法)。
-
GIT_ICASE_PATHSPECS
-
将此布尔环境变量设置为 true 会导致 Git 将所有路径规范视为不区分大小写。
-
GIT_REFLOG_ACTION
-
更新引用时,会创建引用日志条目来记录更新引用的原因(通常是更新引用的高级命令的名称),以及引用的新旧值。 脚本化的上层命令可以使用
git-sh-setup
中的 set_reflog_action 辅助函数,在被最终用户作为顶级命令调用时将其名称设置为该变量,并记录在引用日志的正文中。 -
GIT_REF_PARANOIA
-
如果将此布尔环境变量设置为 false,则在遍历引用列表时会忽略已损坏或命名不正确的引用。通常情况下,Git 会尝试包含任何此类引用,这可能会导致某些操作失败。这通常是可取的,因为潜在的破坏性操作(例如 git-prune[1])最好是中止,而不是忽略破损的 refs(从而认为它们指向的历史不值得保存)。默认值是
1
(即偏执地检测并终止所有操作)。通常不需要将其设置为0
,但在试图从损坏的版本库中挽救数据时可能会有用。 -
GIT_ALLOW_PROTOCOL
-
如果设置为以冒号分隔的协议列表,其行为就好像
protocol.allow
被设置为never
而每个列出的协议都被protocol.<名称>.allow
设置为always
(覆盖任何现有配置)。详见 git-config[1] 中关于protocol.allow
的描述。 -
GIT_PROTOCOL_FROM_USER
-
将此布尔环境变量设为 false,以防止 fetch/push/clone 使用配置为
user
状态的协议。 这对于限制从不可信任的仓库或向 git 命令提供可能不可信任的 URLS 的程序递归初始化子模块非常有用。 详见 git-config[1]。 -
GIT_PROTOCOL
-
仅供内部使用。 用于有线协议握手。 包含一个用冒号 : ' 分隔的键列表,可选值为 'key[=value]。 必须忽略未知键和值的存在。
请注意,可能需要对服务器进行配置,以允许该变量通过某些传输方式传递。在访问本地仓库(即
file://
或文件系统路径)以及通过git://
协议时,它会自动传播。对于 git-over-http,它在大多数配置中都会自动工作,但请参阅 git-http-backend[1] 中的讨论。对于 git-over-ssh,可能需要配置 ssh 服务器以允许客户端传递此变量(例如,在 OpenSSH 中使用AcceptEnv GIT_PROTOCOL
)。此配置为可选配置。如果不传播该变量,客户端将退回到原始的 "v0" 协议(但可能会错过某些性能改进或功能)。该变量目前只影响克隆和获取,尚未用于推送(但将来可能会)。
-
GIT_OPTIONAL_LOCKS
-
如果把这个布尔环境变量设置为 false,Git 将在不执行任何需要加锁的可选子操作的情况下完成任何请求的操作。 例如,这将防止
git status
刷新索引的副作用。这对后台运行的进程非常有用,因为它们不希望与版本库中的其他操作造成锁争用。 默认值为1
。 -
GIT_REDIRECT_STDIN
-
GIT_REDIRECT_STDOUT
-
GIT_REDIRECT_STDERR
-
仅限 Windows:允许将标准输入/输出/错误句柄重定向到环境变量指定的路径。这在多线程应用程序中特别有用,因为通过
CreateProcess()
传递标准句柄的标准方式并不可行,因为这需要将句柄标记为可继承(因此 每个 生成的进程都会继承它们,可能会阻塞常规的 Git 操作)。主要的预期用例是使用命名管道进行通信(例如\\.\pipe\my-git-stdin-123
)。支持两个特殊值: 如果
GIT_REDIRECT_STDERR
是2>&1
,标准错误将重定向到与标准输出相同的句柄。 - GIT_PRINT_SHA1_ELLIPSIS(已弃用)
-
如果设置为
yes
,会在 SHA-1 值(缩写)后打印省略号。 这会影响分离 HEAD 的指示(git-checkout[1])和原始差异输出(linkgit:git-diff[1])。 在上述情况下打印省略号不再被认为是适当的,在可预见的将来,对它的支持可能会被移除(连同变量)。
Discussion
有关以下内容的更多详情,请参阅 用户手册中的 Git 概念章节 和 gitcore-tutorial[7]。
Git 项目通常由一个工作目录和一个位于顶层的 ".git " 子目录组成。 除其他内容外,.git 目录还包含一个压缩对象数据库,代表项目的完整历史;一个 "index" 文件,将历史记录与当前工作区的内容相链接;以及指向历史记录的命名指针,如标签和分支头。
对象数据库包含三种主要类型的对象:blobs,用于保存文件数据;tree,用于指向 blobs 和其他树,以建立目录层次结构;commits,用于引用单个树和一定数量的父提交。
提交相当于其他系统所说的 "changeset" 或 "version",代表项目历史中的一个步骤,每个父提交代表紧接着的前一个步骤。 有多个父提交的提交代表独立开发线的合并。
所有对象都以其内容的 SHA-1 哈希值命名,通常写成由 40 个十六进制数字组成的字符串。 这些名称具有全局唯一性。 只需对某个提交进行签名,就能证明该提交之前的整个历史。 为此,我们提供了第四种对象类型——tag(标签)。
首次创建时,对象存储在单个文件中,但为了提高效率,以后可能会压缩成 "pack files"。
被称为引用的命名指针标记着历史上有趣的点。 一个引用可以包含一个对象的 SHA-1 名称或另一个引用的名称。 名称以 ref/head/
开头的引用包含开发中分支的最新提交(或 "head")的 SHA-1 名称。 相关标记的 SHA-1 名称存储在 ref/tags/
下。 名为 HEAD
的特殊引用包含当前已签出分支的名称。
索引文件初始化时包含一个所有路径的列表,以及每个路径的一个二进制对象和一组属性。 二进制对象代表当前分支头部的文件内容。 属性(最后修改时间、大小等)取自工作树中的相应文件。 通过比较这些属性,可以发现工作区的后续更改。 索引可根据新内容进行更新,也可根据索引中存储的内容创建新提交。
索引还能为给定路径名存储多个条目(称为 "stages"(阶段))。 在合并过程中,这些阶段用于保存文件的各种未合并版本。
更多文件
请参阅 “说明” 部分的参考资料,开始使用 Git。 对于初次使用 Git 的用户来说,以下内容可能过于详细。
用户手册中的 Git 概念章节 和 gitcore-tutorial[7] 都介绍了 Git 的底层架构。
请参阅 gitworkflows[7] 了解推荐的工作流程。
另请参阅 howto 文档,了解一些有用的示例。
链接:technical/api-index.html[Git API 文档]中介绍了内部结构。
从 CVS 迁移的用户可能还需要阅读 gitcvs-migration[7]。
Authors
Git 由 Linus Torvalds 发起,目前由 Junio C Hamano 维护。许多贡献来自 Git 邮件列表 <git@vger.kernel.org>。http://www.openhub.net/p/git/contributors/summary 提供了更完整的贡献者名单。
如果克隆了 git.git,git-shortlog[1] 和 git-blame[1] 的输出结果可以显示项目特定部分的作者。
Reporting Bugs
向 Git 邮件列表 <git@vger.kernel.org> 报告错误,开发和维护工作主要在此进行。 您无需订阅该列表即可在此发送信息。 有关以前的错误报告和其他讨论,请参阅 https://lore.kernel.org/git 的列表档案。
与安全相关的问题应在 Git 安全邮件列表 <git-security@googlegroups.com> 中私下披露。
GIT
属于 git[1] 文档