git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[StGit PATCH] Fixes for auto-generation of man pages

From
Daniel White <daniel@whitehouse.id.au>
Date
Sep 9, 2008, 07:17 UTC
Message-ID
<20080909171721.2c7974a1@whitehouse.id.au>
In-Reply-To
<20080908210811.1957.16419.stgit@yoghurt>

stg.txt is the only man page not generated by stg-build --commands. Provide this page explicitly instead of including all other commands twice.

stg-cmd-list.txt is only a template for inclusion in other man pages, so rename to stop it being built along with other stg-* files.

Signed-off-by: Daniel White <daniel@whitehouse.id.au>
---
 Documentation/.gitignore |    1 +
 Documentation/Makefile   |    6 +++---
 Documentation/stg.txt    |    2 +-
 3 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
index 32dd09d..c72f35c 100644
--- a/Documentation/.gitignore
+++ b/Documentation/.gitignore
@@ -3,3 +3,4 @@
 *.[1-9]
 stg-*.txt
 doc.dep
+command-list.txt
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 85e9600..165e222 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -1,7 +1,7 @@
 COMMANDS = $(shell ../stg-build --commands)
 COMMANDS_TXT = $(patsubst %,stg-%.txt,$(COMMANDS))
 
-MAN1_TXT=$(wildcard stg*.txt) $(COMMANDS_TXT)
+MAN1_TXT= stg.txt $(COMMANDS_TXT)
 
 DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT))
 
@@ -60,14 +60,14 @@ doc.dep : $(wildcard *.txt) build-docdep.perl
 -include doc.dep
 
 clean:
-	rm -f *.xml *.html *.pdf *.1 doc.dep $(COMMANDS_TXT) stg-cmd-list.txt
+	rm -f *.xml *.html *.pdf *.1 doc.dep $(COMMANDS_TXT) command-list.txt
 
 ALL_PY = $(shell find ../stgit -name '*.py')
 
 $(COMMANDS_TXT): $(ALL_PY)
 	../stg-build --asciidoc $(basename $(subst stg-,,$@)) > $@
 
-stg-cmd-list.txt: $(ALL_PY)
+command-list.txt: $(ALL_PY)
 	../stg-build --cmd-list > $@
 
 %.html : %.txt
diff --git a/Documentation/stg.txt b/Documentation/stg.txt
index b4184b2..d8f7d01 100644
--- a/Documentation/stg.txt
+++ b/Documentation/stg.txt
@@ -105,7 +105,7 @@ description is available in individual command manpages.  Those
 manpages are named 'stg-<command>(1)'.
 endif::backend-docbook[]
 
-include::stg-cmd-list.txt[]
+include::command-list.txt[]
 
 CONFIGURATION MECHANISM
 -----------------------
-- 
1.6.0.1.220.g80d1
Previous: Karl HasselströmNext: Karl Hasselström
Message 4 of 7 in “Auto-generate man pages and command list”
  1. 0/3 Auto-generate man pages and command listKarl Hasselström, Sep 8, 2008
  2. 2/3 asciidoc.conf: Steal updates from gitKarl Hasselström, Sep 8, 2008
  3. 3/3 Generate command lists automaticallyKarl Hasselström, Sep 8, 2008
  4. Fixes for auto-generation of man pagesDaniel White, Sep 9, 2008
  5. Karl HasselströmSep 10, 2008
  6. Catalin MarinasSep 10, 2008
  7. Karl HasselströmSep 11, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.