INN commit: branches/2.6/doc (FAQ pod/inn.conf.pod pod/install.pod)

[INN Commit]

    Date: Tuesday, January 5, 2021 @ 12:37:38
  Author: iulius
Revision: 10500

Detail and homogenize the description of our 3 overview methods

Modified:
  branches/2.6/doc/FAQ
  branches/2.6/doc/pod/inn.conf.pod
  branches/2.6/doc/pod/install.pod

------------------+
 FAQ              |   24 +++++++++++++++++++-----
 pod/inn.conf.pod |   27 +++++++++++++++++++--------
 pod/install.pod  |   33 +++++++++++++++++++--------------
 3 files changed, 57 insertions(+), 27 deletions(-)

Modified: FAQ
===================================================================
--- FAQ	2021-01-05 20:29:16 UTC (rev 10499)
+++ FAQ	2021-01-05 20:37:38 UTC (rev 10500)
@@ -453,12 +453,26 @@
 
 Any INN server that supports readers must therefore have an overview
 method configured.  There are three different methods to choose from:
-tradindexed, which is the slowest but the best tested and most reliable
-and the method with the best recovery tools; buffindexed, which is fast at
-writing because it uses preconfigured large buffers like CNFS, but which
-is harder to recover; and the experimental ovdb overview method, which
-stores overview information in a BerkeleyDB database.
 
+  - buffindexed, which stores overview data and index information
+    into preconfigured large files like CNFS.  Fast at writing, the
+    buffindexed overview storage method can keep up with a large feed
+    more easily and never consumes additional disk space beyond that
+    allocated to these buffers.  The downside is that these buffers
+    are hard to recover in case of corruption and somewhat slower for
+    readers and the expiry process;
+
+  - ovdb, which stores overview information into a Berkeley DB database,
+    whose development pace has stalled these last years.  This method
+    is fast and very robust, but may require more disk space, unless
+    compression is enabled;
+
+  - tradindexed, which uses two files per newsgroup, one containing
+    the overview data and one containing the index.  Fast for readers,
+    but slow to write to because it has to update two files for each
+    incoming article.  Its main advantage is to be the best tested,
+    the most reliable and the method with the best recovery tools.
+
 ------------------------------
 
 Subject: 2.5. What are deferrals (NNTP code 431)?

Modified: pod/inn.conf.pod
===================================================================
--- pod/inn.conf.pod	2021-01-05 20:29:16 UTC (rev 10499)
+++ pod/inn.conf.pod	2021-01-05 20:37:38 UTC (rev 10500)
@@ -594,7 +594,7 @@
 =item I<ovmethod>
 
 Which overview storage method to use.  Currently supported values are
-C<tradindexed>, C<buffindexed>, and C<ovdb>.  There is no default value;
+C<buffindexed>, C<ovdb> and C<tradindexed>.  There is no default value;
 this parameter must be set if I<enableoverview> is true (the default).
 
 =over 4
@@ -601,18 +601,29 @@
 
 =item C<buffindexed>
 
-Stores overview data and index information into buffers, which are
-preconfigured files defined in F<buffindexed.conf>.  C<buffindexed> never
+It stores overview data and index information into preconfigured
+large files like CNFS.  Fast at writing, the C<buffindexed> overview
+storage method can keep up with a large feed more easily and never
 consumes additional disk space beyond that allocated to these buffers.
+The downside is that these buffers are hard to recover in case of
+corruption and somewhat slower for readers and the expiry process.
+See the buffindexed.conf(5) man page for more details, and notably how
+to create the buffers.
 
-=item C<tradindexed>
+=item C<ovdb>
 
-Uses two files per newsgroup, one containing the overview data and one
-containing the index.  Fast for readers, but slow to write to.
+It stores overview information into a S<Berkeley DB> database, whose
+development pace has stalled these last years.  This method is fast
+and very robust, but may require more disk space, unless compression
+is enabled.  See the ovdb(5) man page for more details.
 
-=item C<ovdb>
+=item C<tradindexed>
 
-Stores data into a S<Berkeley DB> database.  See the ovdb(5) man page.
+It uses two files per newsgroup, one containing the overview data
+and one containing the index.  Fast for readers, but slow to write to
+because it has to update two files for each incoming article.  Its main
+advantage is to be the best tested, the most reliable and the method
+with the best recovery tools.
 
 =back
 

Modified: pod/install.pod
===================================================================
--- pod/install.pod	2021-01-05 20:29:16 UTC (rev 10499)
+++ pod/install.pod	2021-01-05 20:37:38 UTC (rev 10500)
@@ -673,26 +673,31 @@
 
 =over 4
 
-=item tradindexed
-
-It is very fast for readers, but it has to update two files for each
-incoming article and can be quite slow to write.
-
 =item buffindexed
 
-It can keep up with a large feed more easily, since it uses large buffers
-to store all overview information, but it's somewhat slower for readers
-(although not as slow as the unified overview in S<INN 2.2>).  You will need
-to create the buffers for it to use (very similar to creating CNFS buffers)
-and list the available buffers in F<buffindexed.conf>.  See
-buffindexed.conf(5) for more information.
+It stores overview data and index information into preconfigured large files
+like CNFS.  Fast at writing, the C<buffindexed> overview storage method
+can keep up with a large feed more easily and never consumes additional
+disk space beyond that allocated to these buffers.  The downside is that
+these buffers are hard to recover in case of corruption and somewhat
+slower for readers and the expiry process.  See the buffindexed.conf(5)
+man page for more details, and notably how to create the buffers.
 
 =item ovdb
 
-It stores overview data in a S<Berkeley DB> database; it's fast and very robust,
-but may require more disk space.  See the ovdb(5) man page for more
-information on it.
+It stores overview information into a S<Berkeley DB> database, whose
+development pace has stalled these last years.  This method is fast
+and very robust, but may require more disk space, unless compression
+is enabled.  See the ovdb(5) man page for more details.
 
+=item tradindexed
+
+It uses two files per newsgroup, one containing the overview data
+and one containing the index.  Fast for readers, but slow to write to
+because it has to update two files for each incoming article.  Its main
+advantage is to be the best tested, the most reliable and the method
+with the best recovery tools.
+
 =back
 
 =head1 Configuring INN