summaryrefslogtreecommitdiff
path: root/docs/_include/interface-description.txt
diff options
context:
space:
mode:
authorLiudmylaNad <l.nadolina@vyos.io>2025-12-23 14:37:59 +0100
committerGitHub <noreply@github.com>2025-12-23 13:37:59 +0000
commit8c0190a6cc9b7ae2b0d2f26205ab3601b35fe0b7 (patch)
treeecf442ae6b09a7cea903eeb7e4a01a1aa728b774 /docs/_include/interface-description.txt
parent3481dc487abe29d5f09e72f6bbdaaf1e3321056f (diff)
downloadvyos-documentation-8c0190a6cc9b7ae2b0d2f26205ab3601b35fe0b7.tar.gz
vyos-documentation-8c0190a6cc9b7ae2b0d2f26205ab3601b35fe0b7.zip
DOC: Proofreading bonding.rst (#1721)
Diffstat (limited to 'docs/_include/interface-description.txt')
-rw-r--r--docs/_include/interface-description.txt8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/_include/interface-description.txt b/docs/_include/interface-description.txt
index 064d9559..2de47fe3 100644
--- a/docs/_include/interface-description.txt
+++ b/docs/_include/interface-description.txt
@@ -1,11 +1,13 @@
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} description <description>
- Set a human readable, descriptive alias for this connection. Alias is used by
- e.g. the :opcmd:`show interfaces` command or SNMP based monitoring tools.
+ **Configure a clear, descriptive alias for the interface.**
+
+ This alias appears in the :opcmd:`show interfaces` command and SNMP-based
+ monitoring tools.
Example:
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} description 'This is an awesome interface running on VyOS' \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} description 'This is an interface running on VyOS.' \ No newline at end of file