Re: [RFC PATCH 0/24] Documentation: refactor config variable descriptions

From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Jul 26, 2010, 22:25 UTC
Message-ID: <AANLkTinxEFxOcTeDTBz6fSxAGaqSlHgq0dQvrYYgWH78@mail.gmail.com>
In-Reply-To: <cover.1280169048.git.trast@student.ethz.ch>

On Mon, Jul 26, 2010 at 18:48, Thomas Rast <trast@student.ethz.ch> wrote:

> This little series is a bit of a spinoff from

Here are some minor but needed fixups (also in my branch at http://github.com/avar/git/compare/t/doc-config-extraction)

From 522a0e384c1e8b29339aecb8cbf0cccdf42ce3ce Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= <avarab@gmail.com>
Date: Mon, 26 Jul 2010 21:56:30 +0000
Subject: [PATCH 1/2] gitignore: Add *.cv files made by var substitution script
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Ignore the *.cv files being generated as of the "Documentation: Add variable-substitution script" commit.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/.gitignore |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

diff --git a/Documentation/.gitignore b/Documentation/.gitignore
index 1c3a9fe..623f1d1 100644
--- a/Documentation/.gitignore
+++ b/Documentation/.gitignore
@@ -3,6 +3,7 @@
 *.[1-8]
 *.made
 *.texi
+*.cv
 git.info
 gitman.info
 howto-index.txt

-- 
1.7.1


From 2cdb7349fd65b246cdd01cfcd7444ed3c5e6120b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= <avarab@gmail.com>
Date: Mon, 26 Jul 2010 22:20:48 +0000
Subject: [PATCH 2/2] Documentation/Makefile: Specify -f user-manual.conf
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The user-manual.xml target was broken in the "Add
variable-substitution script" commit.

It broke because asciidoc(1) will implicitly search a configuration
file alongsite the .txt file it's generating, but that didn't work
with the preprocessed .txt.cv file (which would need a
user-manual.txt.conf file)

Fix that by specifying the path to the config file explicitly like the
other asciidoc invocations do.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/Makefile |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index c20d580..8b1e797 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -269,7 +269,8 @@ manpage-base-url.xsl: manpage-base-url.xsl.in

 user-manual.xml: user-manual.txt.cv user-manual.conf
                  $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
-                 $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book -o
$@+ $< && \
+                 $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book -f
user-manual.conf \
+                             -o $@+ $< && \
                              mv $@+ $@

 technical/api-index.txt: technical/api-index-skel.txt \
-- 
1.7.1