소스 검색

docs: Add 'interrupt' field for ACTION tag.

Serj Kalichev 6 달 전
부모
커밋
f213b6fe51
3개의 변경된 파일23개의 추가작업 그리고 1개의 파일을 삭제
  1. 10 0
      docs/klish3.en.md
  2. 12 0
      docs/klish3.ru.md
  3. 1 1
      klish.xsd

+ 10 - 0
docs/klish3.en.md

@@ -890,6 +890,16 @@ If the lock is captured by one process, another process, when attempting to
 capture the same lock will suspend its execution until the release of the lock.
 capture the same lock will suspend its execution until the release of the lock.
 
 
 
 
+#### Attribute `interrupt`
+
+The boolean flag specifies whether action could be interrupted by `Ctrl^C`.
+Possible values are `true`, `false`. Default is `false`.
+
+The atomic actions must be non-interruptible. It's recommended to set
+interruptible attribute to `true` value for the long-time informational
+commands. 
+
+
 #### Attribute `in`
 #### Attribute `in`
 
 
 The attribute indicates whether the action can accept data via standard input
 The attribute indicates whether the action can accept data via standard input

+ 12 - 0
docs/klish3.ru.md

@@ -914,6 +914,18 @@ SEQ сам может быть элементом контейнера SWITCH.
 блокировки.
 блокировки.
 
 
 
 
+#### Атрибут `interrupt`
+
+Флаг, определяющий, может ли текущее действие быть прервано пользователем с
+помощью комбинации `Ctrl^C`. Возможные значения - `true`, `false`. Значение по
+умолчанию - `false`.
+
+Если действие должно быть атомарным, то атрибут следует установить в значение
+`false`, либо вообще не указывать, т.к. по умолчанию все действия являются
+непрерываемыми. Длительные информационные команды рекомендуется объявлять
+прерываемыми.
+
+
 #### Атрибут `in`
 #### Атрибут `in`
 
 
 Атрибут показывает, может ли действие принимать данные через стандартный ввод
 Атрибут показывает, может ли действие принимать данные через стандартный ввод

+ 1 - 1
klish.xsd

@@ -153,7 +153,7 @@
 * [lock="<name>"] - Named lock. It will use special lockfile while
 * [lock="<name>"] - Named lock. It will use special lockfile while
 *	action execution.
 *	action execution.
 *
 *
-* [interrupt="true/false"] - The boolean field that specify that action can be
+* [interrupt="true/false"] - The boolean field specifies whether action could
 *	be interrupted by Ctrl^C. Default is false.
 *	be interrupted by Ctrl^C. Default is false.
 *
 *
 * [in="true/false/tty"] - Does ACTION need input. The "tty" means action can use
 * [in="true/false/tty"] - Does ACTION need input. The "tty" means action can use