summaryrefslogtreecommitdiff
path: root/stagit.1
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2016-05-01 17:54:14 +0200
committerHiltjo Posthuma <hiltjo@codemadness.org>2016-05-02 21:17:52 +0200
commit1a3584e2d0689aece46d9832c91f57723296807f (patch)
treec45111856b8428d52588732b1d5e2458cdb6fae5 /stagit.1
parentede93fa7ee0af8e6e858981e1a7e5057646487ce (diff)
cache support (-c option)
"Optionally the -c cachefile option can be used to cache the entries of the log page up to the point of the last commit. The cachefile will store the last commit id and the entries in the HTML table." this caches the diffstat and commits, it is an expensive operation (twss).
Diffstat (limited to 'stagit.1')
-rw-r--r--stagit.120
1 files changed, 17 insertions, 3 deletions
diff --git a/stagit.1 b/stagit.1
index 7ee1249..d3cbb7e 100644
--- a/stagit.1
+++ b/stagit.1
@@ -1,4 +1,4 @@
-.Dd December 26, 2015
+.Dd May 1, 2016
.Dt STAGIT 1
.Os
.Sh NAME
@@ -6,12 +6,26 @@
.Nd static git page generator
.Sh SYNOPSIS
.Nm
-.Op Ar repodir
+.Op Fl c Ar cachefile
+.Ar repodir
.Sh DESCRIPTION
.Nm
writes HTML pages for the repository
.Ar repodir
-to the current directory. The following files will be written:
+to the current directory.
+.Pp
+Optionally the
+.Fl c Ar cachefile
+option can be used to cache the entries of the log page up to the point of
+the last commit. The
+.Ar cachefile
+will store the last commit id and the entries in the HTML table. It is up
+to the user to make sure the state of the
+.Ar cachefile
+is in sync with the history of the repository, for example a
+git push \-\-force can screw this up.
+.Pp
+The following files will be written:
.Bl -tag -width Ds
.It atom.xml
Atom XML feed