From 355b4ec5c9a4d20ca884f50bd5271fc3540f1832 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Fri, 25 Sep 2020 17:27:20 +0200 Subject: spec: Review options --- spec/rtems/option/if/event-any.yml | 4 ++-- spec/rtems/option/if/header.yml | 3 ++- spec/rtems/option/if/no-wait.yml | 7 ++++--- spec/rtems/option/if/option.yml | 2 +- spec/rtems/option/if/wait.yml | 6 ++++-- 5 files changed, 13 insertions(+), 9 deletions(-) diff --git a/spec/rtems/option/if/event-any.yml b/spec/rtems/option/if/event-any.yml index 6562f06c..72e2ac1d 100644 --- a/spec/rtems/option/if/event-any.yml +++ b/spec/rtems/option/if/event-any.yml @@ -1,7 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This option constant indicates that the task wishes to wait until any events - of interest are available. + This option constant indicates that the task wishes to wait until at least + one of the events of interest are available. 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 ee4d2342..10070fae 100644 --- a/spec/rtems/option/if/header.yml +++ b/spec/rtems/option/if/header.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: This header file defines options provided by the API. +brief: | + This header file defines options provided by the Classic API. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true diff --git a/spec/rtems/option/if/no-wait.yml b/spec/rtems/option/if/no-wait.yml index 504128c5..6796c344 100644 --- a/spec/rtems/option/if/no-wait.yml +++ b/spec/rtems/option/if/no-wait.yml @@ -1,6 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This option constant indicates that the task is to not wait on the resource. + This option constant indicates that the task does not want to wait on the + resource. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2008 On-Line Applications Research Corporation (OAR) @@ -8,8 +9,8 @@ definition: default: '0x00000001' variants: [] description: | - If the resource is not available, then directives shall return immediately - with a status to indicate unsatisfied. + If the resource is not available, then the directives shall return + immediately with a status to indicate that the request is unsatisfied. enabled-by: true interface-type: define links: diff --git a/spec/rtems/option/if/option.yml b/spec/rtems/option/if/option.yml index a15781ed..6c633542 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 defines the control block used to manage option sets. + This type is used to represent an option set. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/option/if/wait.yml b/spec/rtems/option/if/wait.yml index 940d117f..243bcdf6 100644 --- a/spec/rtems/option/if/wait.yml +++ b/spec/rtems/option/if/wait.yml @@ -1,13 +1,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This option constant indicates that the task is to wait on resource. + This option constant indicates that the task wants to wait on the resource. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2008 On-Line Applications Research Corporation (OAR) definition: default: '0x00000000' variants: [] -description: null +description: | + If the resource is not available, then the task shall block and wait for + request completion. enabled-by: true interface-type: define links: -- cgit v1.2.3