[PATCH] Documentation: add a "git user's manual"
- From
- J. Bruce Fields <bfields@fieldses.org>
- Date
- Nov 26, 2006, 04:01 UTC
- Message-ID
- <20061126040142.GB3782@fieldses.org>
- In-Reply-To
- <20061119175040.GB15608@fieldses.org>
On Sun, Nov 19, 2006 at 12:50:40PM -0500, J. Bruce Fields wrote:
> In fact, I'm tempted to submit a patch that just assigns a chapter > number to everything under Documentation/, slaps a single table of > contents on the front, and calls the result "the git user's manual."
Something like this, as a start?:
Add a manual.txt file which generates a "git user's manual" by including a bunch of preexisting files under Documentation and declaring each to be a chapter.
The result is a disorganized mess, because the documentation itself is a disorganized mess. This is intended to call attention to that fact rather than fix it. Hopefully we can massage it into a better order over time. And hopefully we can encourage anyone that adds new documentation to think about where in the order it should be inserted.
Not built or installed by default for now.
Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> --- Documentation/Makefile | 7 ++++++- Documentation/manual.conf | 2 ++ Documentation/manual.txt | 30 ++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 1 deletions(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile index c00f5f6..684dacf 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -85,9 +85,14 @@ clean: %.1 %.7 : %.xml xmlto -m callouts.xsl man $< -%.xml : %.txt +%.html : %.txt asciidoc -b docbook -d manpage -f asciidoc.conf $< +manual.html: manual.txt + a2x -f xhtml --no-icons --asciidoc-opts="-d book -f asciidoc.conf" $< + +# a2x -f xhtml --ascidoc-opts="-d book -f asciidoc.conf" $< + git.html: git.txt README glossary.html : glossary.txt sort_glossary.pl diff --git a/Documentation/manual.conf b/Documentation/manual.conf new file mode 100644 index 0000000..0d0cfad --- /dev/null +++ b/Documentation/manual.conf @@ -0,0 +1,2 @@ +[titles] +underlines="__","==","--","~~","^^" diff --git a/Documentation/manual.txt b/Documentation/manual.txt new file mode 100644 index 0000000..5512212 --- /dev/null +++ b/Documentation/manual.txt @@ -0,0 +1,30 @@ +Git User's manual +_________________ + +include::tutorial.txt[] + +include::tutorial-2.txt[] + +Git design overview +=================== + +include::README[] + +include::everyday.txt[] + +include::cvs-migration.txt[] + +include::howto-index.txt[] + +include::hooks.txt[] + +include::diffcore.txt[] + +include::repository-layout.txt[] + +include::core-tutorial.txt[] + +Glossary of git terms +===================== + +include::glossary.txt[]
-- 1.4.4.rc1.g83ee9