about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2019-03-08 01:21:22 +0000
committerEric Wong <e@80x24.org>2019-04-04 09:13:58 +0000
commit5af881d954a4ab14e08dd806dd4de1e9f26bfd12 (patch)
tree12e5a0286b841065671a7b3cd0fcfd4db80625fe /Documentation
parent721368cd04bfbd03c0d9173fff633ae34f16409a (diff)
We can save admins the trouble of declaring [coderepo "..."]
sections in the public-inbox config by parsing the cgitrc

Macro expansion (e.g. $HTTP_HOST) expansion is not supported,
yet; but may be in the future.
Diffstat (limited to 'Documentation')
1 files changed, 13 insertions, 2 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index 27d27e4e..5ee93e2e 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -188,16 +188,27 @@ be treated as the default value.
 Default: 25
-=item coderepo.<name>.dir
+=item coderepo.<nick>.dir
 The path to a git repository for "publicinbox.<name>.coderepo"
-=item coderepo.<name>.cgitUrl
+=item coderepo.<nick>.cgitUrl
 The URL of the cgit instance associated with the coderepo.
 Default: none
+=item publicinbox.cgitrc
+A path to a L<cgitrc(5)> file.  "repo.url" directives in the cgitrc
+will be mapped to the nickname of a coderepo (without trailing slash),
+and "repo.path" directives map to "coderepo.<nick>.dir".
+Use of this directive allows admins of existing cgit installations
+to skip declaring coderepo sections and map inboxes directly to
+code repositories known to cgit.
+Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.