mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Mark Craig
22.54.2015 9d0ac36955369c4d6398723873ed66c9f741cf41
CR-5841 OPENDJ-1738 Update doc for new changelog impl
2 files modified
104 ■■■■ changed files
opendj3-server-dev/src/main/docbkx/admin-guide/appendix-file-layout.xml 64 ●●●●● patch | view | raw | blame | history
opendj3-server-dev/src/main/docbkx/release-notes/chap-whats-new.xml 40 ●●●● patch | view | raw | blame | history
opendj3-server-dev/src/main/docbkx/admin-guide/appendix-file-layout.xml
@@ -10,7 +10,7 @@
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
@@ -20,29 +20,46 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !      Copyright 2011-2015 ForgeRock AS.
  !    
-->
<appendix xml:id='appendix-file-layout'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
          xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
          xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
          xsi:schemaLocation='http://docbook.org/ns/docbook
                              http://docbook.org/xml/5.0/xsd/docbook.xsd'>
 <title>File Layout</title>
 <para>OpenDJ software installs and creates the following files and
 directories. The following list is not necessarily exhaustive.</para>
 <para>
  OpenDJ software installs and creates the following files and directories.
  The following list is not meant to be exhaustive.
 </para>
 <indexterm><primary>File layout</primary></indexterm>
 <indexterm><primary>Installed files</primary></indexterm>
 <variablelist>
  <varlistentry>
   <term><filename>Legal</filename></term>
   <listitem>
    <para>
     License information
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term><filename>QuickSetup.app</filename></term>
   <listitem>
    <para>Mac OS X GUI for installing OpenDJ</para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term><filename>README</filename></term>
   <listitem>
    <para>
     Brief instructions on installing OpenDJ directory server
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term><filename>Uninstall.app</filename></term>
   <listitem>
    <para>Mac OS X GUI for removing OpenDJ</para>
@@ -69,8 +86,9 @@
  <varlistentry>
   <term><filename>changelogDb</filename></term>
   <listitem>
    <para>JE backend data for the external change log when using
    replication</para>
    <para>
     Backend data for the external change log when using replication
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -145,7 +163,9 @@
  <varlistentry>
   <term><filename>db</filename></term>
   <listitem>
    <para>JE backend data for backends that you create</para>
    <para>
     Backend database files for backends that hold user data
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -164,8 +184,10 @@
  <varlistentry>
   <term><filename>instance.loc</filename></term>
   <listitem>
    <para>Pointer to OpenDJ on the file system, useful in installations where
    the program files are separate from the server instance files</para>
    <para>
     Pointer to OpenDJ on the file system, provided for package installations
     where the program files are separate from the server instance files
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -175,12 +197,6 @@
   </listitem>
  </varlistentry>
  <varlistentry>
   <term><filename>legal-notices</filename></term>
   <listitem>
    <para>License information</para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term><filename>lib</filename></term>
   <listitem>
    <para>Scripts and libraries needed by OpenDJ and added to the
@@ -225,6 +241,14 @@
   </listitem>
  </varlistentry>
  <varlistentry>
   <term><filename>template</filename></term>
   <listitem>
    <para>
     Template files for a directory server instance
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term><filename>uninstall</filename></term>
   <listitem>
    <para>UNIX utility for removing OpenDJ</para>
opendj3-server-dev/src/main/docbkx/release-notes/chap-whats-new.xml
@@ -20,15 +20,15 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2014 ForgeRock AS
  !      Copyright 2011-2015 ForgeRock AS.
  !    
-->
<chapter xml:id='chap-whats-new'
  xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
  xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  xsi:schemaLocation='http://docbook.org/ns/docbook
                      http://docbook.org/xml/5.0/xsd/docbook.xsd'
  xmlns:xlink='http://www.w3.org/1999/xlink'>
         xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
         xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
         xsi:schemaLocation='http://docbook.org/ns/docbook
                             http://docbook.org/xml/5.0/xsd/docbook.xsd'
         xmlns:xlink='http://www.w3.org/1999/xlink'>
  <title>What's New in OpenDJ <?eval ${docTargetVersion}?></title>
  <para>Compared to the OpenDJ <?eval ${docPreviousVersion}?> release, OpenDJ
@@ -63,6 +63,34 @@
    </listitem>
    <listitem>
     <para>
      OpenDJ directory server has
      an improved replication changelog implementation
      (<link
      xlink:show="new"
      xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-1215"
      >OPENDJ-1215</link>).
      The configuration refers to the previous implementation
      as <literal>je</literal> because it uses Berkeley DB Java Edition,
      and to the new implementation
      as <literal>log</literal> because it uses log files.
     </para>
     <para>
      When you install a replicated directory server,
      the new implementation is selected by default.
     </para>
     <para>
      After upgrading a replicated directory server,
      you can use the new implementation
      by changing the advanced replication server configuration property
      <literal>replication-db-implementation</literal>
      to <literal>log</literal> using the <command>dsconfig</command> command.
     </para>
    </listitem>
    <listitem>
     <para>Debian and RPM packages now provide service management scripts so
     that you can manage the server with the <command>service</command>, and
     include documentation files under <filename>/usr/share/doc/opendj*</filename>