INN commit: trunk (3 files)
INN Commit
Russ_Allbery at isc.org
Mon May 5 21:30:08 UTC 2008
Date: Monday, May 5, 2008 @ 14:30:08
Author: iulius
Revision: 7822
Remove old occurrences of Berkeley DB < 4.4 in documentation.
Modified:
trunk/doc/pod/install.pod
trunk/doc/pod/ovdb.pod
trunk/samples/ovdb.conf
---------------------+
doc/pod/install.pod | 4 ++--
doc/pod/ovdb.pod | 37 ++++++++++++++++---------------------
samples/ovdb.conf | 30 ++++++++++++++----------------
3 files changed, 32 insertions(+), 39 deletions(-)
Modified: doc/pod/install.pod
===================================================================
--- doc/pod/install.pod 2008-05-05 21:29:37 UTC (rev 7821)
+++ doc/pod/install.pod 2008-05-05 21:30:08 UTC (rev 7822)
@@ -149,7 +149,7 @@
--with-perl Perl 5.004_03 or higher, 5.6.1+ recommended
--with-python Python 1.5.2 or higher
- --with-berkeleydb Berkeley DB 2.0 or higher, 4.2+ recommended
+ --with-berkeleydb Berkeley DB 4.4 or higher
--with-zlib zlib 1.x or higher
--with-openssl OpenSSL 0.9.6 or higher
--with-sasl SASL 2.x or higher
@@ -406,7 +406,7 @@
=item B<--with-berkeleydb>=PATH
-Enables support for S<Berkeley DB> (2.x through 4.2.x), which means that it will
+Enables support for S<Berkeley DB> (4.4 or higher), which means that it will
then be possible to use the ovdb overview method if you wish. Enabling
this configure option doesn't mean you'll be required to use ovdb, but it
does require that S<Berkeley DB> be installed on your system (including the
Modified: doc/pod/ovdb.pod
===================================================================
--- doc/pod/ovdb.pod 2008-05-05 21:29:37 UTC (rev 7821)
+++ doc/pod/ovdb.pod 2008-05-05 21:30:08 UTC (rev 7822)
@@ -5,8 +5,8 @@
=head1 DESCRIPTION
Ovdb is a storage method that uses the S<Berkeley DB> library to store
-overview data. It requires version 2.6.x or later of the S<Berkeley DB>
-library, but has mostly been tested with version 3 and 4.
+overview data. It requires version 4.4 or later of the S<Berkeley DB>
+library.
Ovdb makes use of the full transaction/logging/locking functionality of
the S<Berkeley DB> environment. S<Berkeley DB> may be downloaded from
@@ -24,12 +24,12 @@
To build ovdb support into INN, specify the option B<--with-berkeleydb>
when running the configure script. By default, configure will search for
a S<Berkeley DB> tree in several likely locations, and choose the highest
-version (based on the name of the directory, e.g., F<BerkeleyDB.3.0>) that
+version (based on the name of the directory, e.g., F<BerkeleyDB.4.4>) that
it finds. There will be a message in the configure output indicating the
chosen pathname.
You can override this pathname by adding a path to the option, e.g.,
-B<--with-berkeleydb=/usr/BerkeleyDB.3.1>. This directory is expected to
+B<--with-berkeleydb=/usr/BerkeleyDB.4.4>. This directory is expected to
have subdirectories F<include> and F<lib>, containing F<db.h>, and the
library itself, respectively.
@@ -39,12 +39,10 @@
articles, you'll need at least S<5.5 GB> of disk space for ovdb. With compression
enabled, this estimate changes to S<0.7 KB> per article. See the L<COMPRESSION>
section below.
-With S<Berkeley DB 2.x>, the db files are 'grow only'; the library will not shrink
-them, even if data is removed. So, reserving extra space above the
-estimate is a good idea. Plus, you'll need additional space for
-transaction logs: at least S<100 MB>. By default the transaction logs go in
-the same directory as the database. To improve performance, they can be
-placed on a different disk S<-- see> the L<DB_CONFIG> section.
+Plus, you'll need additional space for transaction logs: at least S<100 MB>.
+By default the transaction logs go in the same directory as the database.
+To improve performance, they can be placed on a different disk S<-- see>
+the L<DB_CONFIG> section.
=head1 CONFIGURATION
@@ -97,8 +95,7 @@
If useshm is set to true, S<Berkeley DB> will use shared memory instead of
mmap for its environment regions (cache, lock, etc). With some platforms,
-this may improve performance. Default is false. This parameter is
-ignored if you have S<Berkeley DB 2.x>.
+this may improve performance. Default is false.
=item shmkey
@@ -106,8 +103,7 @@
S<Berkeley DB> will create several (usually 5) shared memory segments, using
sequentially numbered keys starting with 'shmkey'. Choose a key that does
not conflict with any existing shared memory segments on your system.
-Default is 6400. This parameter is only used with S<Berkeley DB 3.1> or
-newer.
+Default is 6400.
=item pagesize
@@ -131,7 +127,7 @@
=item maxlocks
-Sets the S<Berkeley DB> "lk_max" parameter, which is the maxmium number of
+Sets the S<Berkeley DB> "lk_max" parameter, which is the maximum number of
locks that can exist in the database at the same time. Default is 4000.
=item nocompact
@@ -179,9 +175,9 @@
This parameter is only used when I<readserver> is true. It sets a maximum
number of readers that a given ovdb_server process will serve at one time.
This means the maximum number of readers for all of the ovdb_server
-processes is (numrsprocs * maxrsconn). This does B<not> limit the actual
+processes is (numrsprocs * maxrsconn). This does B<not> limit the actual
number of readers, since nnrpd will fall back to opening the database
-directly if it can't connect to a readserver. Default is 0, which means an
+directly if it can't connect to a readserver. Default is 0, which means an
umlimited number of connections is allowed.
=back
@@ -189,11 +185,11 @@
=head1 COMPRESSION
New in this version of OVDB is the ability to compress overview data
-before it is stored into the database. In addition to consuming less disk
+before it is stored into the database. In addition to consuming less disk
space, compression keeps the average size of the database keys smaller.
This in turn increases the average number of keys per page, which can
significantly improve performance and also helps keep the database more
-compact. This feature requires that INN be built with zlib. Only records
+compact. This feature requires that INN be built with zlib. Only records
larger than 600 bytes get compressed, because that is the point at which
compression starts to become significant.
@@ -247,8 +243,6 @@
set_data_dir /mnt/ov3
set_data_dir /mnt/ov4
-(For S<Berkeley DB 2.x>, replace C<set_data_dir> with C<DB_DATA_DIR>.)
-
Distribute your ovNNNNN files into the four filesystems. (say, 8 each).
When called upon to open a database file, the db library will look for it
in each of the specified directories (in order). If said file is not
@@ -362,3 +356,4 @@
L<http://www.sleepycat.com/>.
=cut
+
Modified: samples/ovdb.conf
===================================================================
--- samples/ovdb.conf 2008-05-05 21:29:37 UTC (rev 7821)
+++ samples/ovdb.conf 2008-05-05 21:30:08 UTC (rev 7822)
@@ -2,19 +2,19 @@
# is set in inn.conf with the 'pathoverview' option. Other parameters
# for tuning ovdb are in this file.
-# Compression: if INN was compiled with zlib, and this compress
-# parameter is true, OVDB will compress overview records that are
+# Compression: if INN was compiled with zlib, and this compress
+# parameter is true, ovdb will compress overview records that are
# longer than 600 bytes. See the ovdb(5) man page for more information.
# Default is false.
#compress false
# Size of the memory pool cache, in Kilobytes. The cache will have a
# backing store file in the DB directory which will be at least as big.
-# In general, the bigger the cache, the better. Use C<ovdb_stat -m> to see
+# In general, the bigger the cache, the better. Use 'ovdb_stat -m' to see
# cache hit percentages. If they're less than 80%, try increasing the
# cache size. To make a change of this parameter take effect, shut down
# and restart INN (be sure to kill all of the nnrpds when shutting down).
-# Default is 8000, which is adequate for small to medium sized servers.
+# Default is 8000, which is adequate for small to medium-sized servers.
# Large servers will probably need at least 14000.
#cachesize 8000
@@ -22,28 +22,26 @@
# innd will keep all of the files open, so don't set this too high
# or innd may run out of file descriptors. The nnrpds only open one
# at a time, regardless. May be set to one, or just a few, but only
-# do that if your OS supports large (>2G) files. Changing this
+# do that if your OS supports large (> 2 GB) files. Changing this
# parameter has no effect on an already-established database.
#numdbfiles 32
-# If txn_nosync is set to false, BerkeleyDB flushes the log after every
+# If txn_nosync is set to false, Berkeley DB flushes the log after every
# transaction. This minimizes the number of transactions that may be
# lost in the event of a crash, but results in significantly degraded
# performance. Default is true.
#txn_nosync true
-# If useshm is set to true, BerkeleyDB will use shared memory instead
+# If useshm is set to true, Berkeley DB will use shared memory instead
# of mmap for its environment regions (cache, lock, etc). With some
# platforms, this may improve performance. Default is false.
-# This parameter is ignored if you have BerkeleyDB 2.x
#useshm false
-# Sets the shared memory key used by BerkeleyDB when 'useshm' is true.
-# BerkeleyDB will create several (usually 5) shared memory segments,
+# Sets the shared memory key used by Berkeley DB when 'useshm' is true.
+# Berkeley DB will create several (usually 5) shared memory segments,
# using sequentially numbered keys starting with 'shmkey'.
# Choose a key that does not conflict with any existing shared memory
-# segments on your system. Default is 6400. This parameter is only
-# used with BerkeleyDB 3.1 or newer.
+# segments on your system. Default is 6400.
#shmkey 6400
# Sets the page size for the DB files (in bytes). Must be a power of 2.
@@ -51,7 +49,7 @@
# Changing this parameter has no effect on an already-established database.
#pagesize 8192
-# Sets the minimum number of keys per page. See the BerkeleyDB
+# Sets the minimum number of keys per page. See the Berkeley DB
# documentation for more info. Default is based on page size:
#
# default_minkey = MAX(2, pagesize / 2600) if compress is false
@@ -63,13 +61,13 @@
# Changing this parameter has no effect on an already-established database.
#minkey 3
-# Sets the BerkeleyDB "lk_max" parameter, which is the maxmium number
+# Sets the Berkeley DB "lk_max" parameter, which is the maximum number
# of locks that can exist in the database at the same time. Default
# is 4000.
#maxlocks 4000
# The nocompact parameter affects expireover's behavior. The expireover
-# function in ovdb can do its job in one of two ways: By simply deleting
+# function in ovdb can do its job in one of two ways: by simply deleting
# expired records from the database; or by re-writing the overview records
# into a different location leaving out the expired records. The first
# method is faster, but it leaves 'holes' that result in space that can
@@ -86,7 +84,7 @@
# will probably be removed in the future.
#nocompact 1
-# Normally, each nnrpd process directly accesses the BerkeleyDB environment.
+# Normally, each nnrpd process directly accesses the Berkeley DB environment.
# The process of attaching to the database (and detaching when finished) is
# fairly expensive, and can result in high loads in situations when there are
# lots of reader connections of relatively short duration.
More information about the inn-committers
mailing list