From f4eac199703b54a594f836544e994640b8b91464 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Thu, 28 May 2020 08:47:13 +0200 Subject: spec: Reuse interface description and notes --- spec/spec/appl-config-option.yml | 13 ++++--------- spec/spec/interface-description.yml | 6 +++++- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/spec/spec/appl-config-option.yml b/spec/spec/appl-config-option.yml index 24af8d8d..7759f408 100644 --- a/spec/spec/appl-config-option.yml +++ b/spec/spec/appl-config-option.yml @@ -20,13 +20,9 @@ spec-info: spec-type: name description: description: | - It shall be the description of the application configuration option. - The description should be short and concentrate on the average case. - All special cases, usage notes, constraints, error conditions, - configuration dependencies, references, etc. should be described in - the notes. The ${appl-config-option-value:/spec-name} items have an + The ${appl-config-option-value:/spec-name} items have an attribute for constraints. - spec-type: str + spec-type: interface-description index-entries: description: | It shall be a list of additional application configuration option @@ -37,9 +33,8 @@ spec-info: description: null spec-type: appl-config-option-name notes: - description: | - It shall be the notes to the application configuration option. - spec-type: optional-str + description: null + spec-type: interface-notes text: description: | It shall state the requirement for the application configuration diff --git a/spec/spec/interface-description.yml b/spec/spec/interface-description.yml index c940b766..07f8f998 100644 --- a/spec/spec/interface-description.yml +++ b/spec/spec/interface-description.yml @@ -11,7 +11,11 @@ spec-info: none: null str: description: | - It shall be the description of the interface. + It shall be the description of the interface. The description should be + short and concentrate on the average case. All special cases, usage + notes, constraints, error conditions, configuration dependencies, + references, etc. should be described in the + ${interface-notes:/spec-name}. spec-name: Interface Description spec-type: interface-description type: spec -- cgit v1.2.3