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

[PATCH 0/2] Re: Broken alignment in git-reset docs

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Nov 28, 2018, 19:02 UTC
Message-ID
<cover.1543429054.git.martin.agren@gmail.com>
In-Reply-To
<CAN0heSph-a08AzsihqqxfC=nqmUQLsqx-rKGULXQ-gmT4+c10w@mail.gmail.com>
On Wed, 28 Nov 2018 at 13:02, Martin Ågren <martin.agren@gmail.com> wrote:
Show 9 quoted lines
>
> On Wed, 28 Nov 2018 at 12:42, Paweł Samoraj <samoraj.pawel@gmail.com> wrote:
> >
> > The git-reset documentation page section which is accessible via URL
> > https://git-scm.com/docs/git-reset#_discussion is not looking good.
>
> [...] The correct fix could be something like 379805051d
> ("Documentation: render revisions correctly under Asciidoctor",
> 2018-05-06).

Turns out it probably is, so here's a proposed fix, followed by a patch to typeset more of this document in monospace. That should also make things prettier, but not in such a dramatic way as the first patch.

This is obviously not 2.20-material. About where to queue this, I had expected this to depend on 743e63f3ed ("Documentation: use 8-space tabs with Asciidoctor", 2018-05-06) just like 379805051d does for proper rendering, but from my testing, somehow it doesn't.

Paweł, I'm hoping this fix should be in v2.21 in a few months and then eventually trickle down to git-scm. Thanks again for reporting this.

Martin Ågren (2):
  git-reset.txt: render tables correctly under Asciidoctor
  git-reset.txt: render literal examples as monospace
 Documentation/git-reset.txt | 277 +++++++++++++++++++-----------------
 1 file changed, 147 insertions(+), 130 deletions(-)
-- 
2.20.0.rc1.8.g46351a2c6f
Previous: Martin ÅgrenNext: Martin Ågren
Message 3 of 7 in “Broken alignment in git-reset docs”
  1. Paweł SamorajNov 28, 2018
  2. Martin ÅgrenNov 28, 2018
  3. 0/2 Re: Broken alignment in git-reset docsMartin Ågren, Nov 28, 2018
  4. 1/2 git-reset.txt: render tables correctly under AsciidoctorMartin Ågren, Nov 28, 2018
  5. Ævar Arnfjörð BjarmasonNov 28, 2018
  6. Martin ÅgrenNov 28, 2018
  7. 2/2 git-reset.txt: render literal examples as monospaceMartin Ågren, Nov 28, 2018

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.