diff options
| author | rebortg <github@ghlr.de> | 2020-12-11 14:11:08 +0100 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2020-12-11 14:11:08 +0100 |
| commit | 5cc446f08bfc10173232eb56b2e46134fbb6fc1c (patch) | |
| tree | 1da9cfedc745cf86924a07be78cfbd1113302591 | |
| parent | fe5075fbc5dab3a81bd6efb56912b4ce6d0ff32a (diff) | |
| download | vyos-documentation-5cc446f08bfc10173232eb56b2e46134fbb6fc1c.tar.gz vyos-documentation-5cc446f08bfc10173232eb56b2e46134fbb6fc1c.zip | |
coverage: fix lint errors
| -rw-r--r-- | docs/coverage.rst | 34 |
1 files changed, 21 insertions, 13 deletions
diff --git a/docs/coverage.rst b/docs/coverage.rst index 896489fd..180dfe4b 100644 --- a/docs/coverage.rst +++ b/docs/coverage.rst @@ -2,29 +2,37 @@ Coverage ######## -Overview over all commands, which are documented in the ``.. cfgcmd::`` or ``.. opcmd::`` Directives. +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 the following two tables. -| The script compare only the fixed part of a command. All varables or values will be erase and then compare: +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 +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>``` + * documentation: ``interfaces ethernet <interface> address + <address | dhcp | dhcpv6>``` * xml: ``interface ethernet <ethernet> address <address>`` -Now the script earse all in between ``<`` and ``>`` and simply compare the strings. +Now the script earse all in between ``<`` and ``>`` and simply compare +the strings. **There are 2 kind of problems:** -| ``Not documented yet`` -| A XML command are not found in ``.. cfgcmd::`` or ``.. opcmd::`` Commands -| The command should be documented +``Not documented yet`` -| ``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 + * A XML command are not found in ``.. cfgcmd::`` or ``.. opcmd::`` Commands + * The command should be documented + +``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 Configuration Commands |