From 556016fc342bd43ce9442e60bfa86864c03e34c3 Mon Sep 17 00:00:00 2001 From: Suzanne Goldlust Date: Wed, 17 Jul 2019 12:22:20 -0400 Subject: [PATCH] Additional text edits, Sphinx formatting --- doc/guide/api.rst | 4 ++-- doc/guide/logging.rst | 4 ++-- doc/guide/netconf.rst | 56 +++++++++++++++++++++---------------------- 3 files changed, 32 insertions(+), 32 deletions(-) diff --git a/doc/guide/api.rst b/doc/guide/api.rst index d963a585ac..70098d64b9 100644 --- a/doc/guide/api.rst +++ b/doc/guide/api.rst @@ -800,8 +800,8 @@ Response syntax: } } -The returned list of classes merely contains their names. In order to -retrieve full information about one of these classes use +The returned list of classes merely contains their names. To +retrieve full information about one of these classes, use :ref:`command-class-get`. The returned result is 3 (empty) if no classes are found. If the command is processed successfully and the list of client classes is not empty, the result of 0 is returned. If there is diff --git a/doc/guide/logging.rst b/doc/guide/logging.rst index ff061d7697..8f5a2b6f61 100644 --- a/doc/guide/logging.rst +++ b/doc/guide/logging.rst @@ -500,7 +500,7 @@ severity to INFO will log INFO, WARN, ERROR, and FATAL messages). The severity may also be set to NONE, in which case all messages from that logger are inhibited. - .. note:: +.. note:: The ``keactrl`` tool, described in :ref:`keactrl`, can be configured to start the servers in verbose mode. If this is the case, the @@ -555,7 +555,7 @@ The default value is 10240000 (10MB). The smallest value that can be specified without disabling rotation is 204800. Any value less than this, including 0, disables rotation. - .. note:: +.. note:: Due to a limitation of the underlying logging library (log4cplus), rolling over the log files (from ".1" to ".2", etc) may show odd diff --git a/doc/guide/netconf.rst b/doc/guide/netconf.rst index 3b71ef1390..972e2c8630 100644 --- a/doc/guide/netconf.rst +++ b/doc/guide/netconf.rst @@ -81,17 +81,17 @@ After installation the result should be similar to this: Sysrepo data directory: /home/thomson/devel/sysrepo-0.7.6/build/repository/data/ (Do not alter contents of these directories manually) - Module Name | Revision | Conformance | Data Owner | Permissions | Submodules | Enabled Features - ----------------------------------------------------------------------------------------------------------------------------------------------- - ietf-netconf-notifications | 2012-02-06 | Installed | root:root | 666 | | - ietf-netconf | 2011-06-01 | Imported | | | | - ietf-netconf-acm | 2012-02-22 | Imported | | | | - nc-notifications | 2008-07-14 | Installed | root:root | 666 | | - notifications | 2008-07-14 | Installed | root:root | 666 | | - turing-machine | 2013-12-27 | Installed | root:root | 666 | | - iana-if-type | 2014-05-08 | Installed | | | | - ietf-interfaces | 2014-05-08 | Installed | root:root | 666 | | - ietf-ip | 2014-06-16 | Installed | | | | + Module Name | Revision | Conformance | Data Owner | Permissions | Submodules | Enabled Features + --------------------------------------------------------------------------------------------------------------------------- + ietf-netconf-notifications | 2012-02-06 | Installed | root:root | 666 | | + ietf-netconf | 2011-06-01 | Imported | | | | + ietf-netconf-acm | 2012-02-22 | Imported | | | | + nc-notifications | 2008-07-14 | Installed | root:root | 666 | | + notifications | 2008-07-14 | Installed | root:root | 666 | | + turing-machine | 2013-12-27 | Installed | root:root | 666 | | + iana-if-type | 2014-05-08 | Installed | | | | + ietf-interfaces | 2014-05-08 | Installed | root:root | 666 | | + ietf-ip | 2014-06-16 | Installed | | | | There are two major modules that Kea is able to support: kea-dhcp4-server and kea-dhcp6-server. Note that while there is an @@ -155,22 +155,22 @@ sysrepoctl -l: Sysrepo data directory: /home/thomson/devel/sysrepo-0.7.6/build/repository/data/ (Do not alter contents of these directories manually) - Module Name | Revision | Conformance | Data Owner | Permissions | Submodules | Enabled Features - ----------------------------------------------------------------------------------------------------------------------------------------------- - ietf-netconf-notifications | 2012-02-06 | Installed | root:root | 666 | | - ietf-netconf | 2011-06-01 | Imported | | | | - ietf-netconf-acm | 2012-02-22 | Imported | | | | - nc-notifications | 2008-07-14 | Installed | root:root | 666 | | - notifications | 2008-07-14 | Installed | root:root | 666 | | - turing-machine | 2013-12-27 | Installed | root:root | 666 | | - iana-if-type | 2014-05-08 | Installed | | | | - ietf-interfaces | 2014-05-08 | Installed | root:root | 666 | | - ietf-ip | 2014-06-16 | Installed | | | | - kea-dhcp4-server | 2018-11-20 | Installed | root:root | 666 | | - kea-dhcp6-server | 2018-11-20 | Installed | root:root | 666 | | - ietf-dhcpv6-server | 2018-09-04 | Installed | root:root | 666 | | - ietf-dhcpv6-options | 2018-09-04 | Imported | | | | - ietf-dhcpv6-types | 2018-01-30 | Imported | | | | + Module Name | Revision | Conformance | Data Owner | Permissions | Submodules | Enabled Features + --------------------------------------------------------------------------------------------------------------------------- + ietf-netconf-notifications | 2012-02-06 | Installed | root:root | 666 | | + ietf-netconf | 2011-06-01 | Imported | | | | + ietf-netconf-acm | 2012-02-22 | Imported | | | | + nc-notifications | 2008-07-14 | Installed | root:root | 666 | | + notifications | 2008-07-14 | Installed | root:root | 666 | | + turing-machine | 2013-12-27 | Installed | root:root | 666 | | + iana-if-type | 2014-05-08 | Installed | | | | + ietf-interfaces | 2014-05-08 | Installed | root:root | 666 | | + ietf-ip | 2014-06-16 | Installed | | | | + kea-dhcp4-server | 2018-11-20 | Installed | root:root | 666 | | + kea-dhcp6-server | 2018-11-20 | Installed | root:root | 666 | | + ietf-dhcpv6-server | 2018-09-04 | Installed | root:root | 666 | | + ietf-dhcpv6-options | 2018-09-04 | Imported | | | | + ietf-dhcpv6-types | 2018-01-30 | Imported | | | | To install a new revision of a module it must first be uninstalled, e.g. by: @@ -538,7 +538,7 @@ kea-netconf accepts the following command-line switches: A Step-by-Step NETCONF Agent Operation Example ============================================== - **Note** +.. note:: Copies of example configurations presented within this section can be found in the Kea source code, under -- 2.47.2