Git development
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Cc: Drew DeVault <sir@cmpwn.com>
Subject: [PATCH] doc/config/push: use longer "--" line for preformatted example
Date: Tue, 18 Feb 2020 16:25:37 -0500	[thread overview]
Message-ID: <20200218212537.GA33327@coredump.intra.peff.net> (raw)

The example for the push.pushOption config tries to create a
preformatted section, but uses only two dashes in its "--" line. In
AsciiDoc this is an "open block", with no type; the lines end up jumbled
because they're formatted as paragraphs. We need four or more dashes to
make it a "listing block" that will respect the linebreaks.

Signed-off-by: Jeff King <peff@peff.net>
---
I noticed this as part our other discussion. The rendered output of
"./doc-diff HEAD^ HEAD" is:

  @@ -4143,15 +4143,20 @@ CONFIGURATION FILE
              repository) to clear the values inherited from a lower priority
              configuration files (e.g.  $HOME/.gitconfig).
   
  -           Example:
  +               Example:
   
  -           /etc/gitconfig push.pushoption = a push.pushoption = b
  +               /etc/gitconfig
  +                 push.pushoption = a
  +                 push.pushoption = b
   
  -           ~/.gitconfig push.pushoption = c
  +               ~/.gitconfig
  +                 push.pushoption = c
   
  -           repo/.git/config push.pushoption = push.pushoption = b
  +               repo/.git/config
  +                 push.pushoption =
  +                 push.pushoption = b
   
  -           This will result in only b (a and c are cleared).
  +               This will result in only b (a and c are cleared).
   
          push.recurseSubmodules
              Make sure all submodule commits used by the revisions to be pushed

 Documentation/config/push.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/config/push.txt b/Documentation/config/push.txt
index 54871f8213..0a7aa322a9 100644
--- a/Documentation/config/push.txt
+++ b/Documentation/config/push.txt
@@ -80,7 +80,7 @@ higher priority configuration file (e.g. `.git/config` in a
 repository) to clear the values inherited from a lower priority
 configuration files (e.g. `$HOME/.gitconfig`).
 +
---
+----
 
 Example:
 
@@ -97,7 +97,7 @@ repo/.git/config
 
 This will result in only b (a and c are cleared).
 
---
+----
 
 push.recurseSubmodules::
 	Make sure all submodule commits used by the revisions to be pushed
-- 
2.25.1.795.g3fd338b409

             reply	other threads:[~2020-02-18 21:25 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-18 21:25 Jeff King [this message]
2020-02-18 21:47 ` [PATCH] doc/config/push: use longer "--" line for preformatted example Junio C Hamano

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=20200218212537.GA33327@coredump.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=sir@cmpwn.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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox