summary |
shortlog |
log |
commit | commitdiff |
tree
raw |
patch |
inline | side by side (from parent 1:
9829038)
There should be only one level 0 title, so redefine underline rules in
asciidoc.conf to keep the existing underlines when possible. Form a new
level 1 part "Technical Information" from the text at the end. Make
introduction a preamble - it's too short to be a level 1 section.
Add doc/Makefile to process the tutorial automatically. make needs to
be run explicitly in the doc directory.
Signed-off-by: Pavel Roskin <proski@gnu.org>
--- /dev/null
+DOCS = tutorial.txt
+DOCS_HTML = $(DOCS:.txt=.html)
+DOCS_PDF = $(DOCS:.txt=.pdf)
+
+all: $(DOCS_HTML) $(DOCS_PDF)
+
+%.html: %.txt
+ asciidoc $<
+
+%.xml: %.txt
+ asciidoc --backend=docbook $<
+
+%.pdf: %.xml
+ xmlto pdf $<
+
+clean:
+ rm -f *.xml *.html *.pdf
--- /dev/null
+[titles]
+underlines="##","==","--","~~","^^"
+
-Introduction
-------------
StGIT is a Python application that provides functionality similar to
quilt (i.e. pushing/popping patches to/from a stack) using GIT instead
StGIT is a Python application that provides functionality similar to
quilt (i.e. pushing/popping patches to/from a stack) using GIT instead
-A Bit of StGIT Patch Theory
-===========================
+Technical Information
+=====================
+
+A bit of StGIT patch theory
+---------------------------
We assume that a patch is a diff between two nodes - bottom and top. A
node is a commit SHA1 id or tree SHA1 id in the GIT terminology:
We assume that a patch is a diff between two nodes - bottom and top. A
node is a commit SHA1 id or tree SHA1 id in the GIT terminology:
Removing (popping) a patch from the stack is done by simply setting the
Nst to Nb.
Removing (popping) a patch from the stack is done by simply setting the
Nst to Nb.
-.git/ Directory Structure
+Layout of the .git directory
+----------------------------
HEAD -> refs/heads/<something>
objects/
HEAD -> refs/heads/<something>
objects/