From 23ecdefb1e36ff8c18b74a98bc47a21ce2f3d11c Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 9 Nov 2020 09:40:28 +0100 Subject: spec: Review directive options API --- spec/rtems/option/if/default.yml | 2 +- spec/rtems/option/if/event-all.yml | 3 ++- spec/rtems/option/if/event-any.yml | 3 ++- spec/rtems/option/if/header.yml | 2 +- spec/rtems/option/if/option.yml | 2 +- 5 files changed, 7 insertions(+), 5 deletions(-) diff --git a/spec/rtems/option/if/default.yml b/spec/rtems/option/if/default.yml index 49b6ee96..9db297be 100644 --- a/spec/rtems/option/if/default.yml +++ b/spec/rtems/option/if/default.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This option constant is the default option set. + This option constant represents the default option set. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2008 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/option/if/event-all.yml b/spec/rtems/option/if/event-all.yml index ae3950c8..91f19540 100644 --- a/spec/rtems/option/if/event-all.yml +++ b/spec/rtems/option/if/event-all.yml @@ -1,7 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | This option constant indicates that the task wishes to wait until all events - of interest are available. + of interest are available in ${../../event/if/receive:/name} and + ${../../event/if/system-receive:/name}. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2008 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/option/if/event-any.yml b/spec/rtems/option/if/event-any.yml index 73317262..cf3308fe 100644 --- a/spec/rtems/option/if/event-any.yml +++ b/spec/rtems/option/if/event-any.yml @@ -1,7 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | This option constant indicates that the task wishes to wait until at least - one of the events of interest are available. + one of the events of interest is available in ${../../event/if/receive:/name} + and ${../../event/if/system-receive:/name}. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2008 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/option/if/header.yml b/spec/rtems/option/if/header.yml index a2d8d9a5..a7065d7c 100644 --- a/spec/rtems/option/if/header.yml +++ b/spec/rtems/option/if/header.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This header file defines options provided by the Classic API. + This header file provides the Classic API directive options. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true diff --git a/spec/rtems/option/if/option.yml b/spec/rtems/option/if/option.yml index b1a20619..1ca11f0f 100644 --- a/spec/rtems/option/if/option.yml +++ b/spec/rtems/option/if/option.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type is used to represent an option set. + This type represents a Classic API directive option set. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR) -- cgit v1.2.3