INN commit: trunk/doc/pod (cycbuff.conf.pod storage.conf.pod)

[INN Commit]

    Date: Sunday, November 27, 2016 @ 05:28:46
  Author: iulius
Revision: 10125

Document cancels and cycbuff reallocation in storage methods

Modified:
  trunk/doc/pod/cycbuff.conf.pod
  trunk/doc/pod/storage.conf.pod

------------------+
 cycbuff.conf.pod |    4 ++++
 storage.conf.pod |   14 ++++++++++----
 2 files changed, 14 insertions(+), 4 deletions(-)

Modified: cycbuff.conf.pod
===================================================================
--- cycbuff.conf.pod	2016-11-26 21:08:57 UTC (rev 10124)
+++ cycbuff.conf.pod	2016-11-27 13:28:46 UTC (rev 10125)
@@ -120,6 +120,10 @@
 
 Adding a new cycbuff just requires creating it (see below), adding a
 cycbuff line, adding it to a metacycbuff, and then restarting B<innd>.
+Similarly, changing the allocation of an existing cycbuff from a
+metacycbuff to another one just requires modifying the two metacycbuffs
+accordingly, and then restarting B<innd>.  (Only the cycbuff is noted
+noted in the storage API tokens.)
 
 =head1 CREATING CYCBUFFS
 

Modified: storage.conf.pod
===================================================================
--- storage.conf.pod	2016-11-26 21:08:57 UTC (rev 10124)
+++ storage.conf.pod	2016-11-27 13:28:46 UTC (rev 10125)
@@ -171,7 +171,10 @@
 expire time of articles stored in CNFS buffers is therefore entirely
 determined by how long it takes the buffer to wrap around, which depends
 on how quickly data is being stored in it.  (This method is therefore said
-to have self-expire functionality.)  EXPENSIVESTAT is false for this method.
+to have self-expire functionality.  It also means that when an article is
+cancelled, the cycbuff doesn't go back and use space until it rolls over and
+the whole cycbuff starts being reused.)  EXPENSIVESTAT is false for this
+method.
 
 CNFS has its own configuration file, F<cycbuff.conf>, which describes some
 subtleties to the basic description given above.  Storage method entries
@@ -205,7 +208,8 @@
 is converted to hexadecimal and interpreted as C<0xaabbccdd>, with
 C<aa>, C<bb>, and C<cc> used to build the path.)  This method does not
 have self-expire functionality (meaning B<expire> has to run periodically
-to delete old articles).  EXPENSIVESTAT is false for this method.
+to delete old articles, as well as cancelled articles if I<immediatecancel>
+is not set to true in F<inn.conf>).  EXPENSIVESTAT is false for this method.
 
 Advantages:  It is roughly four times faster than C<timehash> for article
 writes, since much of the file system overhead is bypassed, while still
@@ -228,7 +232,8 @@
 hexadecimal sequence number, and C<bb>, C<cc>, and C<aadd> are components
 of the arrival time in hexadecimal (the arrival time is interpreted as
 documented above under C<timecaf>).  This method does not have self-expire
-functionality.  EXPENSIVESTAT is true for this method.
+functionality.  Cancelled articles are removed immediately.  EXPENSIVESTAT
+is true for this method.
 
 Advantages:  Heavy traffic groups do not cause bottlenecks, and a fine control
 of article retention time is still possible.
@@ -252,7 +257,8 @@
 (using either hard or symbolic links).  This is the way versions of INN
 prior to 2.0 stored all articles, as well as being the article storage format
 used by C News and earlier news systems.  This method does not have
-self-expire functionality.  EXPENSIVESTAT is true for this method.
+self-expire functionality.  Cancelled articles are removed immediately.
+EXPENSIVESTAT is true for this method.
 
 Advantages:  It is widely used and well-understood; it can read article
 spools written by older versions of INN and it is compatible with all