Re: [RFC/PATCH 7/7] Documentation formatting and cleanup

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 1, 2008, 21:34 UTC
Message-ID: <7vej6dmgps.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <486A2C8C.5050204@free.fr>

Olivier Marin <dkr+ml.git@free.fr> writes:

Show 6 quoted lines

> Also, in Documentation/gitdiffcore.txt, you did:
>
>> -These are applied in sequence.  The set of filepairs git-diff-\*
>> +These are applied in sequence.  The set of filepairs `git-diff-*`
>
> but the file does not compile, now.

There are other places with the same breakage.

You would need something like this (using the {asterisk} macro I wrote for updating the docs for another topic). The patch shows only a single use location but there are others in the same file.

diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
index 10c1a15..40d43b7 100644
--- a/Documentation/asciidoc.conf
+++ b/Documentation/asciidoc.conf
@@ -8,6 +8,7 @@
 # the command.
 
 [attributes]
+asterisk=&#42;
 plus=&#43;
 caret=&#94;
 startsb=&#91;
diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt
index 71568ab..7169eee 100644
--- a/Documentation/gitdiffcore.txt
+++ b/Documentation/gitdiffcore.txt
@@ -23,7 +23,7 @@ that are easier to understand than the conventional kind.
 The chain of operation
 ----------------------
 
-The `git-diff-*` family works by first comparing two sets of
+The `git-diff-{asterisk}` family works by first comparing two sets of
 files:
 
  - `git-diff-index` compares contents of a "tree" object and the