[PATCH] doc: reformat the paragraph containing the 'cut-line'
- From
Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
- Date
- Jul 18, 2017, 14:34 UTC
- Message-ID
- <20170718143427.3780-1-kaarticsivaraam91196@gmail.com>
- In-Reply-To
- <1500388168.2065.2.camel@gmail.com>
The paragraph that describes the 'scissors' cleanup mode of 'commit' had the 'cut-line' in the middle of a sentence. This made it possible for the line to get wrapped on smaler windows. This shouldn't be the case as it makes it hard for the user to understand the structure of the cut-line.
Reformat the pragraph to make the 'cut-line' stand on a line of it's own thus distinguishing it from the rest of the paragraph. This further prevents it from getting wrapped to some extent.
Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> --- Documentation/git-commit.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index afb06adba..8c74a2ca0 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -196,11 +196,12 @@ whitespace:: verbatim:: Do not change the message at all. scissors:: - Same as `whitespace`, except that everything from (and - including) the line - "`# ------------------------ >8 ------------------------`" - is truncated if the message is to be edited. "`#`" can be - customized with core.commentChar. + Same as `whitespace` except that everything from (and including) + the line found below is truncated, if the message is to be edited. + "`#`" can be customized with core.commentChar. + + # ------------------------ >8 ------------------------ + default:: Same as `strip` if the message is to be edited. Otherwise `whitespace`.
-- 2.13.3.973.gaaf39e6bd.dirty