vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-15 18:12:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix grammar in coverage.rst (#1706)

Browse Source 
* Fix grammar in coverage.rst

* Update lastproofread date
This commit is contained in:
Quill 2025-11-20 23:57:11 +09:00 committed by GitHub
parent b7bda23be3
commit f8595de795
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/coverage.rst
View File

@ -1,47 +1,52 @@
:lastproofread: 2025-11-14
######## ########
Coverage Coverage
######## ########
Overview over all commands, which are documented in the Overview over all commands that are documented in the
``.. cfgcmd::`` or ``.. opcmd::`` Directives. ``.. cfgcmd::`` or ``.. opcmd::`` directives.
The build process take all xml definition files The build process takes all XML definition files
from `vyos-1x <https://github.com/vyos/vyos-1x>`_ and a periodical export of from the `vyos-1x <https://github.com/vyos/vyos-1x>`_ repository and a
all VyOS commands and extract each leaf command or executable command. periodical export of all VyOS commands and extracts each leaf command, or
After this the commands are compare and shown in executable command.
the following two tables. The script compare only the fixed part of a command. The script compares only the fixed part of a command.
All varables or values will be erase and then compare: All variables and values are removed and the string of the commands
are compared.
for example there are these two commands: For example, take the following two commands:
* documentation: ``interfaces ethernet <interface> address * documentation: ``interfaces ethernet <interface> address
<address | dhcp | dhcpv6>`` <address | dhcp | dhcpv6>``
* xml: ``interfaces ethernet <ethernet> address <address>`` * xml: ``interfaces ethernet <ethernet> address <address>``
* VyOS: ``interfaces ethernet <text> address <value>`` * VyOS: ``interfaces ethernet <text> address <value>``
Now the script earse all in between ``<`` and ``>`` and simply compare **There are 3 kinds of issues with commands in the following tables:**
the strings.
**There are 3 kind of problems:**
``Not documented yet`` ``Not documented yet``
* A XML command are not found in ``.. cfgcmd::`` or ``.. opcmd::`` Commands * An XML command is not found in ``.. cfgcmd::`` or ``.. opcmd::`` directives.
* The command should be documented * The command should be documented.
``Nothing found in XML Definitions`` ``Nothing found in XML Definitions``
* ``.. cfgcmd::`` or ``.. opcmd::`` Command are not found in a XML command * ``.. cfgcmd::`` or ``.. opcmd::`` The command is not found in the XML
* Maybe the command where changed in the XML Definition, the feature is definition.
not anymore in VyOS, or there is a typo * The command location may have changed in the XML definition, the feature
is no longer supported in VyOS, or there is a typo in the command.
``Nothing found in VyOS`` ``Nothing found in VyOS``
* ``.. cfgcmd::`` or ``.. opcmd::`` Command are not found in a VyOS command * ``.. cfgcmd::`` or ``.. opcmd::`` The command is not found in VyOS
* Maybe the command where changed, the feature is documentation or the XML definition.
not anymore in VyOS, or there is a typo * The command location may have changed in the XML definition, the feature
is no longer supported in VyOS, or there is a typo in the command.
The final list of commands are shown in
the following two tables:
Configuration Commands Configuration Commands
====================== ======================