[PATCH 2/4] eng: Add brief description to header file items

[Gedare Bloom]

On Mon, Jul 27, 2020 at 7:46 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> Update #3715.
> ---
>  eng/req/items.rst | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/eng/req/items.rst b/eng/req/items.rst
> index a033eac..a436a4d 100644
> --- a/eng/req/items.rst
> +++ b/eng/req/items.rst
> @@ -1466,6 +1466,10 @@ the :ref:`SpecTypeInterfacePlacementLinkRole` to an
>  domain of the header file. All explicit attributes shall be specified. The
>  explicit attributes for this type are:
>
> +brief
> +    The attribute value shall be a string. It shall be the brief description of
> +    the header file.
> +
I think it should be one sentence. Typically it is at least... so "It
shall be a single sentence description of..." maybe better?

>  path
>      The attribute value shall be a string. It shall be the path used to include
>      the header file.  For example :file:`rtems/confdefs.h`.
> --
> 2.26.2
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel