git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 2/3] git.txt: fix monospace rendering

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Feb 18, 2021, 06:32 UTC
Message-ID
<CAN0heSqn+b70tPJjigeKj4cDE=YW7vSDyZLrmP02qZd0tN8PCw@mail.gmail.com>
In-Reply-To
<YC4I20bQ0jeNLO+M@ncase>
On Thu, 18 Feb 2021 at 07:27, Patrick Steinhardt <ps@pks.im> wrote:
Show 39 quoted lines
>
> 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 <martin.agren@gmail.com>
> > ---
> >  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. :-)

Thanks Martin

Previous: Patrick SteinhardtNext: Junio C Hamano
Message 7 of 12 in “fix some doc rendering issues since v2.30.0”
  1. 0/3 fix some doc rendering issues since v2.30.0Martin Ågren, Feb 17, 2021
  2. 1/3 rev-list-options.txt: fix rendering of bonus paragraphMartin Ågren, Feb 17, 2021
  3. 2/3 git.txt: fix monospace renderingMartin Ågren, Feb 17, 2021
  4. Chris TorekFeb 17, 2021
  5. Martin ÅgrenFeb 18, 2021
  6. Patrick SteinhardtFeb 18, 2021
  7. Martin ÅgrenFeb 18, 2021
  8. Junio C HamanoFeb 18, 2021
  9. Martin ÅgrenFeb 19, 2021
  10. 3/3 gitmailmap.txt: fix rendering of e-mail addressesMartin Ågren, Feb 17, 2021
  11. Ævar Arnfjörð BjarmasonFeb 18, 2021
  12. Junio C HamanoFeb 17, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.