mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'mh/doc-commit-title-not-subject'

Browse Source 
The documentation of "git commit" and "git rebase" now refer to
commit titles as such, not "subject".

* mh/doc-commit-title-not-subject:
  doc: use 'title' consistently
This commit is contained in:
Junio C Hamano
2025-02-25 14:19:36 -08:00
parent a8a5bb1f78 c2d96bc42c
commit 37b34c4e99
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/git-commit.adoc
View File

@ -98,8 +98,8 @@ OPTIONS
replaces the log message of _<commit>_ with its own log message replaces the log message of _<commit>_ with its own log message
but makes no changes to the content of _<commit>_. but makes no changes to the content of _<commit>_.
+ +
The commit created by plain `--fixup=<commit>` has a subject The commit created by plain `--fixup=<commit>` has a title
composed of "fixup!" followed by the subject line from _<commit>_, composed of "fixup!" followed by the title of _<commit>_,
and is recognized specially by `git rebase --autosquash`. The `-m` and is recognized specially by `git rebase --autosquash`. The `-m`
option may be used to supplement the log message of the created option may be used to supplement the log message of the created
commit, but the additional commentary will be thrown away once the commit, but the additional commentary will be thrown away once the
@ -107,7 +107,7 @@ commit, but the additional commentary will be thrown away once the
`git rebase --autosquash`. `git rebase --autosquash`.
+ +
The commit created by `--fixup=amend:<commit>` is similar but its The commit created by `--fixup=amend:<commit>` is similar but its
subject is instead prefixed with "amend!". The log message of title is instead prefixed with "amend!". The log message of
_<commit>_ is copied into the log message of the "amend!" commit and _<commit>_ is copied into the log message of the "amend!" commit and
opened in an editor so it can be refined. When `git rebase opened in an editor so it can be refined. When `git rebase
--autosquash` squashes the "amend!" commit into _<commit>_, the --autosquash` squashes the "amend!" commit into _<commit>_, the
@ -128,7 +128,7 @@ See linkgit:git-rebase[1] for details.
`--squash=<commit>`:: `--squash=<commit>`::
Construct a commit message for use with `git rebase --autosquash`. Construct a commit message for use with `git rebase --autosquash`.
The commit message subject line is taken from the specified The commit message title is taken from the specified
commit with a prefix of "squash! ". Can be used with additional commit with a prefix of "squash! ". Can be used with additional
commit message options (`-m`/`-c`/`-C`/`-F`). See commit message options (`-m`/`-c`/`-C`/`-F`). See
linkgit:git-rebase[1] for details. linkgit:git-rebase[1] for details.

8
Documentation/git-rebase.adoc
View File

@ -599,11 +599,11 @@ See also INCOMPATIBLE OPTIONS below.
--no-autosquash:: --no-autosquash::
Automatically squash commits with specially formatted messages into Automatically squash commits with specially formatted messages into
previous commits being rebased. If a commit message starts with previous commits being rebased. If a commit message starts with
"squash! ", "fixup! " or "amend! ", the remainder of the subject line "squash! ", "fixup! " or "amend! ", the remainder of the title
is taken as a commit specifier, which matches a previous commit if it is taken as a commit specifier, which matches a previous commit if it
matches the subject line or the hash of that commit. If no commit matches the title or the hash of that commit. If no commit
matches fully, matches of the specifier with the start of commit matches fully, matches of the specifier with the start of commit
subjects are considered. titles are considered.
+ +
In the rebase todo list, the actions of squash, fixup and amend commits are In the rebase todo list, the actions of squash, fixup and amend commits are
changed from `pick` to `squash`, `fixup` or `fixup -C`, respectively, and they changed from `pick` to `squash`, `fixup` or `fixup -C`, respectively, and they
@ -613,7 +613,7 @@ be used to review and edit the todo list before proceeding.
The recommended way to create commits with squash markers is by using the The recommended way to create commits with squash markers is by using the
`--squash`, `--fixup`, `--fixup=amend:` or `--fixup=reword:` options of `--squash`, `--fixup`, `--fixup=amend:` or `--fixup=reword:` options of
linkgit:git-commit[1], which take the target commit as an argument and linkgit:git-commit[1], which take the target commit as an argument and
automatically fill in the subject line of the new commit from that. automatically fill in the title of the new commit from that.
+ +
Setting configuration variable `rebase.autoSquash` to true enables Setting configuration variable `rebase.autoSquash` to true enables
auto-squashing by default for interactive rebase. The `--no-autosquash` auto-squashing by default for interactive rebase. The `--no-autosquash`