aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2021-08-13 14:14:25 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2021-08-13 14:14:25 -0400
commite5e79d0a7e4b86c891c425913b8d0da80b341bb5 (patch)
treefc36625b11c9a5ac426c2b0ff693ce718583905e
parent02d020c07386189b9ed98ee39c60106aeb91ec81 (diff)
downloadgrokmirror-e5e79d0a7e4b86c891c425913b8d0da80b341bb5.tar.gz
Update manpage for grok-pi-indexer
Added -t and -p flags for when public-inbox databases are separate from git trees. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
-rw-r--r--man/grok-pi-indexer.116
-rw-r--r--man/grok-pi-indexer.1.rst14
2 files changed, 20 insertions, 10 deletions
diff --git a/man/grok-pi-indexer.1 b/man/grok-pi-indexer.1
index abe74b3..bc53bb8 100644
--- a/man/grok-pi-indexer.1
+++ b/man/grok-pi-indexer.1
@@ -35,8 +35,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.INDENT 3.5
.INDENT 0.0
.TP
-.B grok\-pi\-indexer [\-h] [\-v] \-c PICONFIG [\-l LOGFILE] [\-L INDEXLEVEL]
-[\-j JOBS] [\-\-no\-fsync]
+.B grok\-pi\-indexer [\-h] [\-v] \-c PICONFIG \-t TOPLEVEL [\-p PITOPLEVEL]
+[\-l LOGFILE] [\-L INDEXLEVEL] [\-j JOBS] [\-\-no\-fsync]
{init,update,extindex} ...
.UNINDENT
.UNINDENT
@@ -75,10 +75,10 @@ purge = no
# If you have many CPUs and fast disks, you may want to raise \-j to a higher number
# You can also set publicinbox.indexBatchSize to a higher number in PI_CONFIG if
# you have lots of RAM, but probably not higher than 256m
-post_clone_complete_hook = /usr/bin/grok\-pi\-indexer \-c /etc/public\-inbox/config \-j 2 \-\-no\-fsync init
-post_update_hook = /usr/bin/grok\-pi\-indexer \-c /etc/public\-inbox/config update
+post_clone_complete_hook = /usr/bin/grok\-pi\-indexer \-c /etc/public\-inbox/config \-t ${core:toplevel} init
+post_update_hook = /usr/bin/grok\-pi\-indexer \-c /etc/public\-inbox/config \-t ${core:toplevel} update
# Uncomment if you\(aqve defined any [extindex] sections
-#post_work_complete_hook = /usr/bin/grok\-pi\-indexer \-c /etc/public\-inbox/config \-j 2 \-\-no\-fsync extindex
+#post_work_complete_hook = /usr/bin/grok\-pi\-indexer \-c /etc/public\-inbox/config \-t ${core:toplevel} extindex
[fsck]
frequency = 30
@@ -105,6 +105,12 @@ Be verbose and tell us what you are doing (default: False)
.BI \-c \ PICONFIG\fR,\fB \ \-\-pi\-config \ PICONFIG
Location of the public\-inbox configuration file (default: None)
.TP
+.BI \-t \ TOPLEVEL\fR,\fB \ \-\-toplevel \ TOPLEVEL
+Path to git repository mirror toplevel (default: None)
+.TP
+.BI \-p \ PITOPLEVEL\fR,\fB \ \-\-pi\-toplevel \ PITOPLEVEL
+Path to public\-inbox toplevel, if separate (default: None)
+.TP
.BI \-l \ LOGFILE\fR,\fB \ \-\-logfile \ LOGFILE
Log activity in this log file (default: None)
.TP
diff --git a/man/grok-pi-indexer.1.rst b/man/grok-pi-indexer.1.rst
index f52fede..17db0af 100644
--- a/man/grok-pi-indexer.1.rst
+++ b/man/grok-pi-indexer.1.rst
@@ -13,8 +13,8 @@ Hook script for indexing mirrored public-inbox repos
SYNOPSIS
--------
- grok-pi-indexer [-h] [-v] -c PICONFIG [-l LOGFILE] [-L INDEXLEVEL]
- [-j JOBS] [--no-fsync]
+ grok-pi-indexer [-h] [-v] -c PICONFIG -t TOPLEVEL [-p PITOPLEVEL]
+ [-l LOGFILE] [-L INDEXLEVEL] [-j JOBS] [--no-fsync]
{init,update,extindex} ...
DESCRIPTION
@@ -47,10 +47,10 @@ the following grokmirror configuration file to mirror lore.kernel.org::
# If you have many CPUs and fast disks, you may want to raise -j to a higher number
# You can also set publicinbox.indexBatchSize to a higher number in PI_CONFIG if
# you have lots of RAM, but probably not higher than 256m
- post_clone_complete_hook = /usr/bin/grok-pi-indexer -c /etc/public-inbox/config -j 2 --no-fsync init
- post_update_hook = /usr/bin/grok-pi-indexer -c /etc/public-inbox/config update
+ post_clone_complete_hook = /usr/bin/grok-pi-indexer -c /etc/public-inbox/config -t ${core:toplevel} init
+ post_update_hook = /usr/bin/grok-pi-indexer -c /etc/public-inbox/config -t ${core:toplevel} update
# Uncomment if you've defined any [extindex] sections
- #post_work_complete_hook = /usr/bin/grok-pi-indexer -c /etc/public-inbox/config -j 2 --no-fsync extindex
+ #post_work_complete_hook = /usr/bin/grok-pi-indexer -c /etc/public-inbox/config -t ${core:toplevel} extindex
[fsck]
frequency = 30
@@ -68,6 +68,10 @@ OPTIONS
-v, --verbose Be verbose and tell us what you are doing (default: False)
-c PICONFIG, --pi-config PICONFIG
Location of the public-inbox configuration file (default: None)
+ -t TOPLEVEL, --toplevel TOPLEVEL
+ Path to git repository mirror toplevel (default: None)
+ -p PITOPLEVEL, --pi-toplevel PITOPLEVEL
+ Path to public-inbox toplevel, if separate (default: None)
-l LOGFILE, --logfile LOGFILE
Log activity in this log file (default: None)
-L INDEXLEVEL, --indexlevel INDEXLEVEL