git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: "Thomas Rast" <trast@inf.ethz.ch>,
	"Junio C Hamano" <gitster@pobox.com>,
	"Thomas Rast" <trast@student.ethz.ch>,
	"Carlos Martín Nieto" <cmn@elego.de>,
	"Matthieu Moy" <Matthieu.Moy@imag.fr>,
	git@vger.kernel.org
Subject: Re: "docs: stop using asciidoc no-inline-literal" breaks asciidoc 8.2.5
Date: Wed, 30 May 2012 04:51:12 -0400	[thread overview]
Message-ID: <20120530085111.GA9917@sigill.intra.peff.net> (raw)
In-Reply-To: <CACBZZX6a2BQVhe8-X5o+WnfbsrqPKa_Cn93GZ1bbq1TLezB97Q@mail.gmail.com>

On Wed, May 30, 2012 at 12:42:32AM +0200, Ævar Arnfjörð Bjarmason wrote:

> Anyway, I've tested dropping asciidoc.py from the source distribution
> into compat/asciidoc.py and doing "make doc
> ASCIIDOC=../compat/asciidoc.py", it seems to work.
> 
> I wonder if the easiest solution is to change the default asciidoc
> invocation from "asciidoc" to a small Documentation/asciidoc.sh script
> that we supply, it would check if there's an asciidoc present on the
> system, whether it's sufficiently new, and if not fall back on a copy
> we have in compat/.

That makes me somewhat nervous. The asciidoc package on my system
contains 311 files. It seems probable that at least one of those files
beyond asciidoc.py is necessary for the system to work, and that it may
even depend on matching versions.

If we are going to go the route of providing an asciidoc for people
whose asciidoc is buggy, we might as well go all out and provide a
complete standalone asciidoc (or at least some subset) for those who
don't have it at all. Part of me finds that utterly gross, but part of
me likes the fact that we would be able to move our documentation and
our asciidoc interpreter in lockstep, which avoids some other bugs we
have seen in the past.  Of course, that doesn't help the rest of the
documentation toolchain (differing docbook versions have created
problems in the past, too).

I suppose the grossness would depend on how small a minimal asciidoc
distribution could be made (of those 311 files, many are documentation
and examples).

-Peff

  parent reply	other threads:[~2012-05-30  8:51 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-29 10:19 "docs: stop using asciidoc no-inline-literal" breaks asciidoc 8.2.5 Ævar Arnfjörð Bjarmason
2012-05-29 12:03 ` Thomas Rast
2012-05-29 12:31   ` Ævar Arnfjörð Bjarmason
2012-05-29 19:45     ` Junio C Hamano
2012-05-29 22:01       ` Jeff King
2012-05-29 21:56     ` Jeff King
2012-05-29 22:05       ` Dennis Kaarsemaker
2012-05-29 22:42       ` Ævar Arnfjörð Bjarmason
2012-05-29 22:51         ` Ævar Arnfjörð Bjarmason
2012-05-30  8:51         ` Jeff King [this message]
2012-05-30  9:02           ` Matthieu Moy
2012-05-30 10:17       ` [PATCH 0/3] docs: asciidoc version tweaks Jeff King
2012-05-30 10:18         ` [PATCH 1/3] INSTALL: update asciidoc recommendation Jeff King
2012-05-30 10:22         ` [PATCH 2/3] docs: drop asciidoc7compatible flag Jeff King
2012-05-30 10:22         ` [PATCH 3/3] docs: drop antique comment from Makefile 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=20120530085111.GA9917@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=Matthieu.Moy@imag.fr \
    --cc=avarab@gmail.com \
    --cc=cmn@elego.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=trast@inf.ethz.ch \
    --cc=trast@student.ethz.ch \
    /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;
as well as URLs for NNTP newsgroup(s).