diff options
| author | Robert Göhler <github@ghlr.de> | 2020-05-07 22:14:10 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-07 22:14:10 +0200 |
| commit | 43ba5a274b5f0ec2f81379f3696ca4f5ce2c4396 (patch) | |
| tree | 8c2a99fb8c749074b47e36e842d83d0ef20ef607 | |
| parent | 081e5118d60828a3d87baf5b20926c3224032901 (diff) | |
| parent | e47f81af7564d06ba8ec552170fad55fc2dd6bed (diff) | |
| download | vyos-documentation-43ba5a274b5f0ec2f81379f3696ca4f5ce2c4396.tar.gz vyos-documentation-43ba5a274b5f0ec2f81379f3696ca4f5ce2c4396.zip | |
Merge pull request #244 from currite/fix-comment
configuration-overview: fix comment command
| -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 |