diff options
| author | currite <sll@disroot.org> | 2020-05-04 01:07:52 +0200 |
|---|---|---|
| committer | currite <sll@disroot.org> | 2020-05-04 01:07:52 +0200 |
| commit | e47f81af7564d06ba8ec552170fad55fc2dd6bed (patch) | |
| tree | eeece1fc8f8d0c761419ea077bfd3c21c5ba5493 | |
| parent | 600cecb4cf0127677b4e2f3012024dc4e16476ad (diff) | |
| download | vyos-documentation-e47f81af7564d06ba8ec552170fad55fc2dd6bed.tar.gz vyos-documentation-e47f81af7564d06ba8ec552170fad55fc2dd6bed.zip | |
configuration-overview: fix comment command
Delete sentence saying it only applies to subsections, as that is not correct.
Fix some format mistakes too.
| -rw-r--r-- | docs/configuration-overview.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index 51091d9d..cbc4ab3b 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -247,11 +247,10 @@ Comment Add comment as an annotation to a configuration node. - The ``comment` command allows you to insert a comment above the - ``<config node>`` configuration section. Comments are enclosed with - ``/*`` and ``*/`` as open/close delimiters. A ``comment`` cannot be - used at the top of the configuration hierarchy, only on subsections. - Comments need to be commited, just like other config changes. + The ``comment`` command allows you to insert a comment above the + ``<config node>`` configuration section. When shown, comments are + enclosed with ``/*`` and ``*/`` as open/close delimiters. Comments + need to be commited, just like other config changes. To remove an existing comment from your current configuration, specify an empty string enclosed in double quote marks (``""``) as |