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/timer | |
| parent | spec: Document all create directives (diff) | |
| download | rtems-central-f665caf3a8dc0054ce0c28c9943ab337168850b1.tar.bz2 | |
spec: Document all delete directives
Diffstat (limited to 'spec/rtems/timer')
| -rw-r--r-- | spec/rtems/timer/if/delete.yml | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/spec/rtems/timer/if/delete.yml b/spec/rtems/timer/if/delete.yml index 5bc65bdc..975f6526 100644 --- a/spec/rtems/timer/if/delete.yml +++ b/spec/rtems/timer/if/delete.yml @@ -2,7 +2,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | Deletes the timer. copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) definition: default: @@ -13,8 +13,8 @@ definition: return: ${../../status/if/code:/name} variants: [] description: | - This directive deletes the timer specified by the ${.:/params[0]/name} - parameter. If the timer is running, it is automatically canceled. + This directive deletes the timer specified by ${.:/params[0]/name}. If the + timer is running, it is automatically canceled. enabled-by: true index-entries: - delete a timer @@ -24,14 +24,19 @@ links: 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_timer_delete notes: | - This directive may cause the calling task to be preempted due to an obtain - and release of the object allocator mutex. - The ${/glossary/tmcb:/term} for the deleted timer is reclaimed by RTEMS. - - A timer can be deleted by a task other than the task which created the timer. params: - description: is the timer identifier. dir: null |