diff options
| author | Daniil Baturin <daniil@vyos.io> | 2026-05-06 14:08:35 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-06 14:08:35 +0100 |
| commit | 9d0341379184622b3da2e7e05aeeceed4bbf83e9 (patch) | |
| tree | 3c881338b1f6e0ec369a138e4c53772fcbaa8253 /docs/md-coverage.md | |
| parent | 5eb383a10ec92c65eed525bc174785a6852e997f (diff) | |
| download | vyos-documentation-9d0341379184622b3da2e7e05aeeceed4bbf83e9.tar.gz vyos-documentation-9d0341379184622b3da2e7e05aeeceed4bbf83e9.zip | |
Revert "Add incremental RST-to-MyST swap mechanism (circinus) (#1867)" (#1893)
This reverts commit 5eb383a10ec92c65eed525bc174785a6852e997f.
Diffstat (limited to 'docs/md-coverage.md')
| -rw-r--r-- | docs/md-coverage.md | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/docs/md-coverage.md b/docs/md-coverage.md deleted file mode 100644 index fff0dc4e..00000000 --- a/docs/md-coverage.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -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: -```
\ No newline at end of file |
