diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-04-10 21:46:24 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-04-10 19:46:24 +0100 |
| commit | ac00e1c4a6b456628e412123383450653f668bdb (patch) | |
| tree | d17abbfc59ef01c3386d8d75c47649b9d69d6a6a /docs/configuration/system | |
| parent | b5858598e32441560da34a4a62dc687fe4df9c16 (diff) | |
| download | vyos-documentation-ac00e1c4a6b456628e412123383450653f668bdb.tar.gz vyos-documentation-ac00e1c4a6b456628e412123383450653f668bdb.zip | |
docs: remove TODO markers, fix stub notes, add linter markers (#1828)
Remove TODO tracking comments, reformat stub notes with inline
links, add stop/start_vyoslinter markers around long code blocks,
and fix minor structural issues across 23 documentation files.
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'docs/configuration/system')
| -rw-r--r-- | docs/configuration/system/flow-accounting.rst | 14 | ||||
| -rw-r--r-- | docs/configuration/system/sysctl.rst | 10 |
2 files changed, 15 insertions, 9 deletions
diff --git a/docs/configuration/system/flow-accounting.rst b/docs/configuration/system/flow-accounting.rst index cb18839a..0664eac7 100644 --- a/docs/configuration/system/flow-accounting.rst +++ b/docs/configuration/system/flow-accounting.rst @@ -84,9 +84,9 @@ CLI command. You may disable using the local in-memory table with the command: .. cfgcmd:: set system flow-accounting syslog-facility <facility> - Configure the syslog facility used for flow-accounting log messages. - Available facilities follow standard syslog conventions (e.g., - ``daemon``, ``local0`` through ``local7``). + Set the syslog facility for flow-accounting log messages. Supported values + include ``daemon``, ``local0`` through ``local7``, and other standard syslog + facilities. Flow Export ----------- @@ -167,6 +167,8 @@ display captured network traffic information for all configured interfaces. Show flow accounting information for given `<interface>`. + .. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show flow-accounting interface eth0 @@ -180,11 +182,15 @@ display captured network traffic information for all configured interfaces. eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 40006 22 tcp 16 146 1 9444 eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 0 0 icmp 192 27 1 4455 + .. start_vyoslinter + .. opcmd:: show flow-accounting interface <interface> host <address> Show flow accounting information for given `<interface>` for a specific host only. + .. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show flow-accounting interface eth0 host 192.0.2.14 @@ -193,3 +199,5 @@ display captured network traffic information for all configured interfaces. eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 40006 22 tcp 16 197 2 12940 eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 40152 22 tcp 16 94 1 4924 eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 0 0 icmp 192 36 1 5877 + + .. start_vyoslinter diff --git a/docs/configuration/system/sysctl.rst b/docs/configuration/system/sysctl.rst index d1398822..1fedb9bd 100644 --- a/docs/configuration/system/sysctl.rst +++ b/docs/configuration/system/sysctl.rst @@ -4,13 +4,11 @@ Sysctl ###### -.. note:: This page is a stub and needs expansion. - Contributions welcome via the - VyOS `documentation repository`_. +.. note:: This page is a stub and needs expansion. Contributions + welcome via the `VyOS documentation repository + <https://github.com/vyos/vyos-documentation>`_. -.. _documentation repository: https://github.com/vyos/vyos-documentation - -This chapeter describes how to configure kernel parameters at runtime. +This chapter describes how to configure kernel parameters at runtime. ``sysctl`` is used to modify kernel parameters at runtime. The parameters available are those listed under /proc/sys/. |