From: Junio C Hamano <gitster@pobox•com>
To: Kaartic Sivaraam <kaarticsivaraam91196@gmail•com>
Cc: git@vger•kernel.org
Subject: Re: [PATCH] doc: reformat the paragraph containing the 'cut-line'
Date: Mon, 17 Jul 2017 15:16:22 -0700 [thread overview]
Message-ID: <xmqqefteg155.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20170717153839.16586-1-kaarticsivaraam91196@gmail.com> (Kaartic Sivaraam's message of "Mon, 17 Jul 2017 21:08:39 +0530")
Kaartic Sivaraam <kaarticsivaraam91196@gmail•com> writes:
> 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..2c0d48bab 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.
Is there some funny indentation setting involved? Why aren't these
lines aligning?
> +
> + # ------------------------ >8 ------------------------
> +
Does an empty line before this one screw up the asciidoc formatting?
If the long line is problematic, I think it is safer to perhaps
spell it out, perhaps something like
... except that everything is ignored down from the
"scissors" line that begins with a core.commentChar (`#` by
default) followed by many dashes `-`, followed by the
scissors mark ` >8 `, followed by many dashes `-`.
???
> default::
> Same as `strip` if the message is to be edited.
> Otherwise `whitespace`.
next prev parent reply other threads:[~2017-07-17 22:16 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-17 15:38 [PATCH] doc: reformat the paragraph containing the 'cut-line' Kaartic Sivaraam
2017-07-17 22:16 ` Junio C Hamano [this message]
2017-07-18 14:29 ` Kaartic Sivaraam
2017-07-18 14:34 ` Kaartic Sivaraam
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqefteg155.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=kaarticsivaraam91196@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox