8eabe24bdd
- add example to README to extract gitweb.owner from a git config. this is used in gitweb and some cgit configurations. - fix (new) mandoc warnings (new sentence on each line). - improve some texts in the man pages, sort / structure some list items.
113 lines
2.4 KiB
Text
113 lines
2.4 KiB
Text
stagit
|
|
======
|
|
|
|
static git page generator
|
|
|
|
|
|
Usage
|
|
-----
|
|
|
|
Make files per repository:
|
|
|
|
$ mkdir -p htmldir && cd htmldir
|
|
$ stagit path-to-repo
|
|
|
|
Make index file for repositories:
|
|
|
|
$ stagit-index repodir1 repodir2 repodir3 > index.html
|
|
|
|
|
|
Install
|
|
-------
|
|
|
|
$ make
|
|
# make install
|
|
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
- libgit2 (v0.22+).
|
|
- libc (tested with OpenBSD, FreeBSD, glibc and musl).
|
|
- C compiler (C99).
|
|
- make
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
See man pages: stagit(1) and stagit-index(1).
|
|
|
|
|
|
Building a static binary
|
|
------------------------
|
|
|
|
It may be useful to build static binaries, for example to run in a chroot.
|
|
|
|
It can be done like this at the time of writing (v0.24):
|
|
|
|
cd libgit2-src
|
|
|
|
# change the options in the CMake file: CMakeLists.txt
|
|
BUILD_SHARED_LIBS to OFF (static)
|
|
CURL to OFF (not needed)
|
|
USE_SSH OFF (not needed)
|
|
THREADSAFE OFF (not needed)
|
|
USE_OPENSSL OFF (not needed, use builtin)
|
|
|
|
mkdir -p build && cd build
|
|
cmake ../
|
|
make
|
|
make install
|
|
|
|
|
|
Extract owner field from git config
|
|
-----------------------------------
|
|
|
|
A (hacky) way to extract the gitweb owner for example in the format:
|
|
|
|
[gitweb]
|
|
owner = Name here
|
|
|
|
Script:
|
|
|
|
#!/bin/sh
|
|
awk '/^[ ]*owner[ ]=/ {
|
|
sub(/^[^=]*=[ ]*/, "");
|
|
print $0;
|
|
}'
|
|
|
|
|
|
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 log (atom.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.
|
|
- Not suitable for repositories with many branches, a quite linear history is
|
|
assumed (from HEAD).
|
|
- 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.
|
|
- file tree per commit.
|
|
- history log of branches diverged from HEAD.
|
|
- stats (git shortlog -s).
|
|
|
|
this is by design, just use git locally.
|