about summary refs log tree commit homepage
path: root/Documentation/public-inbox-extindex.pod
DateCommit message (Collapse)
2024-04-29extindex: support --no-multi-pack-index HEAD master
git multi-pack-index files were creating swap storms and OOM-ing on my system; so providing an option to disable it seems prudent given the minor startup time regression.
2023-11-26doc/extindex: document --dedupe switch
We've had it since v1.7.0 when -extindex was introduced, but it was never documented outside of commit messages. Reviewed-by: Štěpán Němec <stepnem@smrk.net>
2023-11-16extindex: warn and hint about --gc on bad ibx_id
Stale entries from newsgroup name changes (including adding a `publicinbox.<name>.newsgroup' entry when none existed before) can wreak havoc during a --reindex. So give the hint to users about running -extindex with --gc to clean up stale entries.
2023-09-11treewide: favor Xapian (SWIG binding) over Search::Xapian
The Xapian SWIG bindings are favored by Xapian upstream for ease-of-maintenance compared to the XS version. While Debian lags on this front, the SWIG bindings are widely available on all *BSDs.
2023-08-17doc: extindex: note the use of `newsgroup' entries
We'll also be using this for -cindex for associating inboxes to coderepos.
2023-08-17doc: *index: fix misuse of apostrophe in `its'
Reported-by: Kyle Meyer <kyle@kyleam.com> Link: https://public-inbox.org/meta/87leeovmig.fsf@kyleam.com/
2023-02-16doc: extindex update on configuration and union section
The coderepo indexer will use similar ideas, I think...
2022-03-08index|extindex: support --dangerous flag
This enables Xapian::DB_DANGEROUS to support in-place updates. This can speed up the initial index and reduce I/O at the cost of preventing concurrent readers and being unsafe in the face of any abnormal terminations. This is more dangerous than --no-fsync. --no-fsync is only unsafe in the event of a power loss or kernel crash; --dangerous is unsafe even on SIGKILL.
2021-11-03doc: extindex: document current behavior + knobs
I'm not really sure if extindex writing to the config file is a good idea (since -index doesn't, as -init exists). Just document what it does and let the user handle it, since the config file shouldn't be daunting to new users.
2021-10-09extindex: support --reindex --fast
This mode only checks history for missed/stale messages and doesn't attempt to reindex messages which are already indexed.
2021-09-01extindex: document --all and indexlevel=basic interaction
Cache is expensive, so help users save on storage by documenting this behavior.
2021-05-17doc: split option variants into separate items
e226f18934eb7291 modified the lei-q manpage so that each variant of an option gets a dedicated =item to make L</--xyz> look nicer and to follow the Perl core documentation. Do the same for the other manpages. Note that this still leaves the variants of an option grouped in one scenario: when a list of options without descriptions is presented as a pointer to another location. Splitting the variants in that case would make it harder for the reader to tell what the distinct options are.
2021-05-04treewide: update to v3 Tor onions
v2 onions are insecure, deprecated and going away. v3 names are unfortunately longer and more difficult to remember, but should be more resistant to attack than v2 ones.
2021-01-26doc: start working on public-inbox-extindex(1) manpage
It's barely started, but I started writing this weeks ago, but I'm still unsure about some behavioral/usability things and hoping work on lei(1) can flush them out.