Re: [PATCH] docs: stop using asciidoc no-inline-literal

From: Jeff King <peff@peff.net>
Date: Apr 26, 2012, 09:13 UTC
Message-ID: <20120426091343.GA16663@sigill.intra.peff.net>
In-Reply-To: <vpqehra97wo.fsf@bauges.imag.fr>

On Thu, Apr 26, 2012 at 11:09:11AM +0200, Matthieu Moy wrote:

Show 7 quoted lines

> Jeff King <peff@peff.net> writes:
> 
> > The patch is below. I'm slightly nervous because it means topics in
> > flight will need to have their documentation tweaked, too.
> 
> ... or, at worse, they will be broken for a while, and we can grep again
> the tip of pu after a few weeks to fix them.

Yes. Though having just done that grep, it is quite tedious. You will get many false positives in the existing documentation that do not need changed (e.g., stash@{0}, or a literal backslash that is meant to be in the output). So I think it will be simpler to just diff Documentation/ for the new topics and scan them manually (or grep the diff output).

> Plus, the possible breakage due to your patch are compensated by the
> existing breakage you fixed ;-). So, I'd say this is a valid concern,
> but the benefit seem clearly greater than the drawbacks.

Yeah, that was my conclusion, too.

-Peff