diff options
author | Eric Wong <e@yhbt.net> | 2020-08-10 02:12:00 +0000 |
---|---|---|
committer | Eric Wong <e@yhbt.net> | 2020-08-10 06:26:21 +0000 |
commit | 6a7e3c6f870d0555184b68940eb373fa102d4102 (patch) | |
tree | a0b696867ad31baba92ad4af64b76ae5aec031ea /Documentation | |
parent | 5fdedf809e7f236c7e50177bff8426a9befbcceb (diff) | |
download | public-inbox-6a7e3c6f870d0555184b68940eb373fa102d4102.tar.gz |
Move away from hard-to-read alllowercase naming and favor snake_case or separated-by-dashes. We'll keep `--indexlevel' as-is for now, since it's been around for several releases; but we'll support `--index-level' in the CLI and update our documentation in a few months. We'll also clarify that publicInbox.indexMaxSize is only intended for -index, and not -watch or -mda.
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/public-inbox-index.pod | 6 | ||||
-rw-r--r-- | Documentation/public-inbox-init.pod | 2 |
2 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod index 10cf2d19..b28db773 100644 --- a/Documentation/public-inbox-index.pod +++ b/Documentation/public-inbox-index.pod @@ -158,7 +158,11 @@ value. A single suffix modifier of C<k>, C<m> or C<g> is supported, thus the value of C<1m> to prevents indexing of messages larger than one megabyte. -This is useful for avoiding memory exhaustion in mirrors. +This is useful for avoiding memory exhaustion in mirrors +via git. It does not prevent L<public-inbox-mda(1)> or +L<public-inbox-watch(1)> from importing (and indexing) +a message. + This option is only available in public-inbox 1.5 or later. Default: none diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod index fd9fc637..d0c87563 100644 --- a/Documentation/public-inbox-init.pod +++ b/Documentation/public-inbox-init.pod @@ -31,7 +31,7 @@ L<DBD::SQLite>. Default: C<1> -=item --indexlevel <basic|medium|full> +=item -L, --indexlevel <basic|medium|full> Controls the indexing level for L<public-inbox-index(1)> |