vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

coverage: fix lint errors

Browse Source
This commit is contained in:
rebortg 2020-12-11 14:11:08 +01:00
parent fe5075fbc5
commit 5cc446f08b
1 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/coverage.rst
View File

@ -2,29 +2,37 @@
Coverage 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. The build process take all xml definition files
| After this the commands are compare and shown in the following two tables. from `vyos-1x <https://github.com/vyos/vyos-1x>`_ and extract each leaf
| The script compare only the fixed part of a command. All varables or values will be erase and then compare: 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: 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>`` * 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:** **There are 2 kind of problems:**
| ``Not documented yet`` ``Not documented yet``
| A XML command are not found in ``.. cfgcmd::`` or ``.. opcmd::`` Commands
| The command should be documented
| ``Nothing found in XML Definitions``: * A XML command are not found in ``.. cfgcmd::`` or ``.. opcmd::`` Commands
| ``.. cfgcmd::`` or ``.. opcmd::`` Command are not found in a XML command * The command should be documented
| 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 ``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 Configuration Commands