Browse Source

Fix documentation for KeysWithStatements and FirstKeyWithStatement

Serj Kalichev 1 year ago
parent
commit
d75cf066e4
1 changed files with 31 additions and 24 deletions
  1. 31 24
      docs/klish-plugin-sysrepo.ru.md

+ 31 - 24
docs/klish-plugin-sysrepo.ru.md

@@ -482,47 +482,54 @@ test
 По умолчанию отображение символа `;` включено.
 
 
-### Настройка `FirstKeyWithStatement`
-
-У списков (узел `list`) может быть не один ключ, для идентификации нужного
-элемента, а сразу несколько. Данное поле настройки относится только к первому
-ключу списка. Поле может принимать значения `y` или `n`. Если задано значение
-`y`, то при указании KPath или отображении конфигурации, перед значением ключа,
-будет указываться имя элемента.
-
-Например оператор устанавливает значение элемента `type` для интерфейса:
+### Настройка `KeysWithStatement`
+
+Существует два варианта, как указывать ключи элемента списка. Первый
+вариант - последовательно задавать только значения ключей, не указывая имя поля.
+В этом случае порядок ввода ключей важен. Такое поведение будет использоваться,
+если задана настройка `KeysWithStatement = n`. Второй вариант - значения могут
+задаваться вместе с именем ключа. В таком случае порядок ввода ключей - не
+важен. Такое поведение будет использоваться, если задана настройка
+`KeysWithStatement = y`.
+
+Предположим, что ключами списка "интерфейсы" являются поля `name` и `type`.
+Еще предположим что `FirstKeyWithStatement = y`. Команда установки
+"комментария" для интерфейса будет выглядеть следующим образом, если
+`KeysWithStatement = y`:
 
 ```
-# set test iface name eth0 type ethernet
+# set test iface name eth0 type ethernet comment "Comment"
 ```
 
-В KPath появился элемент `name`, который показывает название (а не только
-значение) ключевого элемента. Та же самая конструкция, если
-`FirstKeyWithStatement = n` будет выглядеть так:
+Если `KeysWithStatement = n` то следующим образом:
 
 ```
-# set test iface eth0 type ethernet
+# set test iface eth0 ethernet comment "Comment"
 ```
 
+По умолчанию используется `KeysWithStatement = y`.
 
-### Настройка `MultiKeysWithStatement`
 
-Настройка аналогична полю `FirstKeyWithStatement`, только относится ко всем
-ключевым элементам списка кроме первого.
+### Настройка `FirstKeyWithStatement`
 
-Предположим, что ключами списка "интерфейсы" являются сразу и поле `name` и поле
-`type`. Еще предположим что `FirstKeyWithStatement = n`. Команда установки
-"комментария" для интерфейса будет выглядеть следующим образом, если
-`MultiKeysWithStatement = y`:
+Иногда удобно задавать ключи элемента списка, указывая имя ключа и его
+значение, но при этом первый ключ, указывать без имени ключа, только значение.
+Такое поведение будет
+использоваться, если `FirstKeyWithStatement = n`. Это установка используется по
+умолчанию. Если `FirstKeyWithStatement = y`, то первый ключ, также как и все
+последующие нужно указывать с именем ключа. Если `KeysWithStatement = n`, то
+настройка `FirstKeyWithStatement` игнорируется.
+
+Если `FirstKeyWithStatement = y`:
 
 ```
-# set test iface eth0 type ethernet comment "Comment"
+# set test iface name eth0 type ethernet
 ```
 
-Если `MultiKeysWithStatement = n` то следующим образом:
+Если `FirstKeyWithStatement = n`:
 
 ```
-# set test iface eth0 ethernet comment "Comment"
+# set test iface eth0 type ethernet
 ```