diff options
| author | M Hickford <mirth.hickford@gmail.com> | 2025-02-16 21:02:41 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-02-18 09:56:00 -0800 |
| commit | c2d96bc42cfc358178078d8c2c65d550671d3ed0 (patch) | |
| tree | 9281f22ef3b9474f21b667ff83da37cb3e46a347 /Documentation/git-commit.txt | |
| parent | e2067b49ecaef9b7f51a17ce251f9207f72ef52d (diff) | |
| download | git-c2d96bc42cfc358178078d8c2c65d550671d3ed0.tar.xz | |
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>
Diffstat (limited to 'Documentation/git-commit.txt')
| -rw-r--r-- | Documentation/git-commit.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 602e2f1200..70a5e4a181 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -98,8 +98,8 @@ OPTIONS replaces the log message of _<commit>_ with its own log message but makes no changes to the content of _<commit>_. + -The commit created by plain `--fixup=<commit>` has a subject -composed of "fixup!" followed by the subject line from _<commit>_, +The commit created by plain `--fixup=<commit>` has a title +composed of "fixup!" followed by the title of _<commit>_, 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 @@ -107,7 +107,7 @@ commit, but the additional commentary will be thrown away once the `git rebase --autosquash`. + 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 opened in an editor so it can be refined. When `git rebase --autosquash` squashes the "amend!" commit into _<commit>_, the @@ -128,7 +128,7 @@ See linkgit:git-rebase[1] for details. `--squash=<commit>`:: 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 message options (`-m`/`-c`/`-C`/`-F`). See linkgit:git-rebase[1] for details. |
