stagit

git site generator
Contents

README: clarify some cons

Hiltjo Posthuma hiltjo@codemadness.org

commit: b22c156 parent: eb42b24
1 files changed, 15 insertions(+), 6 deletions(-)
MREADME+15-6
M · README +15, -6
 1@@ -149,15 +149,24 @@ Cons
 2 ----
 3
 4 - Not suitable for
large repositories (2000+ commits), because diffstats are
 5- an expensive operation.
 6+ an expensive
operation, the cache (-c flag) is a workaround for this in
 7+ some cases.
 8+- Not suitable for
large repositories with many files, because all files are
 9+ written for each
execution of stagit. This is because stagit shows the lines
10+ of textfiles and
there is no "cache" for file metadata (this would add more
11+ complexity to the
code).
12 - Not suitable for repositories with many branches, a
quite linear history is
13 assumed (from
HEAD).
14+
15+ In these cases it is
better to just use cgit or possibly change stagit to
16+ run as a CGI program.
17+
18 - Relatively slow to run the first time (about 3
seconds for sbase,
19 1500+ commits),
incremental updates are faster.
20 - Does not
support some of the dynamic features cgit has, like:
21- - snapshot tarballs.
22- - file tree per
commit.
23- - history log of
branches diverged from HEAD.
24- - stats (git shortlog
-s).
25+ - Snapshot tarballs
per commit.
26+ - File tree per
commit.
27+ - History log of
branches diverged from HEAD.
28+ - Stats (git shortlog
-s).
29
30- this is by design, just use git locally.
31+ This is by design,
just use git locally.