doc: use 'title' consistently
The first line of a commit message is variously called 'title' or 'subject'. Prefer 'title' unless discussing email. Signed-off-by: M Hickford <mirth.hickford@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
M Hickford committed
Feb 16, 2025 at 21:02 UTC
c2d96bc42cfc358178078d8c2c65d550671d3ed0
2 files changed
+8
-8
Documentation/git-commit.txt
+4
-4
@@ -98,8 +98,8 @@ OPTIONS
98
replaces the log message of _<commit>_ with its own log message
99
but makes no changes to the content of _<commit>_.
100
+
101
-The commit created by plain `--fixup=<commit>` has a subject
102
-composed of "fixup!" followed by the subject line from _<commit>_,
101
+The commit created by plain `--fixup=<commit>` has a title
102
+composed of "fixup!" followed by the title of _<commit>_,
103
and is recognized specially by `git rebase --autosquash`. The `-m`
104
option may be used to supplement the log message of the created
105
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
107
`git rebase --autosquash`.
108
+
109
The commit created by `--fixup=amend:<commit>` is similar but its
110
-subject is instead prefixed with "amend!". The log message of
110
+title is instead prefixed with "amend!". The log message of
111
_<commit>_ is copied into the log message of the "amend!" commit and
112
opened in an editor so it can be refined. When `git rebase
113
--autosquash` squashes the "amend!" commit into _<commit>_, the
@@ -128,7 +128,7 @@ See linkgit:git-rebase[1] for details.
128
129
`--squash=<commit>`::
130
Construct a commit message for use with `git rebase --autosquash`.
131
- The commit message subject line is taken from the specified
131
+ The commit message title is taken from the specified
132
commit with a prefix of "squash! ". Can be used with additional
133
commit message options (`-m`/`-c`/`-C`/`-F`). See
134
linkgit:git-rebase[1] for details.
Documentation/git-rebase.txt
+4
-4
@@ -599,11 +599,11 @@ See also INCOMPATIBLE OPTIONS below.
599
--no-autosquash::
600
Automatically squash commits with specially formatted messages into
601
previous commits being rebased. If a commit message starts with
602
- "squash! ", "fixup! " or "amend! ", the remainder of the subject line
602
+ "squash! ", "fixup! " or "amend! ", the remainder of the title
603
is taken as a commit specifier, which matches a previous commit if it
604
- matches the subject line or the hash of that commit. If no commit
604
+ matches the title or the hash of that commit. If no commit
605
matches fully, matches of the specifier with the start of commit
606
- subjects are considered.
606
+ titles are considered.
607
+
608
In the rebase todo list, the actions of squash, fixup and amend commits are
609
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.
613
The recommended way to create commits with squash markers is by using the
614
`--squash`, `--fixup`, `--fixup=amend:` or `--fixup=reword:` options of
615
linkgit:git-commit[1], which take the target commit as an argument and
616
-automatically fill in the subject line of the new commit from that.
616
+automatically fill in the title of the new commit from that.
617
+
618
Setting configuration variable `rebase.autoSquash` to true enables
619
auto-squashing by default for interactive rebase. The `--no-autosquash`