[PATCH] Clarify documentation on commit message strip
- From
Fredrik Gustafsson <iveqy@iveqy.com>
- Date
- Apr 25, 2015, 05:42 UTC
- Message-ID
- <1429940565-14947-1-git-send-email-iveqy@iveqy.com>
- In-Reply-To
- <xmqqmw1w259r.fsf@gitster.dls.corp.google.com>
When using `-v` to add a unified diff to the commit message, this is stripped and not a part of the commit message. This is not mentioned.
Add a note about this with the `-v` description and slightly modify the description for the default `--cleanup` mode.
Signed-off-by: Fredrik Gustafsson <iveqy@iveqy.com> ---
Show 7 quoted lines
>I'd prefer the description not to be _too_ explicit e.g. by >mentioning "unified diff", etc. > >Personally I think it is sufficient to do s/#comment/comment/ to the >existing text, without doing anything else. What is "commentary" to >be removed is fairly clear in the contents given to the user in the >editor.
I agree that it is very clear once you do edit the commit message. My main point with this patch was to clarify -v, since it's not obvious from the documentation that it will be removed.
I've no objections about your suggestions about the `strip` part. I hope I've understood you correctly and that this patch is correct.
Documentation/git-commit.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 617e29b..1db4c7f 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -180,8 +180,8 @@ OPTIONS + -- strip:: - Strip leading and trailing empty lines, trailing whitespace, and - #commentary and collapse consecutive empty lines. + Strip leading and trailing empty lines, trailing whitespace, + commentary and collapse consecutive empty lines. whitespace:: Same as `strip` except #commentary is not removed. verbatim:: @@ -283,7 +283,8 @@ configuration variable documented in linkgit:git-config[1]. Show unified diff between the HEAD commit and what would be committed at the bottom of the commit message template. Note that this diff output doesn't have its - lines prefixed with '#'. + lines prefixed with '#'. This diff will not be a part + of the commit message. + If specified twice, show in addition the unified diff between what would be committed and the worktree files, i.e. the unstaged
-- 2.1.4