threads / patch / 44388

patchDocumenation: fmt-merge-msg: fix markup in example

Subject: [PATCH] Documenation: fmt-merge-msg: fix markup in example

## tl;dr

6 messages between Oct 28, 2016 and Oct 28, 2016. Diffs are folded; open one to read it.

replies: 5people: 4as markdown or json

Stefan Christ· Oct 28, 2016, 10:01 UTC · lore

The example was not rendered as verbatim text. Fix it.

Signed-off-by: Stefan Christ <contact@stefanchrist.eu>
---
 Documentation/git-fmt-merge-msg.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Show changes to Documentation/git-fmt-merge-msg.txt +2 −0

diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 6526b17..44892c4 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -60,10 +60,10 @@ merge.summary::
 EXAMPLE
 -------
 
---
+---------
 $ git fetch origin master
 $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
---
+---------
 
 Print a log message describing a merge of the "master" branch from
 the "origin" remote.

-- 
2.7.3

Robert P. J. Day· Oct 28, 2016, 10:24 UTC · re: Stefan Christ · lore

Re: [PATCH] Documenation: fmt-merge-msg: fix markup in example

  "Documenation"?

rday

-- 
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

Stefan Christ· Oct 28, 2016, 15:07 UTC · re: Robert P. J. Day · lore

[PATCH v2] Documentation: fmt-merge-msg: fix markup in example

The example was not rendered as verbatim text. Fix it.

Signed-off-by: Stefan Christ <contact@stefanchrist.eu>
---
v2: fix misspelling in subject

Hi,

thanks to rday for spotting the typo in the subject line (I missed to autoenable the spell checking in vim) and thanks to Peff for the asciidoc explanation.

Kind regards,
	Stefan Christ
---
 Documentation/git-fmt-merge-msg.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Show changes to Documentation/git-fmt-merge-msg.txt +2 −0

diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 6526b17..44892c4 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -60,10 +60,10 @@ merge.summary::
 EXAMPLE
 -------
 
---
+---------
 $ git fetch origin master
 $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
---
+---------
 
 Print a log message describing a merge of the "master" branch from
 the "origin" remote.

-- 
2.7.3

Jeff King· Oct 28, 2016, 11:08 UTC · re: Stefan Christ · lore

Re: [PATCH] Documenation: fmt-merge-msg: fix markup in example

On Fri, Oct 28, 2016 at 12:01:26PM +0200, Stefan Christ wrote:

Show 14 quoted lines

> diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
> index 6526b17..44892c4 100644
> --- a/Documentation/git-fmt-merge-msg.txt
> +++ b/Documentation/git-fmt-merge-msg.txt
> @@ -60,10 +60,10 @@ merge.summary::
>  EXAMPLE
>  -------
>  
> ---
> +---------
>  $ git fetch origin master
>  $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
> ---
> +---------

Thanks. Asciidoc generally requires at least 4 delimiter characters to open a delimited block (including a ListingBlock, which is what we want here). There is one exception, "--", which is a generic OpenBlock, which is just used for grouping, and not any special syntactic meaning (so that's why this _didn't_ render the "--", but did render the contents without line breaks).

So looks good, modulo the typo in the subject that somebody else pointed out.

-Peff

Junio C Hamano· Oct 28, 2016, 15:15 UTC · re: Jeff King · lore

Re: [PATCH] Documenation: fmt-merge-msg: fix markup in example

Jeff King <peff@peff.net> writes:

Show 26 quoted lines

> On Fri, Oct 28, 2016 at 12:01:26PM +0200, Stefan Christ wrote:
>
>> diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
>> index 6526b17..44892c4 100644
>> --- a/Documentation/git-fmt-merge-msg.txt
>> +++ b/Documentation/git-fmt-merge-msg.txt
>> @@ -60,10 +60,10 @@ merge.summary::
>>  EXAMPLE
>>  -------
>>  
>> ---
>> +---------
>>  $ git fetch origin master
>>  $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
>> ---
>> +---------
>
> Thanks. Asciidoc generally requires at least 4 delimiter characters to
> open a delimited block (including a ListingBlock, which is what we want
> here). There is one exception, "--", which is a generic OpenBlock, which
> is just used for grouping, and not any special syntactic meaning (so
> that's why this _didn't_ render the "--", but did render the contents
> without line breaks).
>
> So looks good, modulo the typo in the subject that somebody else pointed
> out.

Thanks, both. I queued with a bit more enhanced log message while fixing the typo.

-- >8 --
From: Stefan Christ <contact@stefanchrist.eu>
Date: Fri, 28 Oct 2016 12:01:26 +0200
Subject: [PATCH] Documentation/fmt-merge-msg: fix markup in example

Use at least 4 delimiting dashes that are required for ListingBlock to get this block rendered as verbatim text.

Signed-off-by: Stefan Christ <contact@stefanchrist.eu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-fmt-merge-msg.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Show changes to Documentation/git-fmt-merge-msg.txt +2 −0

diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 6526b178e8..44892c447e 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -60,10 +60,10 @@ merge.summary::
 EXAMPLE
 -------
 
---
+---------
 $ git fetch origin master
 $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
---
+---------
 
 Print a log message describing a merge of the "master" branch from
 the "origin" remote.

-- 
2.10.1-791-g404733b9cf

Stefan Christ· Oct 28, 2016, 23:19 UTC · re: Junio C Hamano · lore

Re: [PATCH] Documenation: fmt-merge-msg: fix markup in example

Hi,

On Fri, Oct 28, 2016 at 08:15:57AM -0700, Junio C Hamano wrote:

Show 32 quoted lines

> Jeff King <peff@peff.net> writes:
> 
> > On Fri, Oct 28, 2016 at 12:01:26PM +0200, Stefan Christ wrote:
> >
> >> diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
> >> index 6526b17..44892c4 100644
> >> --- a/Documentation/git-fmt-merge-msg.txt
> >> +++ b/Documentation/git-fmt-merge-msg.txt
> >> @@ -60,10 +60,10 @@ merge.summary::
> >>  EXAMPLE
> >>  -------
> >>  
> >> ---
> >> +---------
> >>  $ git fetch origin master
> >>  $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
> >> ---
> >> +---------
> >
> > Thanks. Asciidoc generally requires at least 4 delimiter characters to
> > open a delimited block (including a ListingBlock, which is what we want
> > here). There is one exception, "--", which is a generic OpenBlock, which
> > is just used for grouping, and not any special syntactic meaning (so
> > that's why this _didn't_ render the "--", but did render the contents
> > without line breaks).
> >
> > So looks good, modulo the typo in the subject that somebody else pointed
> > out.
> 
> Thanks, both.  I queued with a bit more enhanced log message while
> fixing the typo.
>

I'm totally ok with these changes. Thanks.

Kind Regards,
	Stefan Christ