From: "Martin Ågren" <firstname.lastname@example.org>
To: Patrick Steinhardt <email@example.com>
Cc: "Git Mailing List" <firstname.lastname@example.org>,
"Sergey Organov" <email@example.com>,
"Ævar Arnfjörð Bjarmason" <firstname.lastname@example.org>
Subject: Re: [PATCH 2/3] git.txt: fix monospace rendering
Date: Thu, 18 Feb 2021 07:32:46 +0100 [thread overview]
Message-ID: <CAN0heSqn+b70tPJjigeKj4cDE=YW7vSDyZLrmP02qZd0tN8PCw@mail.gmail.com> (raw)
On Thu, 18 Feb 2021 at 07:27, Patrick Steinhardt <email@example.com> wrote:
> On Wed, Feb 17, 2021 at 08:56:05PM +0100, Martin Ågren wrote:
> > When we write `<name>`s with the "s" tucked on to the closing backtick,
> > we end up rendering the backticks literally. Rephrase this sentence
> > slightly to render this as monospace.
> > Signed-off-by: Martin Ågren <firstname.lastname@example.org>
> > ---
> > doc-diff:
> > --- a/.../man/man1/git.1
> > +++ b/.../man/man1/git.1
> > @@ -77,8 +77,8 @@ OPTIONS
> > setting the value to an empty string, instead the environment
> > variable itself must be set to the empty string. It is an error if
> > the <envvar> does not exist in the environment. <envvar> may not
> > - contain an equals sign to avoid ambiguity with `<name>`s which
> > - contain one.
> > + contain an equals sign to avoid ambiguity with <name> containing
> > + one.
> Over here you're also dropping the backticks, while...
> > This is useful for cases where you want to pass transitory
> > configuration options to git, but are doing so on OS’s where other
> > Documentation/git.txt | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> > diff --git a/Documentation/git.txt b/Documentation/git.txt
> > index d36e6fd482..3a9c44987f 100644
> > --- a/Documentation/git.txt
> > +++ b/Documentation/git.txt
> > @@ -88,7 +88,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config
> > empty string, instead the environment variable itself must be
> > set to the empty string. It is an error if the `<envvar>` does not exist
> > in the environment. `<envvar>` may not contain an equals sign
> > - to avoid ambiguity with `<name>`s which contain one.
> > + to avoid ambiguity with `<name>` containing one.
> ... here you don't. Is this on purpose?
Your mail crossed with my response to Chris, who had the same question.
I'd post a link to lore.kernel.org, but it seems my response hasn't
reached it yet. The short answer is the first diff is an indented diff
of the rendered manpages (our "doc-diff" script), whereas the second
diff is the actual, to-be-applied diff.
I thought it would be helpful to include the doc-diff, but it seems it
just created more confusion than it avoided. I'll try to avoid that. :-)
next prev parent reply other threads:[~2021-02-18 6:41 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-17 19:56 [PATCH 0/3] fix some doc rendering issues since v2.30.0 Martin Ågren
2021-02-17 19:56 ` [PATCH 1/3] rev-list-options.txt: fix rendering of bonus paragraph Martin Ågren
2021-02-17 19:56 ` [PATCH 2/3] git.txt: fix monospace rendering Martin Ågren
2021-02-17 22:47 ` Chris Torek
2021-02-18 6:28 ` Martin Ågren
2021-02-18 6:27 ` Patrick Steinhardt
2021-02-18 6:32 ` Martin Ågren [this message]
2021-02-18 18:51 ` Junio C Hamano
2021-02-19 6:33 ` Martin Ågren
2021-02-17 19:56 ` [PATCH 3/3] gitmailmap.txt: fix rendering of e-mail addresses Martin Ågren
2021-02-18 10:48 ` Ævar Arnfjörð Bjarmason
2021-02-17 21:22 ` [PATCH 0/3] fix some doc rendering issues since v2.30.0 Junio C Hamano
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:
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 \
* 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
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).