From: Michal Nowikowski Date: Fri, 19 Jul 2019 07:03:47 +0000 (+0200) Subject: fixed release substitution, fixed some tables layout X-Git-Tag: Kea-1.6.1~10^2~55 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b734e531a6263dc0b61ab1c52c8f13850c28bdb2;p=thirdparty%2Fkea.git fixed release substitution, fixed some tables layout --- diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am index 8ae4330d03..c9f2ed06f9 100644 --- a/doc/sphinx/Makefile.am +++ b/doc/sphinx/Makefile.am @@ -300,12 +300,3 @@ endif # still not documented. templates: docgen docgen/generate-templates docgen/cmds-list - -# This will generate the api.xml file using docgen generator. It will -# read the JSON files from api/ directory. Make sure they're up to date. -api: docgen - docgen/kea-docgen api/*.json - -# This convenience target makes sure the docgen tool is built properly -docgen: - $(MAKE) -C docgen diff --git a/doc/sphinx/arm/hooks-radius.rst b/doc/sphinx/arm/hooks-radius.rst index 7951a232d8..4cabdbc0c2 100644 --- a/doc/sphinx/arm/hooks-radius.rst +++ b/doc/sphinx/arm/hooks-radius.rst @@ -127,7 +127,7 @@ Choice 1: get from github Choice 2: get a tarball and extract it -.. code-block:: console +.. parsed-literal:: $ tar zxvf kea-|release|.tar.gz @@ -135,7 +135,7 @@ The next step is to extract the premium Kea package that contains the RADIUS repository into the Kea sources. After the tarball is extracted, the Kea sources should have a premium/ subdirectory. -.. code-block:: console +.. parsed-literal:: $ cd kea $ tar zxvf ../kea-premium-radius-|release|.tar.gz @@ -189,8 +189,7 @@ follows: After some checks, the configure script should print a report similar to the following: -:: - +.. parsed-literal:: Kea source configure results: -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst index 29350fbfe0..573fe6a6fd 100644 --- a/doc/sphinx/arm/hooks.rst +++ b/doc/sphinx/arm/hooks.rst @@ -75,7 +75,7 @@ tarball that was downloaded. For example, with a download of Kea |release|., there should be a tarball called kea-|release|.tar.gz on the system. Unpack this tarball: -:: +.. parsed-literal:: $ tar zxvf kea-|release|.tar.gz @@ -87,7 +87,7 @@ unpacked. Once Kea |release| has been unpacked into a kea-|release| subdirectory and the Kea premium tarball is in the current directory, the following steps will unpack the premium tarball into the correct location: -:: +.. parsed-literal:: $ cd kea-|release| $ tar xvf ../kea-premium-|release|.tar.gz @@ -111,7 +111,7 @@ originally building Kea. It is possible to verify that configure has detected th premium package by inspecting the summary printed when it exits. The first section of the output should look something like this: -:: +.. parsed-literal:: Package: Name: kea diff --git a/doc/sphinx/arm/logging.rst b/doc/sphinx/arm/logging.rst index 8f5a2b6f61..29c73944c5 100644 --- a/doc/sphinx/arm/logging.rst +++ b/doc/sphinx/arm/logging.rst @@ -122,7 +122,11 @@ Currently defined loggers are defined in the following table. The loggers belong to the core Kea code (open source Kea binaries and libraries), or hooks libraries (open source or premium). +.. tabularcolumns:: |p{0.2\linewidth}|p{0.2\linewidth}|p{0.6\linewidth}| + .. table:: List of Loggers Supported by Kea Servers and Hooks Libraries Shipped With Kea and Premium Packages + :class: longtable + :widths: 20 20 60 +----------------------------------+------------------------+--------------------------------+ | Logger Name | Software Package | Description | diff --git a/doc/sphinx/arm/netconf.rst b/doc/sphinx/arm/netconf.rst index 972e2c8630..ae350df855 100644 --- a/doc/sphinx/arm/netconf.rst +++ b/doc/sphinx/arm/netconf.rst @@ -81,17 +81,18 @@ 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 + ---------------------------------------------------------------------- + ietf-netconf- | 2012-02-06 | Installed | root:root | 666 + -notifications | | | | + 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 +156,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 + ----------------------------------------------------------------------------------------- + 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: diff --git a/doc/sphinx/arm/quickstart.rst b/doc/sphinx/arm/quickstart.rst index f68d4a22be..f0b81dac2f 100644 --- a/doc/sphinx/arm/quickstart.rst +++ b/doc/sphinx/arm/quickstart.rst @@ -22,13 +22,13 @@ Quick Start Guide for DHCPv4 and DHCPv6 Services 3. Extract the tarball. For example: - .. code-block:: console + .. parsed-literal:: $ tar xvzf kea-|release|.tar.gz 4. Go into the source directory and run the configure script: - .. code-block:: console + .. parsed-literal:: $ cd kea-|release| $ ./configure [your extra parameters]