improve documentation

- 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.
This commit is contained in:
Hiltjo Posthuma
2017-04-22 14:38:39 +02:00
parent e9e7978381
commit 8eabe24bdd
3 changed files with 52 additions and 27 deletions

19
README
View File

@@ -61,6 +61,23 @@ 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
--------
@@ -86,7 +103,7 @@ Cons
- 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 after it are faster.
1500+ commits), incremental updates are faster.
- Does not support some of the dynamic features cgit has, like:
- snapshot tarballs.
- file tree per commit.