diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-01-19 07:48:35 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-02-03 06:26:37 +0100 |
| commit | f665caf3a8dc0054ce0c28c9943ab337168850b1 (patch) | |
| tree | 75f2c7f56655e8270fcdc28ef399bd67ac6039a5 /spec/rtems/ratemon/if/delete.yml | |
| parent | spec: Document all create directives (diff) | |
| download | rtems-central-f665caf3a8dc0054ce0c28c9943ab337168850b1.tar.bz2 | |
spec: Document all delete directives
Diffstat (limited to 'spec/rtems/ratemon/if/delete.yml')
| -rw-r--r-- | spec/rtems/ratemon/if/delete.yml | 37 |
1 files changed, 30 insertions, 7 deletions
diff --git a/spec/rtems/ratemon/if/delete.yml b/spec/rtems/ratemon/if/delete.yml index 7764ac8e..19097a06 100644 --- a/spec/rtems/ratemon/if/delete.yml +++ b/spec/rtems/ratemon/if/delete.yml @@ -1,7 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Deletes the period. copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) definition: default: @@ -11,22 +12,44 @@ definition: - ${../../type/if/id:/name} ${.:/params[0]/name} return: ${../../status/if/code:/name} variants: [] -description: null +description: | + This directive deletes the period specified by ${.:/params[0]/name}. If the + period is running, it is automatically canceled. enabled-by: true -index-entries: [] +index-entries: +- delete a period interface-type: function links: - role: interface-placement uid: header - role: interface-ingroup uid: group +- role: constraint + uid: /constraint/directive-ctx-devinit +- role: constraint + uid: /constraint/directive-ctx-task +- role: constraint + uid: /constraint/object-allocator +- role: constraint + uid: ../../constraint/delete-by-any-task +- role: constraint + uid: /constraint/obj-unlimited-free name: rtems_rate_monotonic_delete -notes: null +notes: | + The ${/glossary/pcb:/term} for the deleted period is reclaimed by RTEMS. params: -- description: '%' +- description: | + is the period identifier. dir: null name: id return: return: null - return-values: [] + return-values: + - description: | + The requested operation was successful. + value: ${../../status/if/successful:/name} + - description: | + There was no period associated with the identifier specified by + ${.:/params[0]/name}. + value: ${../../status/if/invalid-id:/name} type: interface |