Generate usage information for man pages from USAGE in each script Signed-off-by: Brandon Philips -- diff --git a/Documentation/Makefile b/Documentation/Makefile index ef2dbfb..3e98e17 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -6,6 +6,8 @@ DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT)) DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT)) DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT)) +USAGE=$(patsubst %.txt,usage-%.txt,$(MAN1_TXT)) + prefix?=$(PREFIX) bindir?=$(prefix)/bin htmldir?=$(prefix)/html @@ -55,6 +57,10 @@ guilt.7 guilt.html: guilt.txt clean: rm -f *.xml *.html *.1 *.7 doc.dep rm -f cmds.txt + rm -f usage-*.txt + +usage-%.txt: $(MAN1_TXT) usage.sh + sh ./usage.sh %.html : %.txt $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf $(ASCIIDOC_EXTRA) $< diff --git a/Documentation/guilt-files.txt b/Documentation/guilt-files.txt index 4bce715..6b06a21 100644 --- a/Documentation/guilt-files.txt +++ b/Documentation/guilt-files.txt @@ -8,7 +8,7 @@ guilt-files - Print the list of files that the topmost patch changes SYNOPSIS -------- -'guilt-files [-v] [-a] [-l]' +include::usage-guilt-files.txt[] DESCRIPTION ----------- diff --git a/Documentation/guilt-init.txt b/Documentation/guilt-init.txt index a245c6e..2aa6905 100644 --- a/Documentation/guilt-init.txt +++ b/Documentation/guilt-init.txt @@ -8,7 +8,7 @@ guilt-init - Initialize guilt for use in a git repository SYNOPSIS -------- -'guilt-init [-n]' +include::usage-guilt-init.txt[] DESCRIPTION ----------- diff --git a/Documentation/guilt-new.txt b/Documentation/guilt-new.txt index 55ab809..9e5cc47 100644 --- a/Documentation/guilt-new.txt +++ b/Documentation/guilt-new.txt @@ -8,7 +8,7 @@ guilt-new - Create a new patch SYNOPSIS -------- -'guilt-new [-s] [-e|-m ] ' +include::usage-guilt-new.txt[] DESCRIPTION ----------- diff --git a/Documentation/guilt-prev.txt b/Documentation/guilt-prev.txt index 6482545..8623083 100644 --- a/Documentation/guilt-prev.txt +++ b/Documentation/guilt-prev.txt @@ -5,10 +5,9 @@ NAME ---- guilt-prev - Output name of second topmost applied patch - SYNOPSIS -------- -'guilt-prev' +include::usage-guilt-prev.txt[] DESCRIPTION ----------- diff --git a/Documentation/guilt-refresh.txt b/Documentation/guilt-refresh.txt index 7611bea..54cacdc 100644 --- a/Documentation/guilt-refresh.txt +++ b/Documentation/guilt-refresh.txt @@ -5,10 +5,9 @@ NAME ---- guilt-refresh - Refresh topmost applied patch - SYNOPSIS -------- -'guilt-refresh' +include::usage-guilt-refresh.txt[] DESCRIPTION ----------- diff --git a/Documentation/guilt-top.txt b/Documentation/guilt-top.txt index 0d63730..16772a4 100644 --- a/Documentation/guilt-top.txt +++ b/Documentation/guilt-top.txt @@ -8,7 +8,7 @@ guilt-top - Output name of topmost applied patch SYNOPSIS -------- -'guilt-top' +include::usage-guilt-top.txt[] DESCRIPTION ----------- diff --git a/Documentation/usage.sh b/Documentation/usage.sh new file mode 100644 index 0000000..20fdca4 --- /dev/null +++ b/Documentation/usage.sh @@ -0,0 +1,7 @@ +#!/bin/sh + +for i in `ls ../guilt-*`; do + name=$(basename $i) + u=$(grep USAGE $i | sed 's/USAGE="//' | sed 's/"$//') + echo "'$name' $u" > usage-$name.txt +done