From bd6c95f18ab8e0a3b8232fc049fe0175bf47a88a Mon Sep 17 00:00:00 2001 From: Joachim Wiberg Date: Thu, 24 Oct 2024 07:56:04 +0200 Subject: [PATCH] doc: add description of description setting and update ChangeLog Signed-off-by: Joachim Wiberg --- doc/ChangeLog.md | 5 +++++ doc/networking.md | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/doc/ChangeLog.md b/doc/ChangeLog.md index 93bd8317..71ccd00c 100644 --- a/doc/ChangeLog.md +++ b/doc/ChangeLog.md @@ -16,6 +16,11 @@ All notable changes to the project are documented in this file. [v24.10.1][] - 2024-10-18 ------------------------- +### Changes + - Add support for interface description, sometimes referred to as + "ifAlias". Saved as an Linux interface alias (not `altname`), e.g., + `/sys/class/interfaces/veth0a/ifalias`, includes operational support + ### Fixes - Fix #735: `copy` and `erase` commands missing from CLI, regression in Infix v24.10.0 defconfigs, now added as dep. in klish package diff --git a/doc/networking.md b/doc/networking.md index 6a0a8d01..f8eaece9 100644 --- a/doc/networking.md +++ b/doc/networking.md @@ -97,6 +97,10 @@ This is an extension to the ietf-interfaces YANG model, which defines `phys-address` as read-only[^4]. The following shows the different configuration options. +The `description` is saved as Linux `ifalias` on an interface. It is a +free-form string, useful for describing purpose or just adding comments +for remote debugging, e.g., using the operational datastore. + > **Note:** there is no validation or safety checks performed by the > system when using `custom-phys-address`. In particular the `offset` > variant can be dangerous to use -- pay attention to the meaning of