diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-28 06:57:22 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-28 06:57:22 +0200 |
| commit | 3e303edd752e16ae8eaf0c6204b473503205dde0 (patch) | |
| tree | c7c933956b5522932776b4b65b80fa75590bcac7 /spec | |
| parent | specdoc: Fix output format of regular expressions (diff) | |
| download | rtems-central-3e303edd752e16ae8eaf0c6204b473503205dde0.tar.bz2 | |
spec: Clarify and use interface brief
Diffstat (limited to 'spec')
| -rw-r--r-- | spec/spec/interface-brief.yml | 6 | ||||
| -rw-r--r-- | spec/spec/interface-header-file.yml | 5 |
2 files changed, 7 insertions, 4 deletions
diff --git a/spec/spec/interface-brief.yml b/spec/spec/interface-brief.yml index c495bb7f..90d1211b 100644 --- a/spec/spec/interface-brief.yml +++ b/spec/spec/interface-brief.yml @@ -10,8 +10,12 @@ spec-example: null spec-info: none: null str: + assert: + not: + re: '\n\n' description: | - It shall be the brief description of the interface. + It shall be the brief description of the interface. It should be a + single sentence. spec-name: Interface Brief Description spec-type: interface-brief type: spec diff --git a/spec/spec/interface-header-file.yml b/spec/spec/interface-header-file.yml index 1faae922..877f63e5 100644 --- a/spec/spec/interface-header-file.yml +++ b/spec/spec/interface-header-file.yml @@ -15,9 +15,8 @@ spec-info: dict: attributes: brief: - description: | - It shall be the brief description of the header file. - spec-type: str + description: null + spec-type: interface-brief path: description: | It shall be the path used to include the header file. For example |