]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[master] documentation updates
authorJeremy C. Reed <jreed@isc.org>
Wed, 14 Nov 2012 17:28:53 +0000 (11:28 -0600)
committerJeremy C. Reed <jreed@isc.org>
Wed, 14 Nov 2012 17:28:53 +0000 (11:28 -0600)
 Remove some references to experimental, development, prototype

 Mention that bind10 doesn't start the DNS or DHCP servers by default.
 Also reword a couple sentences so this is not implied.
 This is for ticket #2451.

This was not reviewed. The changes are minor.

README
doc/guide/bind10-guide.xml

diff --git a/README b/README
index 4ef941e886700dedd2b12525c426090cbc24d118..e9d052c1a376354403bc2e2775ddba1d109fd18f 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,11 @@
 
-This is the source for the development version of BIND 10.
+This is the source for the BIND 10 suite.
 
 BIND is the popular implementation of a DNS server, developer
 interfaces, and DNS tools. BIND 10 is a rewrite of BIND 9 and ISC
 DHCP. BIND 10 is written in C++ and Python and provides a modular
 environment for serving, maintaining, and developing DNS and DHCP.
 
-BIND10-devel is new development leading up to the production
-BIND 10 release. It contains prototype code and experimental
-interfaces. Nevertheless it is ready to use now for testing the
-new BIND 10 infrastructure ideas.
-
 This release includes the bind10 master process, b10-msgq message
 bus, b10-auth authoritative DNS server (with SQLite3 and in-memory
 backends), b10-resolver recursive or forwarding DNS server, b10-cmdctl
@@ -62,3 +57,6 @@ For operating system specific tips see the wiki at:
        http://bind10.isc.org/wiki/SystemSpecificNotes
 
 Please see the wiki and the doc/ directory for various documentation.
+
+The BIND 10 suite is started by running "bind10". Note that the
+default configuration does not run any DNS or DHCP servers.
index 675414f57c1ab87ce8b3b5f706c08957d7918785..c0bc2b3cee4e6a0d1de20e790570eeae4a40d8f2 100644 (file)
@@ -84,8 +84,7 @@
     </para>
 
     <para>
-      This guide covers the experimental prototype of
-      BIND 10 version &__VERSION__;.
+      This guide covers BIND 10 version &__VERSION__;.
     </para>
 
     <section>
         However, these processes are started, stopped, and maintained
         by a single command, <command>bind10</command>.
         This command starts a master process which will start other
-        processes as needed.
-        The processes started by the <command>bind10</command>
+        required processes and other processes when configured.
+        The processes that may be started by the <command>bind10</command>
         command have names starting with "b10-", including:
       </para>
 
       </para>
 
       <para>
-        These are ran by <command>bind10</command>
-        and do not need to be manually started independently.
+        These do not need to be manually started independently.
       </para>
 
     </section>
@@ -835,6 +833,7 @@ as a dependency earlier -->
       <command>b10-cmdctl</command> for administration tools to
       communicate with the system, and
       <command>b10-stats</command> for statistics collection.
+      The DNS and DHCP servers are not started by default.
       The configuration of components to start is covered in
       <xref linkend="bind10.components"/>.
     </para>
@@ -920,7 +919,7 @@ as a dependency earlier -->
 <!-- TODO -->
       <note>
         <para>
-          The development prototype release only provides
+          The current release only provides
           <command>bindctl</command> as a user interface to
           <command>b10-cmdctl</command>.
           Upcoming releases will provide another interactive command-line
@@ -1142,7 +1141,7 @@ TODO
     <title>Control and configure user interface</title>
 
     <note><para>
-      For this development prototype release, <command>bindctl</command>
+      For the current release, <command>bindctl</command>
       is the only user interface. It is expected that upcoming
       releases will provide another interactive command-line
       interface and a web-based interface for controlling and
@@ -2289,8 +2288,7 @@ can use various data source backends.
       By default, this is empty.
 
       <note><simpara>
-        In this development version, currently this is only used for the
-        memory data source.
+        Currently this is only used for the memory data source.
         Only the IN class is supported at this time.
         By default, the memory data source is disabled.
         Also, currently the zone file must be canonical such as
@@ -2368,7 +2366,7 @@ can use various data source backends.
       (it defaults to <quote>memory</quote>).
 
       <note><simpara>
-        In this development version, currently this only supports the
+        Currently this only supports the
         IN class and the memory data source.
       </simpara></note>
               </simpara>
@@ -2426,7 +2424,7 @@ can use various data source backends.
       </para>
 
       <note><para>
-        In the development prototype release, <command>b10-auth</command>
+        In the current release, <command>b10-auth</command>
         can serve data from a SQLite3 data source backend and from master
         files.
         Upcoming versions will be able to use multiple different
@@ -2626,7 +2624,7 @@ can use various data source backends.
 
       <note>
       <para>
-        In the development prototype release, only the SQLite3 back
+        In the current release, only the SQLite3 back
         end is used by <command>b10-loadzone</command>.
         By default, it stores the zone data in
         <filename>/usr/local/var/bind10-devel/zone.sqlite3</filename>
@@ -2967,7 +2965,8 @@ what is XfroutClient xfr_client??
         underlying data source storing the zone data be writable.
         In the current implementation this means the zone must be stored
         in an SQLite3-based data source.
-       Also, in this development version, the <command>b10-ddns</command>
+<!-- TODO -->
+       Also, in this current version, the <command>b10-ddns</command>
        component configures itself with the data source referring to the
         <varname>database_file</varname> configuration parameter of
         <command>b10-auth</command>.