diff options
| author | J. Bruce Fields <bfields@citi.umich.edu> | 2007-01-07 19:23:49 -0500 |
|---|---|---|
| committer | J. Bruce Fields <bfields@citi.umich.edu> | 2007-01-07 20:33:06 -0500 |
| commit | d19fbc3c171aa71a79b2ff0b654e3064c91628b8 (patch) | |
| tree | 8226b4f70f272eaed7538e33d626e6aa2252bae1 /Documentation/Makefile | |
| parent | 13e86efbeae5994a85cc482b3964db7298c5c6ea (diff) | |
| download | git-d19fbc3c171aa71a79b2ff0b654e3064c91628b8.tar.gz git-d19fbc3c171aa71a79b2ff0b654e3064c91628b8.tar.xz | |
Documentation: add git user's manual
The goals are:
- Readable from beginning to end in order without having read
any other git documentation beforehand.
- Helpful section names and cross-references, so it's not too
hard to skip around some if you need to.
- Organized to allow it to grow much larger (unlike the
tutorials)
It's more liesurely than tutorial.txt, but tries to stay focused on
practical how-to stuff. It adds a discussion of how to resolve merge
conflicts, and partial instructions on setting up and dealing with a
public repository.
I've lifted a little bit from "branching and merging" (e.g., some of the
discussion of history diagrams), and could probably steal more if that's
OK. (Similarly anyone should of course feel free to reuse bits of this
if any parts seem more useful than the whole.)
There's a lot of detail on managing branches and using git-fetch, just
because those are essential even to people needing read-only access
(e.g., kernel testers). I think those sections will be much shorter
once the new "git remote" command and the disconnected checkouts are
taken into account.
I do feel bad about adding yet another piece of documentation, but I we
need something that goes through all the basics in a logical order, and
I wasn't seeing how to grow the tutorials into that.
Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
Diffstat (limited to 'Documentation/Makefile')
| -rw-r--r-- | Documentation/Makefile | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 93c7024b4..c2ee5b482 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -17,7 +17,7 @@ ARTICLES += hooks ARTICLES += everyday ARTICLES += git-tools # with their own formatting rules. -SP_ARTICLES = glossary howto/revert-branch-rebase +SP_ARTICLES = glossary howto/revert-branch-rebase user-manual DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES)) @@ -89,6 +89,12 @@ clean: %.xml : %.txt asciidoc -b docbook -d manpage -f asciidoc.conf $< +user-manual.xml: user-manual.txt user-manual.conf + asciidoc -b docbook -d book $< + +user-manual.html: user-manual.xml + xmlto -m /etc/asciidoc/docbook-xsl/xhtml.xsl html-nochunks $< + git.html: git.txt README glossary.html : glossary.txt sort_glossary.pl |