Git:commit 命令

Nov 1, 2021

目录


ref: https://git-scm.com/docs/git-commit


命令


1git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
2       [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
3       [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
4       [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
5       [--date=<date>] [--cleanup=<mode>] [--[no-]status]
6       [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
7       [(--trailer <token>[(=|:)<value>])] [-S[<keyid>]]
8       [--] [<pathspec>…]

git-commit - Record changes to the repository


描述


基于当前索引(index)中的内容创建一个新的提交(commit),可以指定额外的提交消息用于描述当前提交的改动。 新的提交是当前 HEAD 的直接子提交,通常指向当前分支的最新版本,当前分支也会被更新(除非当前工作目录没有和分支关联, 这种情况 HEAD 称为 detached 状态,参考 git-checkout)。

提交的内容可以通过以下形式指定:

  1. 在使用 commit 命令之前使用 add 命令添加内容到索引当中。
  2. 在使用 commit 命令之前使用 git-rm 命令从当前索引和工作目录中移除文件。
  3. 通过列出文件作为 commit 命令的参数。 在这种情况下,git 会忽略当前索引中的修改,取而代之使用指定的文件内容。 指定的文件必须是 git 已知的文件。
  4. 通过使用 commit 命令搭配 -a 选项来自动添加所有 git 已知的文件(比如,所有已经在索引中的文) 和索引中被删除的文件,然后执行最终的提交。
  5. 通过使用 commit 命令搭配 --interactive或者--patch 选项来一个一个的决定那些文件,文件修改的块儿应该被提交。

如果你在创建一个的新的提交的时候,出现了错误,此时,你可以通过使用 git reset 来从这个错误中恢复过来。


选项


  • -a
  • --all

指定自动包含所有修改的和删除的文件。 但是不包含那些还没有添加到索引的新文件。

  • -p
  • --patch

使用交互式补丁选择界面(interactive patch selection interface)来选择要提交的更改。 参考 git-add.

  • -C
  • --reuse-message=<commit>

使用一个现有的提交的提交日志消息和作者身份信息(包括时间戳)。

  • -c
  • --reedit-message=<commit>

-C 类似,但是 -c 在提交之前可以编辑提交日志消息

  • --fixup=[(amend|reword):]<commit>

Create a new commit which “fixes up” when applied with git rebase –autosquash. Plain –fixup= creates a “fixup!” commit which changes the content of but leaves its log message untouched. –fixup=amend: is similar but creates an “amend!” commit which also replaces the log message of with the log message of the “amend!” commit. –fixup=reword: creates an “amend!” commit which replaces the log message of with its own log message but makes no changes to the content of .

The commit created by plain –fixup= has a subject composed of “fixup!” followed by the subject line from , and is recognized specially by git rebase –autosquash. The -m option may be used to supplement the log message of the created commit, but the additional commentary will be thrown away once the “fixup!” commit is squashed into by git rebase –autosquash.

The commit created by –fixup=amend: is similar but its subject is instead prefixed with “amend!”. The log message of is copied into the log message of the “amend!” commit and opened in an editor so it can be refined. When git rebase –autosquash squashes the “amend!” commit into , the log message of is replaced by the refined log message from the “amend!” commit. It is an error for the “amend!” commit’s log message to be empty unless –allow-empty-message is specified.

–fixup=reword: is shorthand for –fixup=amend: –only. It creates an “amend!” commit with only a log message (ignoring any changes staged in the index). When squashed by git rebase –autosquash, it replaces the log message of without making any other changes.

Neither “fixup!” nor “amend!” commits change authorship of when applied by git rebase –autosquash. See git-rebase[1] for details.

  • --squash=<commit>

创建一个在 rebase --autosquash 中使用的提交消息。 新创建的提交的第一行来自指定的提交,并且添加一个前缀 squash!。 可以和其他选项(-m/-c/-C/-F) 搭配使用。 参考 git-rebase.

  • --reset-author

当使用 -C/-c/--amend 选项或者在一个冲突的 cherry-pick 之后,提交时使用此选项修改 author 相关信息。

When used with -C/-c/–amend options, or when committing after a conflicting cherry-pick, declare that the authorship of the resulting commit now belongs to the committer. This also renews the author timestamp.

  • --short

当使用 dry-run 时,指定输出简短格式的信息。 参考 git-status。 这个指令隐含指定 --dry-run

  • --branch

显示分支和跟踪信息,即使指定了 --short

  • --porcelain

当使用 dry-run 时,指定输出供机器读取的格式的信息。 参考 git-status。 这个指令隐含指定 --dry-run

  • --long

当使用 dry-run 时,指定输出详细格式的信息。 这个指令隐含指定 --dry-run

  • -z
  • --null

当显示 short 或者 porcelain 格式的状态输出时,逐字输出文件名,并使用 NU L而不是LF 作为终止符。

  • -F <file>
  • --file=<file>

从给定的文件读取提交日志消息。使用 - 从标准输入读取提交日志消息。

  • --author=<author>

覆盖默认的提交作者。

  • --date=<date>

覆盖默认的作者提交时间

  • -m <msg>
  • --message=<msg>

使用指定的 <msg> 作为提交日志信息。 如果指定了多个 <msg>, 这些提交消息会被作为不同段落拼接起来作为最终提交日志消息。

不能和 -c, -C-F 一起使用。

  • -t <file>
  • --template=<file>

在编辑提交消息时,使用给定文件中的内容启动编辑器。

  • -s
  • --signoff
  • --no-signoff

在提交消息的末尾添加 Signed-off-by 信息。 它的含义取决于你的修改将要提交到的仓库。 比如,它可以用来你被授权了提交修改到仓库,并且表示你有提交修改的权限。

  • --trailer <token>=[(=|:)<value>]

指定一个 (<token>, <value>) 对添加到提交消息的末尾。

例如:

1git commit --trailer "Signed-off-by:C O Mitter \ <committer@example.com>" --trailer "Helped-by:C O Mitter \ <committer@example.com>"

将会在提交消息的末尾添加 “Signed-off-by” 和 “Helped-by” 消息。

  • -n
  • --no-verify

这个选项绕过了 pre-commit 和 commit-msg hook.

  • --allow-empty

Usually recording a commit that has the exact same tree as its sole parent commit is a mistake, and the command prevents you from making such a commit. This option bypasses the safety, and is primarily for use by foreign SCM interface scripts.

  • --allow-empty-message

Like –allow-empty this command is primarily for use by foreign SCM interface scripts. It allows you to create a commit with an empty commit message without using plumbing commands lik git-commit-tree

  • --cleanup=<mode>

该选项指定在提交之前如何整理提交消息。 合法的值有:

- `strip`
去除行的开头结束空白字符,折叠连续的空行和 #commentary。

- `whitespace` 
和 strip 相同,区别是它会保留 #commentary。

- `verbatim` 
不对消息做认为修改

- `scissors`
Same as whitespace except that everything from (and including) the line found below is truncated, if the message is to be edited. "#" can be customized with core.commentChar.

```
    # ------------------------ >8 ------------------------
```

- `default`
如果消息将会被编辑,和 strip 行为一样; 否则,和 whitespace 一样。
  • -e
  • --edit

来自 -F, -m, -C 的提交日志消息通常被直接用来作为提交消息。 这个选项让你可以编辑这些日志信息。

  • --no-edit

使用指定的提交日志消息,不做任何编辑。

例如,git commit --amend --no-edit 修正一个提交,但不改变它的提交消息。

  • --amend

通过创建一个新的提交来替换当前分支的头。 新的提交具有与当前提交相同的父提交和作者信息(可以使用 --reset-author 取消这种行为)。

它和以下指令的效果相同:

1git reset --soft HEAD^
2... do something else to come up with the right tree ...
3git commit -c ORIG_HEAD
  • --no-post-rewrite

绕过 post-write hook

  • -i
  • --include

在创建一个提交之前,将指定路径的内容添加到索引。

这通常不是您想要的,除非您正在工作于一个冲突合并。

  • -o
  • --only

Make a commit by taking the updated working tree contents of the paths specified on the command line, disregarding any contents that have been staged for other paths. This is the default mode of operation of git commit if any paths are given on the command line, in which case this option can be omitted. If this option is specified together with –amend, then no paths need to be specified, which can be used to amend the last commit without committing changes that have already been staged. If used together with –allow-empty paths are also not required, and an empty commit will be created.

  • --pathspec-from-file=<file>

<file> 形式来指定 pathspec,而不是命令行参数的形式。 如果 <file> 指定为 -, 那么从标准输入读取 pathspec。 pathspec 的元素之间通过 LF 或者 CR/LF 指定。

  • --pathspec-file-nul

仅仅在搭配 --pathspec-from-file 使用才有意义。 使用 NUL 作为 pathspec 的元素之间的分隔符。

  • -u[<mode>]
  • --untracked-files[=<mode>]

显示没有被追踪的文件(untracked files)。

  • -v
  • --verbose

Show unified diff between the HEAD commit and what would be committed at the bottom of the commit message template to help the user describe the commit by reminding what changes the commit has. Note that this diff output doesn’t have its lines prefixed with #. This diff will not be a part of the commit message. See the commit.verbose configuration variable in git-config[1].

If specified twice, show in addition the unified diff between what would be committed and the worktree files, i.e. the unstaged changes to tracked files.

  • -q
  • --quiet

不显示提交摘要消息。

  • --dry-run

不要创建新的提交,仅仅显示将要被提交的文件的列表。

  • --status

Include the output of git-status[1] in the commit message template when using an editor to prepare the commit message. Defaults to on, but can be used to override configuration variable commit.status.

  • --no-status

Do not include the output of git-status[1] in the commit message template when using an editor to prepare the default commit message.

  • -S[<keyid>]
  • --gpg-sign[=<keyid>]
  • --no-gpg-sign

GPG-sign 提交。 keyid 是可选的,默认为提交者的 id。

--

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

  • <pathspec>..

限制受操作影响的路径。


例子


在使用 git add 记录自己的工作时,工作目录中修改文件的内容被临时存储到一个名为“索引”的临时区域。 处于索引中的文件可以使用 git restore --staged <file>来回滚,回滚之后,git add 同时被回滚,这个文件不再参与下一次提交。 工作目录中没有添加到索引的文件不能被回滚。 在用这些命令构建号了要提交的状态之后, 使用 git commit 将所有暂存起来的文件记录下来。

例如:

1edit hello.c
2git rm goodbye.c
3git add hello.c
4git commit

除了每次在修改了文件之后暂存文件修改之外,还可以让 git commit自动识别所有已经被跟踪文件的修改,可以使用 -a 选项:

1edit hello.c
2rm goodbye.c
3git commit -a

如果没有其他修改的情况下, 这个命令的效果和上一个命令完全相同。

git commit -a 会首先检查工作目录中所有修改,发现你修改了 hello.c,删除了 goodbye.c, 然后自动替你指定 git addgit rm

在你暂存了很多文件的修改之后,你想提交其中的一部分, 可以通过给 git commit 指定路径来完成。 当路径指定之后,这个命令只会提交指定文件的修改:

1edit hello.c hello.h
2git add hello.c hello.h
3edit Makefile
4git commit Makefile

上述命令只会提交对于 Makefile 的修改。 其他文件 hello.c 和 hello.h 的修改虽然暂存了,但是不会包含在此次提交中。 他们的修改也不会丢失。 在上述命令之后,你可以这么做:

1git commit

上述命令会将 hello.c 和 hello.h 的修改提交。


END!!!


Tags