diff options
| author | rebortg <github@ghlr.de> | 2022-05-31 21:16:48 +0200 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2022-05-31 21:27:58 +0200 |
| commit | 6a88ab9bb1f333233654a10c4cbf87c31848d47c (patch) | |
| tree | 57936a23056447f06f974ec7bdd0f3e7ba1ecd3d /docs/coverage.rst | |
| parent | 7c58e0fec38c6a26e0d004a1ab86fac6959bc29e (diff) | |
| download | vyos-documentation-6a88ab9bb1f333233654a10c4cbf87c31848d47c.tar.gz vyos-documentation-6a88ab9bb1f333233654a10c4cbf87c31848d47c.zip | |
improve coverage with all real vyos commands exported from iso
(cherry picked from commit 68a335a08633d18e11110e98e5fef7a979d7e850)
Diffstat (limited to 'docs/coverage.rst')
| -rw-r--r-- | docs/coverage.rst | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/docs/coverage.rst b/docs/coverage.rst index 180dfe4b..1fb9a153 100644 --- a/docs/coverage.rst +++ b/docs/coverage.rst @@ -6,21 +6,23 @@ Overview over all commands, which are documented in the ``.. cfgcmd::`` or ``.. opcmd::`` Directives. The build process take all xml definition files -from `vyos-1x <https://github.com/vyos/vyos-1x>`_ and extract each leaf -command or executable command. After this the commands are compare and shown in +from `vyos-1x <https://github.com/vyos/vyos-1x>`_ and a periodical export of +all VyOS commands and extract each leaf command or executable command. +After this the commands are compare and shown in the following two tables. The script compare only the fixed part of a command. All varables or values will be erase and then compare: for example there are these two commands: * documentation: ``interfaces ethernet <interface> address - <address | dhcp | dhcpv6>``` - * xml: ``interface ethernet <ethernet> address <address>`` + <address | dhcp | dhcpv6>`` + * xml: ``interfaces ethernet <ethernet> address <address>`` + * VyOS: ``interfaces ethernet <text> address <value>`` Now the script earse all in between ``<`` and ``>`` and simply compare the strings. -**There are 2 kind of problems:** +**There are 3 kind of problems:** ``Not documented yet`` @@ -30,9 +32,14 @@ the strings. ``Nothing found in XML Definitions`` * ``.. cfgcmd::`` or ``.. opcmd::`` Command are not found in a XML command - * Maybe the command where changed in the XML Definition, or the feature is - not anymore in VyOS - * Some commands are not yet translated to XML + * Maybe the command where changed in the XML Definition, the feature is + not anymore in VyOS, or there is a typo + +``Nothing found in VyOS`` + + * ``.. cfgcmd::`` or ``.. opcmd::`` Command are not found in a VyOS command + * Maybe the command where changed, the feature is + not anymore in VyOS, or there is a typo Configuration Commands |