From 8eabe24bdda7003453bbd034d82ebc479e2c76bc Mon Sep 17 00:00:00 2001 From: Hiltjo Posthuma Date: Sat, 22 Apr 2017 14:38:39 +0200 Subject: 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. --- README | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 10f1884..b2bf8e8 100644 --- a/README +++ b/README @@ -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. -- cgit v1.2.3