]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
fixed release substitution, fixed some tables layout
authorMichal Nowikowski <godfryd@isc.org>
Fri, 19 Jul 2019 07:03:47 +0000 (09:03 +0200)
committerMichal Nowikowski <godfryd@isc.org>
Tue, 30 Jul 2019 08:45:13 +0000 (10:45 +0200)
doc/sphinx/Makefile.am
doc/sphinx/arm/hooks-radius.rst
doc/sphinx/arm/hooks.rst
doc/sphinx/arm/logging.rst
doc/sphinx/arm/netconf.rst
doc/sphinx/arm/quickstart.rst

index 8ae4330d03070d8c3bffdc48891e4ad244b849df..c9f2ed06f92fd2808de40e24e1054f960f6c4830 100644 (file)
@@ -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
index 7951a232d851ba899d82f8f1cba6a7a98c8bcdb0..4cabdbc0c2b0fe0c9f67d97bb399bd05943806fb 100644 (file)
@@ -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:
        -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
index 29350fbfe011e3a70bfa8ea71ba6b76bb25b7b84..573fe6a6fdee78881d48bd7b77614bd94297df40 100644 (file)
@@ -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
index 8f5a2b6f6108bd37e93afaaea5a67b645e179d96..29c73944c502d749157c4148220de778173d6d8f 100644 (file)
@@ -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                    |
index 972e2c8630e601dbdc0c3f07d84989cd1428209b..ae350df8556a527af4613ddbbb1bf9c919df0b74 100644 (file)
@@ -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:
index f68d4a22be6e2542440e1e9f02c1dfd43405822c..f0b81dac2fac9603202a1805a7f68ba2dd8fca89 100644 (file)
@@ -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]