[rtems-central commit] spec: Clarify and use interface brief
Sebastian Huber
sebh at rtems.org
Tue Jul 28 05:32:57 UTC 2020
Module: rtems-central
Branch: master
Commit: 3e303edd752e16ae8eaf0c6204b473503205dde0
Changeset: http://git.rtems.org/rtems-central/commit/?id=3e303edd752e16ae8eaf0c6204b473503205dde0
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Tue Jul 28 06:57:22 2020 +0200
spec: Clarify and use interface brief
---
spec/spec/interface-brief.yml | 6 +++++-
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 c495bb7..90d1211 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 1faae92..877f63e 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
More information about the vc
mailing list