From a26c1b2faa98866dcc505fe94021f67d77a0d5fe Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 20 Jul 2012 15:03:42 +0000
Subject: [PATCH] Fix for OpenDJ-547: Manual typos and odd wording
---
opendj3/src/main/docbkx/admin-guide/chap-mv-servers.xml | 2 +-
opendj3/src/main/docbkx/admin-guide/chap-troubleshooting.xml | 16 ++++++++--------
opendj3/src/main/docbkx/admin-guide/chap-tuning.xml | 28 ++++++++++++++++------------
3 files changed, 25 insertions(+), 21 deletions(-)
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-mv-servers.xml b/opendj3/src/main/docbkx/admin-guide/chap-mv-servers.xml
index fe1acce..319bf99 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-mv-servers.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-mv-servers.xml
@@ -168,7 +168,7 @@
</step>
<step performance="optional">
<para>If you must change port numbers, edit the port numbers in
- <filename>config/config.ldif</filename>, carefully avoiding to change
+ <filename>config/config.ldif</filename>, carefully avoiding changing
any whitespace or other lines in the file.</para>
</step>
<step>
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-troubleshooting.xml b/opendj3/src/main/docbkx/admin-guide/chap-troubleshooting.xml
index 547e390..d83ebbf 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-troubleshooting.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-troubleshooting.xml
@@ -284,13 +284,15 @@
the <option>--skipSchemaValidation</option> with the
<command>import-ldif</command> command.</para>
- <para>OpenDJ also ensures by default that entries have only one inheritance
- of structural object classes. You can relax this behavior by using the
- advanced global configuration property,
+ <para>OpenDJ also ensures by default that entries have only one structural
+ object class. You can relax this behavior by using the advanced global
+ configuration property,
<literal>single-structural-objectclass-behavior</literal>. This can be useful
when importing data exported from Sun Directory Server. For example, to
warn when entries have more than one structural object class instead of
- reject such entries being added, set the property as follows.</para>
+ reject such entries being added, set
+ <literal>single-structural-objectclass-behavior:warn</literal> as
+ follows.</para>
<screen>$ dsconfig
set-global-configuration-prop
@@ -615,10 +617,8 @@
<para>Alternatively, stop OpenDJ, edit the corresponding ACI carefully in
<filename>/path/to/OpenDJ/config/config.ldif</filename>, and restart OpenDJ.
<footnote><para>Unlike the <command>dsconfig</command> command, the
- <filename>config.ldif</filename> file is not a public interface. In this
- particular case, however, the <command>dsconfig</command> command is such a
- pain in the nether regions that you might as well edit the LDIF instead
- (unless you are doing this in production).</para></footnote></para>
+ <filename>config.ldif</filename> file is not a public interface, so this
+ alternative should not be used in production.</para></footnote></para>
</section>
</section>
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-tuning.xml b/opendj3/src/main/docbkx/admin-guide/chap-tuning.xml
index 717c79c..1806b37 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-tuning.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-tuning.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<chapter xml:id='chap-tuning'
@@ -320,15 +320,19 @@
<section xml:id="perf-data-storage">
<title>Data Storage Settings</title>
- <para>By default, OpenDJ does use compact data encoding, reducing size used
- by attribute type and object class strings. However, OpenDJ does try to
- compress entries by default. You can potentially gain space by setting the
- backend property <literal>entries-compressed</literal> to
- <literal>true</literal> before you (re-)import data from LDIF. OpenDJ
- compresses entries before writing them to the database, but does not
- proactively rewrite all entries in the database after you change the
- settings, so to force OpenDJ to compress the entries, import the data
- from LDIF.</para>
+ <para>By default, OpenDJ compressing attribute descriptions and object class
+ sets to reduce data size. This is called compact encoding.</para>
+
+ <para>By default, OpenDJ does not however compress entries stored in its
+ backend database. If your entries hold values that compress well —
+ such as text, and not JPEG photos or MP3 audio — you can gain space
+ by setting the local DB backend property
+ <literal>entries-compressed</literal> to <literal>true</literal> before you
+ (re-)import data from LDIF. With <literal>entries-compressed: true</literal>
+ OpenDJ compresses entries before writing them to the database.<footnote>
+ <para>OpenDJ does not proactively rewrite all entries in the database after
+ you change the settings. Instead, to force OpenDJ to compress all entries,
+ import the data from LDIF.</para></footnote></para>
<screen>$ dsconfig
set-backend-prop
@@ -460,8 +464,8 @@
help troubleshoot any issues that arise.</para>
<para>For OpenDJ servers handling very high throughput, however, such as
- 100,000 operations per second or more, the access log constitue a performance
- bottleneck, as each client request results in multiple access log
+ 100,000 operations per second or more, the access log constitute a
+ performance bottleneck, as each client request results in multiple access log
messages. Consider disabling the access log in such cases.</para>
<screen>$ dsconfig
--
Gitblit v1.10.0