git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Todd Zullinger <tmz@pobox.com>
To: git@vger.kernel.org
Cc: "brian m. carlson" <sandals@crustytoothpaste.net>,
	"Jeff King" <peff@peff.net>,
	"Martin Ågren" <martin.agren@gmail.com>,
	"SZEDER Gábor" <szeder.dev@gmail.com>,
	"Jeff Hostetler" <jeffhost@microsoft.com>
Subject: [PATCH v1 2/2] Documentation/git-status: fix titles in porcelain v2 section
Date: Sat, 30 Mar 2019 14:30:01 -0400	[thread overview]
Message-ID: <20190330183001.16624-3-tmz@pobox.com> (raw)
In-Reply-To: <20190330183001.16624-1-tmz@pobox.com>

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.

[1] http://asciidoc.org/userguide.html#X17

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---

The '^### ' lines were added in 1cd828ddc8 ("git-status.txt: describe
--porcelain=v2 format", 2016-08-11).  I'm _presuming_ they were made
with markdown syntax in mind, but if not I can drop that bit from the
commit message.  Jeff H, do you happen to recall?

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.

 Documentation/git-status.txt | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 861d821d7f..d4e8f24f0c 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -278,7 +278,8 @@ Header lines start with "#" and are added in response to specific
 command line arguments.  Parsers should ignore headers they
 don't recognize.
 
-### Branch Headers
+Branch Headers
+^^^^^^^^^^^^^^
 
 If `--branch` is given, a series of header lines are printed with
 information about the current branch.
@@ -294,7 +295,8 @@ Line                                     Notes
 ------------------------------------------------------------
 ....
 
-### Changed Tracked Entries
+Changed Tracked Entries
+^^^^^^^^^^^^^^^^^^^^^^^
 
 Following the headers, a series of lines are printed for tracked
 entries.  One of three different line formats may be used to describe
@@ -365,7 +367,8 @@ Field       Meaning
 --------------------------------------------------------
 ....
 
-### Other Items
+Other Items
+^^^^^^^^^^^
 
 Following the tracked entries (and if requested), a series of
 lines will be printed for untracked and then ignored items
@@ -379,7 +382,8 @@ Ignored items have the following format:
 
     ! <path>
 
-### Pathname Format Notes and -z
+Pathname Format Notes and -z
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 When the `-z` option is given, pathnames are printed as is and
 without any quoting and lines are terminated with a NUL (ASCII 0x00)

  parent reply	other threads:[~2019-03-30 18:30 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 ` Todd Zullinger [this message]
2019-04-01 13:18   ` [PATCH v1 2/2] Documentation/git-status: fix titles in porcelain v2 section Jeff King
2019-04-05  1:26     ` Todd Zullinger
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=20190330183001.16624-3-tmz@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).