blob: 5f74e70d3001e0b441598c642779e598b01b5379 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
:lastproofread: 2025-11-14
########
Coverage
########
Overview over all commands that are documented in the
``.. cfgcmd::`` or ``.. opcmd::`` directives.
The build process takes all XML definition files
from the `vyos-1x <https://github.com/vyos/vyos-1x>`_ repository and a
periodical export of all VyOS commands and extracts each leaf command, or
executable command.
The script compares only the fixed part of a command.
All variables and values are removed and the string of the commands
are compared.
For example, take the following two commands:
* documentation: ``interfaces ethernet <interface> address
<address | dhcp | dhcpv6>``
* xml: ``interfaces ethernet <ethernet> address <address>``
* VyOS: ``interfaces ethernet <text> address <value>``
**There are 3 kinds of issues with commands in the following tables:**
``Not documented yet``
* An XML command is not found in ``.. cfgcmd::`` or ``.. opcmd::`` directives.
* The command should be documented.
``Nothing found in XML Definitions``
* ``.. cfgcmd::`` or ``.. opcmd::`` The command is not found in the XML
definition.
* 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``
* ``.. cfgcmd::`` or ``.. opcmd::`` The command is not found in VyOS
documentation or the XML definition.
* 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
======================
.. cfgcmdlist::
:show-coverage:
Operational Commands
====================
.. opcmdlist::
:show-coverage:
|
