From: Junio C Hamano <hidden> Date: 2016-06-15 22:56:12
Jonathan Nieder [off-list ref] writes:
Brandon Casey wrote:
quoted
Hmm, I think the original text was more confusing than I realized. I
think we should reorder the cleanup modes, placing "default" last, and
then describe default in terms of either strip or whitespace depending
on whether an editor will be spawned.
Sounds good to me. :)
Will take 1-3 of the series for now, as the above seems to indicate
that I'll see a quick reroll of 4/4.
Thanks both for patches and review.
From: Brandon Casey <redacted>
Signed-off-by: Brandon Casey <redacted>
---
Ok, here's the updated text. I am not set up to build the documentation,
so I hope someone will test, but looks right to me.
-Brandon
Documentation/git-commit.txt | 28 ++++++++++++++++++----------
1 file changed, 18 insertions(+), 10 deletions(-)
@@ -172,16 +172,24 @@ OPTIONS linkgit:git-commit-tree[1]. --cleanup=<mode>::- This option sets how the commit message is cleaned up.- The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',- and 'default'. The 'default' mode will strip leading and- trailing empty lines and #commentary from the commit message- only if the message is to be edited. Otherwise only whitespace- removed. The 'verbatim' mode does not change message at all,- 'whitespace' removes just leading/trailing whitespace lines- and 'strip' removes both whitespace and commentary. The default- can be changed by the 'commit.cleanup' configuration variable- (see linkgit:git-config[1]).+ This option determines how the supplied commit message should be+ cleaned up before committing. The '<mode>' can be `strip`,+ `whitespace`, `verbatim`, or `default`.+++--+strip::+ Strip leading and trailing empty lines, trailing whitespace, and+ #commentary and collapse consecutive empty lines.+whitespace::+ Same as `strip` except #commentary is not removed.+verbatim::+ Do not change the message at all.+default::+ `strip` if the message is to be edited. Otherwise `whitespace`.+--+++ The default can be changed by the 'commit.cleanup' configuration+ variable (see linkgit:git-config[1]). -e:: --edit::
From: Brandon Casey <redacted>
Signed-off-by: Brandon Casey <redacted>
---
[RESEND] I originally specified Junio's address as gitster@pobox.org.
Ok, here's the updated text. I am not set up to build the documentation,
so I hope someone will test, but looks right to me.
-Brandon
Documentation/git-commit.txt | 28 ++++++++++++++++++----------
1 file changed, 18 insertions(+), 10 deletions(-)
@@ -172,16 +172,24 @@ OPTIONS linkgit:git-commit-tree[1]. --cleanup=<mode>::- This option sets how the commit message is cleaned up.- The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',- and 'default'. The 'default' mode will strip leading and- trailing empty lines and #commentary from the commit message- only if the message is to be edited. Otherwise only whitespace- removed. The 'verbatim' mode does not change message at all,- 'whitespace' removes just leading/trailing whitespace lines- and 'strip' removes both whitespace and commentary. The default- can be changed by the 'commit.cleanup' configuration variable- (see linkgit:git-config[1]).+ This option determines how the supplied commit message should be+ cleaned up before committing. The '<mode>' can be `strip`,+ `whitespace`, `verbatim`, or `default`.+++--+strip::+ Strip leading and trailing empty lines, trailing whitespace, and+ #commentary and collapse consecutive empty lines.+whitespace::+ Same as `strip` except #commentary is not removed.+verbatim::+ Do not change the message at all.+default::+ `strip` if the message is to be edited. Otherwise `whitespace`.+--+++ The default can be changed by the 'commit.cleanup' configuration+ variable (see linkgit:git-config[1]). -e:: --edit::
From: Brandon Casey <redacted>
Signed-off-by: Brandon Casey <redacted>
---
[RESEND] I originally specified Junio's address as gitster@pobox.org.
[RESEND] Sorry, now with the correct address.
Ok, here's the updated text. I am not set up to build the documentation,
so I hope someone will test, but looks right to me.
-Brandon
Documentation/git-commit.txt | 28 ++++++++++++++++++----------
1 file changed, 18 insertions(+), 10 deletions(-)
@@ -172,16 +172,24 @@ OPTIONS linkgit:git-commit-tree[1]. --cleanup=<mode>::- This option sets how the commit message is cleaned up.- The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',- and 'default'. The 'default' mode will strip leading and- trailing empty lines and #commentary from the commit message- only if the message is to be edited. Otherwise only whitespace- removed. The 'verbatim' mode does not change message at all,- 'whitespace' removes just leading/trailing whitespace lines- and 'strip' removes both whitespace and commentary. The default- can be changed by the 'commit.cleanup' configuration variable- (see linkgit:git-config[1]).+ This option determines how the supplied commit message should be+ cleaned up before committing. The '<mode>' can be `strip`,+ `whitespace`, `verbatim`, or `default`.+++--+strip::+ Strip leading and trailing empty lines, trailing whitespace, and+ #commentary and collapse consecutive empty lines.+whitespace::+ Same as `strip` except #commentary is not removed.+verbatim::+ Do not change the message at all.+default::+ `strip` if the message is to be edited. Otherwise `whitespace`.+--+++ The default can be changed by the 'commit.cleanup' configuration+ variable (see linkgit:git-config[1]). -e:: --edit::
From: Jonathan Nieder <hidden> Date: 2016-06-15 22:56:12
Hi,
Brandon Casey wrote:
Signed-off-by: Brandon Casey <redacted>
This renders as
--cleanup=<mode>
This option determines how the supplied commit message
should be cleaned up before committing. The <mode> can be
strip, whitespace, verbatim, or default.
strip
Strip leading and trailing empty lines, trailing
whitespace, and #commentary and collapse consecutive
empty lines.
whitespace
Same as strip except #commentary is not removed.
verbatim
Do not change the message at all.
default
strip if the message is to be edited. Otherwise
whitespace.
The default can be changed by the 'commit.cleanup' config
variable (see linkgit:git-config[1]).
Problems:
* There's a weird extra blank line after "default"
* Wrong indentation for the final paragraph.
* The linkgit isn't resolved for some reason.
The following fixes it for me.
Signed-off-by: Jonathan Nieder <redacted>
---
Documentation/git-commit.txt | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
@@ -185,11 +185,12 @@ whitespace:: verbatim:: Do not change the message at all. default::- `strip` if the message is to be edited. Otherwise `whitespace`.+ Same as `strip` if the message is to be edited.+ Otherwise `whitespace`. -- +- The default can be changed by the 'commit.cleanup' configuration- variable (see linkgit:git-config[1]).+The default can be changed by the 'commit.cleanup' configuration+variable (see linkgit:git-config[1]). -e:: --edit::
On Tue, Feb 19, 2013 at 12:28 PM, Jonathan Nieder [off-list ref] wrote:
Hi,
Brandon Casey wrote:
Problems:
* There's a weird extra blank line after "default"
* Wrong indentation for the final paragraph.
* The linkgit isn't resolved for some reason.
The following fixes it for me.