diff options
| author | Junio C Hamano <gitster@pobox.com> | 2025-02-25 14:19:36 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-02-25 14:19:36 -0800 |
| commit | 37b34c4e99f0fed81b7523d6e674ca976f994afc (patch) | |
| tree | 0693ab25b8fcb49427c520c8216d49ed3e043364 /Documentation/git-commit.adoc | |
| parent | Merge branch 'bc/diff-reject-empty-arg-to-pickaxe' (diff) | |
| parent | doc: use 'title' consistently (diff) | |
| download | git-37b34c4e99f0fed81b7523d6e674ca976f994afc.tar.gz git-37b34c4e99f0fed81b7523d6e674ca976f994afc.zip | |
Merge branch 'mh/doc-commit-title-not-subject'
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
Diffstat (limited to 'Documentation/git-commit.adoc')
| -rw-r--r-- | Documentation/git-commit.adoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-commit.adoc b/Documentation/git-commit.adoc index dfb78169cb..dc219025f1 100644 --- a/Documentation/git-commit.adoc +++ b/Documentation/git-commit.adoc @@ -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. |