Package: wnpp
Severity: wishlist
Owner: Daniel Gröber <d...@darkboxed.org>
X-Debbugs-Cc: debian-de...@lists.debian.org, d...@darkboxed.org

* Package name    : stagit
  Version         : 1.2
  Upstream Contact: Hiltjo Posthuma <hil...@codemadness.org>
* URL             : https://codemadness.org/stagit.html
* License         : MIT
  Programming Lang: C
  Description     : static git web repo viewer

Users expect a git repository to have a corresponding web page, but
contemporary solutions (tightly coupled "forges") are complex and
inflexible. stagit makes hosting git repositories on any web server as
easy as it can be by simply pre-generating static HTML pages for any
git repository.

stagit is exceedingly simple. I'll maintain it myself, but I'm always
happy to have co-maintainers.

(Some bits from the README follow)

Features
--------

- Log of all commits from HEAD.
- Log and diffstat per commit.
- Show file tree with linkable line numbers.
- Show references: local branches and tags.
- Detect README and LICENSE file from HEAD and link it as a webpage.
- Detect submodules (.gitmodules file) from HEAD and link it as a webpage.
- Atom feed of the commit log (atom.xml).
- Atom feed of the tags/refs (tags.xml).
- Make index page for multiple repositories with stagit-index.
- After generating the pages (relatively slow) serving the files is very fast,
  simple and requires little resources (because the content is static), only
  a HTTP file server is required.
- Usable with text-browsers such as dillo, links, lynx and w3m.

Cons
----

- Not suitable for large repositories (2000+ commits), because diffstats are
  an expensive operation, the cache (-c flag) is a workaround for this in
  some cases.
- Not suitable for large repositories with many files, because all files are
  written for each execution of stagit. This is because stagit shows the lines
  of textfiles and there is no "cache" for file metadata (this would add more
  complexity to the code).
- Not suitable for repositories with many branches, a quite linear history is
  assumed (from HEAD).

  In these cases it is better to just use cgit or possibly change stagit to
  run as a CGI program.

- Relatively slow to run the first time (about 3 seconds for sbase,
  1500+ commits), incremental updates are faster.
- Does not support some of the dynamic features cgit has, like:
  - Snapshot tarballs per commit.
  - File tree per commit.
  - History log of branches diverged from HEAD.
  - Stats (git shortlog -s).

  This is by design, just use git locally.

--Daniel

Reply via email to