Git development
 help / color / mirror / Atom feed
From: "Philip Oakley" <philipoakley@iee.org>
To: "Junio C Hamano" <gitster@pobox.com>
Cc: "GitList" <git@vger.kernel.org>, "Jeff King" <peff@peff.net>,
	"Johannes Schindelin" <Johannes.Schindelin@gmx.de>
Subject: Re: [PATCH] doc: fix merge-base ASCII art tab spacing
Date: Fri, 21 Oct 2016 22:26:29 +0100	[thread overview]
Message-ID: <D861234B3E78496DBA70EE63B2BCDB96@PhilipOakley> (raw)
In-Reply-To: xmqqa8dyeebj.fsf@gitster.mtv.corp.google.com

From: "Junio C Hamano" <gitster@pobox.com>
> Philip Oakley <philipoakley@iee.org> writes:
>
>> The doc-tool stack does not always respect the 'tab = 8 spaces' rule,
>> particularly the git-scm doc pages 
>> https://git-scm.com/docs/git-merge-base
>> and the Git generated html pages.
>
> Sorry, but I do not understand this change.
>
> https://git.github.io/htmldocs/git-merge-base.html is "Git generated
> HTML page" and I do not see any breakage around the drawings this
> patch touches, and the fp-path series does not touch these drawings,
> either.
>

I'd been looking the Git for Windows output, which has the same breakage, 
rather than yours. Apologies for failing to check there.

> If a broken "doc-tool stack" breaks the formatting, I'd prefer to
> see that "doc-tool stack" fixed, instead of working around by

The doc-tool stack is question is asciidoctor. It looks like it is an 
explicit decision that the the 8 space tab substitution is deprecated in 
these case (see http://asciidoctor.org/docs/user-manual/#migrate-deprecated 
#96.3)

It appears that acciidoctor sees the art as being a separated mono-spaced 
block, with border/background as locally appropriate. While the asciidoc 
looks to simply change to mono-spaced text.

> updating the source they work on.  Otherwise, the broken "doc-tool
> stack" will keep producing broken output next time a source that
> respects "tab is to skip to the next multiple of 8" rule is fed to
> it, no?

By avoiding tabs *within the art* we would also be tolerant of those who may 
not have a set their tab spacing to 8 when viewing the raw text.

It's particularly the criss-cross diagram that needs fixed one way or 
another (for the doc/doctor differences).

The update of the asciidoctor version for git-scm, as reported by peff isn't 
sufficient for this case.

also cc'ing dscho as this breakage shows in GfW (issue 923)

Philip



  reply	other threads:[~2016-10-21 21:26 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-20 23:40 [PATCH] doc: fix merge-base ASCII art tab spacing Philip Oakley
2016-10-21  0:22 ` Jeff King
2016-10-21  0:48   ` Junio C Hamano
2016-10-21  0:27 ` Junio C Hamano
2016-10-21 21:26   ` Philip Oakley [this message]
2016-10-21 22:54     ` Junio C Hamano
2016-10-22  5:45       ` Philip Oakley
2016-10-24 21:54       ` [PATCH] doc: fix the 'revert a faulty merge' " Philip Oakley
2016-10-25 11:39         ` Johannes Schindelin
2016-10-22  1:09     ` [PATCH] doc: fix merge-base " Jeff King

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=D861234B3E78496DBA70EE63B2BCDB96@PhilipOakley \
    --to=philipoakley@iee.org \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /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