git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Todd Zullinger <tmz@pobox.com>
To: Jeff King <peff@peff.net>
Cc: git@vger.kernel.org,
	"brian m. carlson" <sandals@crustytoothpaste.net>,
	"Martin Ågren" <martin.agren@gmail.com>,
	"SZEDER Gábor" <szeder.dev@gmail.com>,
	"Jeff Hostetler" <jeffhost@microsoft.com>
Subject: Re: [PATCH v1 2/2] Documentation/git-status: fix titles in porcelain v2 section
Date: Thu, 4 Apr 2019 21:26:50 -0400	[thread overview]
Message-ID: <20190405012650.GP4047@pobox.com> (raw)
In-Reply-To: <20190401131831.GA12254@sigill.intra.peff.net>

Jeff King wrote:
> On Sat, Mar 30, 2019 at 02:30:01PM -0400, Todd Zullinger wrote:
> 
>> Asciidoc uses either one-line or two-line syntax for document/section
>> titles[1].  The two-line form is used in git-status.  Fix a few section
>> titles in the porcelain v2 section which were inadvertently using
>> markdown syntax.
> 
> Yep, makes sense. One observation:
> 
>> -### Branch Headers
>> +Branch Headers
>> +^^^^^^^^^^^^^^
> 
> The one-line equivalent in asciidoc would be something like:
> 
>   === Branch Headers
> 
> but that's actually a "level 2" header (because it counts from zero),
> whereas "^" underlining is a "level 3" header. But I think "^" is right
> here, because this is under level 2 "~" header.

Yeah, since there were a number of existing two-line headers
in the document, I thought it would be better to simply
update these to that form than convert the others.  We have
far more of the two-line form too, so it's more consistent
with the existing docs.

>> As an aside, while I was reading the Asciidoc/tor manuals, I notice the
>> two-line title syntax was not mentioned in Asciidoctor.  That seems to
>> be because Asciidoctor has suggested the two-line title format should be
>> deprecated, as discussed at:
>> 
>>     https://github.com/asciidoctor/asciidoctor/issues/418
>> 
>> I'm not sure how likely that is to occur.  With the 2.0 release,
>> asciidoctor plans to use semantic versioning, so I would not expect any
>> deprecation to happen before at least 2.1.  It would only affect use
>> without compat-mode.
> 
> I think it's probably fine to punt on this until we see some actual
> movement upstream on the deprecation / removal.

No doubt.  I'm sure that would be a long deprecation period.

> One side note. The original asciidoc user guide says one-line headers
> have equals on either side, like:
> 
>   === Branch Headers ===
> 
> but that one can omit the trailing delimiter. The asciidoctor reference
> just suggests using the one-sided:
> 
>   === Branch Headers

Interesting.  I didn't notice the matching right hand side
while I was looking at the original asciidoc manual.

> So presumably if we do want to convert, we would just go with the
> one-sided version.

Seems like a good rule.  I presume that when in doubt, we
should look to the Asciidoctor reference for the current
best practice.

Thanks,

-- 
Todd

  reply	other threads:[~2019-04-05  1:27 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-30 18:29 [PATCH v1 0/2] minor asciidoc/tor formatting fixes Todd Zullinger
2019-03-30 18:30 ` [PATCH v1 1/2] Documentation/rev-list-options: wrap --date=<format> block with "--" Todd Zullinger
2019-04-01 13:08   ` Jeff King
2019-04-05  1:20     ` Todd Zullinger
2019-03-30 18:30 ` [PATCH v1 2/2] Documentation/git-status: fix titles in porcelain v2 section Todd Zullinger
2019-04-01 13:18   ` Jeff King
2019-04-05  1:26     ` Todd Zullinger [this message]
2019-04-03  8:49   ` Jeff Hostetler
2019-04-05  1:32     ` Todd Zullinger
2019-04-03  9:26 ` [PATCH v1 0/2] minor asciidoc/tor formatting fixes Martin Ågren
2019-04-05  1:40   ` Todd Zullinger
2019-04-05 10:23     ` Martin Ågren
2019-04-05 22:51       ` [PATCH 0/2] a few more " Todd Zullinger
2019-04-06  9:16         ` Martin Ågren
2019-04-10  0:37           ` [PATCH v2 " Todd Zullinger
2019-04-10  3:09             ` Junio C Hamano
2019-04-10  0:37           ` [PATCH v2 1/2] Documentation/git-show-branch: avoid literal {apostrophe} Todd Zullinger
2019-04-10  0:37           ` [PATCH v2 2/2] Documentation/git-svn: improve asciidoctor compatibility Todd Zullinger
2019-04-05 22:51       ` [PATCH 1/2] Documentation/git-show-branch: drop last use of {apostrophe} Todd Zullinger
2019-04-06  9:21         ` Martin Ågren
2019-04-05 22:51       ` [PATCH 2/2] Documentation/git-svn: improve asciidoctor compatibility Todd Zullinger
2019-04-06  9:31         ` Martin Ågren
2019-04-10  0:41           ` Todd Zullinger

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190405012650.GP4047@pobox.com \
    --to=tmz@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jeffhost@microsoft.com \
    --cc=martin.agren@gmail.com \
    --cc=peff@peff.net \
    --cc=sandals@crustytoothpaste.net \
    --cc=szeder.dev@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).