{"thread":{"id":"62949","subject":"[PATCH] doc: use 'title' consistently","startedAt":"2025-02-13T20:05:21Z","lastAt":"2025-02-18T17:59:50Z","messageCount":5,"participants":["M Hickford via GitGitGadget","Junio C Hamano","M Hickford"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"512380","messageId":"pull.1893.git.git.1739477118350.gitgitgadget@gmail.com","threadId":"62949","inReplyTo":null,"subject":"[PATCH] doc: use 'title' consistently","fromName":"M Hickford via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-02-13T20:05:18Z","receivedAt":"2025-02-13T20:05:21Z","isPatch":true,"sender":{"key":"mirth.hickford@gmail.com","avatar":"https://avatars.githubusercontent.com/u/105314?v=4"},"body":"From: M Hickford <mirth.hickford@gmail.com>\n\nThe first line of a commit message is variously called 'title' or\n'subject'.\n\nPrefer 'title' unless discussing email.\n\nSigned-off-by: M Hickford <mirth.hickford@gmail.com>\n---\n    doc: use 'title' consistently\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1893%2Fhickford%2Ftitle-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1893/hickford/title-v1\nPull-Request: https://github.com/git/git/pull/1893\n\n Documentation/git-commit.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex 602e2f1200b..70a5e4a181c 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -98,8 +98,8 @@ OPTIONS\n \treplaces the log message of _<commit>_ with its own log message\n \tbut makes no changes to the content of _<commit>_.\n +\n-The commit created by plain `--fixup=<commit>` has a subject\n-composed of \"fixup!\" followed by the subject line from _<commit>_,\n+The commit created by plain `--fixup=<commit>` has a title\n+composed of \"fixup!\" followed by the title of _<commit>_,\n and is recognized specially by `git rebase --autosquash`. The `-m`\n option may be used to supplement the log message of the created\n commit, but the additional commentary will be thrown away once the\n@@ -107,7 +107,7 @@ commit, but the additional commentary will be thrown away once the\n `git rebase --autosquash`.\n +\n The commit created by `--fixup=amend:<commit>` is similar but its\n-subject is instead prefixed with \"amend!\". The log message of\n+title is instead prefixed with \"amend!\". The log message of\n _<commit>_ is copied into the log message of the \"amend!\" commit and\n opened in an editor so it can be refined. When `git rebase\n --autosquash` squashes the \"amend!\" commit into _<commit>_, the\n@@ -128,7 +128,7 @@ See linkgit:git-rebase[1] for details.\n \n `--squash=<commit>`::\n \tConstruct a commit message for use with `git rebase --autosquash`.\n-\tThe commit message subject line is taken from the specified\n+\tThe commit message title is taken from the specified\n \tcommit with a prefix of \"squash! \".  Can be used with additional\n \tcommit message options (`-m`/`-c`/`-C`/`-F`). See\n \tlinkgit:git-rebase[1] for details.\n\nbase-commit: e2067b49ecaef9b7f51a17ce251f9207f72ef52d\n-- \ngitgitgadget\n"},{"id":"512383","messageId":"xmqq5xldoaj6.fsf@gitster.g","threadId":"62949","inReplyTo":"pull.1893.git.git.1739477118350.gitgitgadget@gmail.com","subject":"Re: [PATCH] doc: use 'title' consistently","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-02-13T20:27:25Z","receivedAt":"2025-02-13T20:27:27Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"M Hickford via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n\n> From: M Hickford <mirth.hickford@gmail.com>\n>\n> The first line of a commit message is variously called 'title' or\n> 'subject'.\n>\n> Prefer 'title' unless discussing email.\n\nWe do use them interchangeably, but I agree that 'title' is a more\ngeneric term than 'subject'.  There are a few other commands that\nwe may want to pay attenion to.\n\n - \"git log --help\" talks about \"--oneline\" and \"--pretty=oneline\",\n   and they refer to \"<title-line>\", so we are good there.\n\n - \"git shortlog\" also says it groups the commits by author and\n   title.\n\n - \"git rebase --help\" talks about \"(commit) subject\" when it\n   discusses what appears in the todo-file, without referring to\n   \"title\" at all.\n\nWe may want to update \"git rebase\" documentation to match what\nhappens in this patch at the same time, especially because it is its\ninteractive mode that \"git rebase --help\" uses \"subject\" to refer to\neach commit's title.\n\nWill queue.  Thanks.\n\n\n> Signed-off-by: M Hickford <mirth.hickford@gmail.com>\n> ---\n>     doc: use 'title' consistently\n>\n> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1893%2Fhickford%2Ftitle-v1\n> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1893/hickford/title-v1\n> Pull-Request: https://github.com/git/git/pull/1893\n>\n>  Documentation/git-commit.txt | 8 ++++----\n>  1 file changed, 4 insertions(+), 4 deletions(-)\n>\n> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\n> index 602e2f1200b..70a5e4a181c 100644\n> --- a/Documentation/git-commit.txt\n> +++ b/Documentation/git-commit.txt\n> @@ -98,8 +98,8 @@ OPTIONS\n>  \treplaces the log message of _<commit>_ with its own log message\n>  \tbut makes no changes to the content of _<commit>_.\n>  +\n> -The commit created by plain `--fixup=<commit>` has a subject\n> -composed of \"fixup!\" followed by the subject line from _<commit>_,\n> +The commit created by plain `--fixup=<commit>` has a title\n> +composed of \"fixup!\" followed by the title of _<commit>_,\n>  and is recognized specially by `git rebase --autosquash`. The `-m`\n>  option may be used to supplement the log message of the created\n>  commit, but the additional commentary will be thrown away once the\n> @@ -107,7 +107,7 @@ commit, but the additional commentary will be thrown away once the\n>  `git rebase --autosquash`.\n>  +\n>  The commit created by `--fixup=amend:<commit>` is similar but its\n> -subject is instead prefixed with \"amend!\". The log message of\n> +title is instead prefixed with \"amend!\". The log message of\n>  _<commit>_ is copied into the log message of the \"amend!\" commit and\n>  opened in an editor so it can be refined. When `git rebase\n>  --autosquash` squashes the \"amend!\" commit into _<commit>_, the\n> @@ -128,7 +128,7 @@ See linkgit:git-rebase[1] for details.\n>  \n>  `--squash=<commit>`::\n>  \tConstruct a commit message for use with `git rebase --autosquash`.\n> -\tThe commit message subject line is taken from the specified\n> +\tThe commit message title is taken from the specified\n>  \tcommit with a prefix of \"squash! \".  Can be used with additional\n>  \tcommit message options (`-m`/`-c`/`-C`/`-F`). See\n>  \tlinkgit:git-rebase[1] for details.\n>\n> base-commit: e2067b49ecaef9b7f51a17ce251f9207f72ef52d\n"},{"id":"512491","messageId":"CAGJzqs=iu9mMpGzb7pO54dFSQGnTs+LWV_voRFp+XcZWDJFg8g@mail.gmail.com","threadId":"62949","inReplyTo":"xmqq5xldoaj6.fsf@gitster.g","subject":"Re: [PATCH] doc: use 'title' consistently","fromName":"M Hickford","fromEmail":"mirth.hickford@gmail.com","sentAt":"2025-02-16T20:40:27Z","receivedAt":"2025-02-16T20:41:10Z","isPatch":true,"sender":{"key":"mirth.hickford@gmail.com","avatar":"https://avatars.githubusercontent.com/u/105314?v=4"},"body":"> We may want to update \"git rebase\" documentation to match what\n> happens in this patch at the same time, especially because it is its\n> interactive mode that \"git rebase --help\" uses \"subject\" to refer to\n> each commit's title.\n\nGood idea. I'll prepare patch v2.\n"},{"id":"512492","messageId":"pull.1893.v2.git.git.1739739761445.gitgitgadget@gmail.com","threadId":"62949","inReplyTo":"pull.1893.git.git.1739477118350.gitgitgadget@gmail.com","subject":"[PATCH v2] doc: use 'title' consistently","fromName":"M Hickford via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-02-16T21:02:41Z","receivedAt":"2025-02-16T21:02:45Z","isPatch":true,"sender":{"key":"mirth.hickford@gmail.com","avatar":"https://avatars.githubusercontent.com/u/105314?v=4"},"body":"From: M Hickford <mirth.hickford@gmail.com>\n\nThe first line of a commit message is variously called 'title' or\n'subject'.\n\nPrefer 'title' unless discussing email.\n\nSigned-off-by: M Hickford <mirth.hickford@gmail.com>\n---\n    doc: use 'title' consistently\n    \n    Patch v2 includes git-rebase.txt\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1893%2Fhickford%2Ftitle-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1893/hickford/title-v2\nPull-Request: https://github.com/git/git/pull/1893\n\nRange-diff vs v1:\n\n 1:  4e31627a4c4 ! 1:  0bca7a06d11 doc: use 'title' consistently\n     @@ Commit message\n      \n          Signed-off-by: M Hickford <mirth.hickford@gmail.com>\n      \n     - ## Documentation/git-commit.txt ##\n     -@@ Documentation/git-commit.txt: OPTIONS\n     + ## Documentation/git-commit.adoc ##\n     +@@ Documentation/git-commit.adoc: OPTIONS\n       \treplaces the log message of _<commit>_ with its own log message\n       \tbut makes no changes to the content of _<commit>_.\n       +\n     @@ Documentation/git-commit.txt: OPTIONS\n       and is recognized specially by `git rebase --autosquash`. The `-m`\n       option may be used to supplement the log message of the created\n       commit, but the additional commentary will be thrown away once the\n     -@@ Documentation/git-commit.txt: commit, but the additional commentary will be thrown away once the\n     +@@ Documentation/git-commit.adoc: commit, but the additional commentary will be thrown away once the\n       `git rebase --autosquash`.\n       +\n       The commit created by `--fixup=amend:<commit>` is similar but its\n     @@ Documentation/git-commit.txt: commit, but the additional commentary will be thro\n       _<commit>_ is copied into the log message of the \"amend!\" commit and\n       opened in an editor so it can be refined. When `git rebase\n       --autosquash` squashes the \"amend!\" commit into _<commit>_, the\n     -@@ Documentation/git-commit.txt: See linkgit:git-rebase[1] for details.\n     +@@ Documentation/git-commit.adoc: See linkgit:git-rebase[1] for details.\n       \n       `--squash=<commit>`::\n       \tConstruct a commit message for use with `git rebase --autosquash`.\n     @@ Documentation/git-commit.txt: See linkgit:git-rebase[1] for details.\n       \tcommit with a prefix of \"squash! \".  Can be used with additional\n       \tcommit message options (`-m`/`-c`/`-C`/`-F`). See\n       \tlinkgit:git-rebase[1] for details.\n     +\n     + ## Documentation/git-rebase.adoc ##\n     +@@ Documentation/git-rebase.adoc: See also INCOMPATIBLE OPTIONS below.\n     + --no-autosquash::\n     + \tAutomatically squash commits with specially formatted messages into\n     + \tprevious commits being rebased.  If a commit message starts with\n     +-\t\"squash! \", \"fixup! \" or \"amend! \", the remainder of the subject line\n     ++\t\"squash! \", \"fixup! \" or \"amend! \", the remainder of the title\n     + \tis taken as a commit specifier, which matches a previous commit if it\n     +-\tmatches the subject line or the hash of that commit.  If no commit\n     ++\tmatches the title or the hash of that commit.  If no commit\n     + \tmatches fully, matches of the specifier with the start of commit\n     +-\tsubjects are considered.\n     ++\ttitles are considered.\n     + +\n     + In the rebase todo list, the actions of squash, fixup and amend commits are\n     + changed from `pick` to `squash`, `fixup` or `fixup -C`, respectively, and they\n     +@@ Documentation/git-rebase.adoc: be used to review and edit the todo list before proceeding.\n     + The recommended way to create commits with squash markers is by using the\n     + `--squash`, `--fixup`, `--fixup=amend:` or `--fixup=reword:` options of\n     + linkgit:git-commit[1], which take the target commit as an argument and\n     +-automatically fill in the subject line of the new commit from that.\n     ++automatically fill in the title of the new commit from that.\n     + +\n     + Setting configuration variable `rebase.autoSquash` to true enables\n     + auto-squashing by default for interactive rebase.  The `--no-autosquash`\n\n\n Documentation/git-commit.adoc | 8 ++++----\n Documentation/git-rebase.adoc | 8 ++++----\n 2 files changed, 8 insertions(+), 8 deletions(-)\n\ndiff --git a/Documentation/git-commit.adoc b/Documentation/git-commit.adoc\nindex dfb78169cb7..dc219025f1e 100644\n--- a/Documentation/git-commit.adoc\n+++ b/Documentation/git-commit.adoc\n@@ -98,8 +98,8 @@ OPTIONS\n \treplaces the log message of _<commit>_ with its own log message\n \tbut makes no changes to the content of _<commit>_.\n +\n-The commit created by plain `--fixup=<commit>` has a subject\n-composed of \"fixup!\" followed by the subject line from _<commit>_,\n+The commit created by plain `--fixup=<commit>` has a title\n+composed of \"fixup!\" followed by the title of _<commit>_,\n and is recognized specially by `git rebase --autosquash`. The `-m`\n option may be used to supplement the log message of the created\n commit, but the additional commentary will be thrown away once the\n@@ -107,7 +107,7 @@ commit, but the additional commentary will be thrown away once the\n `git rebase --autosquash`.\n +\n The commit created by `--fixup=amend:<commit>` is similar but its\n-subject is instead prefixed with \"amend!\". The log message of\n+title is instead prefixed with \"amend!\". The log message of\n _<commit>_ is copied into the log message of the \"amend!\" commit and\n opened in an editor so it can be refined. When `git rebase\n --autosquash` squashes the \"amend!\" commit into _<commit>_, the\n@@ -128,7 +128,7 @@ See linkgit:git-rebase[1] for details.\n \n `--squash=<commit>`::\n \tConstruct a commit message for use with `git rebase --autosquash`.\n-\tThe commit message subject line is taken from the specified\n+\tThe commit message title is taken from the specified\n \tcommit with a prefix of \"squash! \".  Can be used with additional\n \tcommit message options (`-m`/`-c`/`-C`/`-F`). See\n \tlinkgit:git-rebase[1] for details.\ndiff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc\nindex 133fe8c5e6a..153cb69a4f8 100644\n--- a/Documentation/git-rebase.adoc\n+++ b/Documentation/git-rebase.adoc\n@@ -599,11 +599,11 @@ See also INCOMPATIBLE OPTIONS below.\n --no-autosquash::\n \tAutomatically squash commits with specially formatted messages into\n \tprevious commits being rebased.  If a commit message starts with\n-\t\"squash! \", \"fixup! \" or \"amend! \", the remainder of the subject line\n+\t\"squash! \", \"fixup! \" or \"amend! \", the remainder of the title\n \tis taken as a commit specifier, which matches a previous commit if it\n-\tmatches the subject line or the hash of that commit.  If no commit\n+\tmatches the title or the hash of that commit.  If no commit\n \tmatches fully, matches of the specifier with the start of commit\n-\tsubjects are considered.\n+\ttitles are considered.\n +\n In the rebase todo list, the actions of squash, fixup and amend commits are\n changed from `pick` to `squash`, `fixup` or `fixup -C`, respectively, and they\n@@ -613,7 +613,7 @@ be used to review and edit the todo list before proceeding.\n The recommended way to create commits with squash markers is by using the\n `--squash`, `--fixup`, `--fixup=amend:` or `--fixup=reword:` options of\n linkgit:git-commit[1], which take the target commit as an argument and\n-automatically fill in the subject line of the new commit from that.\n+automatically fill in the title of the new commit from that.\n +\n Setting configuration variable `rebase.autoSquash` to true enables\n auto-squashing by default for interactive rebase.  The `--no-autosquash`\n\nbase-commit: 03944513488db4a81fdb4c21c3b515e4cb260b05\n-- \ngitgitgadget\n"},{"id":"512627","messageId":"xmqqldu3xhez.fsf@gitster.g","threadId":"62949","inReplyTo":"pull.1893.v2.git.git.1739739761445.gitgitgadget@gmail.com","subject":"Re: [PATCH v2] doc: use 'title' consistently","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-02-18T17:59:48Z","receivedAt":"2025-02-18T17:59:50Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"M Hickford via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n\n> From: M Hickford <mirth.hickford@gmail.com>\n>\n> The first line of a commit message is variously called 'title' or\n> 'subject'.\n>\n> Prefer 'title' unless discussing email.\n>\n> Signed-off-by: M Hickford <mirth.hickford@gmail.com>\n> ---\n>     doc: use 'title' consistently\n>     \n>     Patch v2 includes git-rebase.txt\n\nLooking good.\n\n>  Documentation/git-commit.adoc | 8 ++++----\n>  Documentation/git-rebase.adoc | 8 ++++----\n>  2 files changed, 8 insertions(+), 8 deletions(-)\n\nWill apply with s/adoc/txt/ so that the result becomes obviously\nmerge-able to 'maint' (even though currently I do not plan to do a\nGit 2.48.2 right now, I often do this to make it easy for distro\nmaintainers to backport obvious fixes to their maintenance tracks).\n\nThanks.\n"}]}