summaryrefslogtreecommitdiffstats
path: root/spec/rtems/support/if/workspace-greedy-free.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-04-21 19:32:58 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-04-21 19:45:38 +0200
commit929a974cdd0f1971266fd20f53b688feb18f5624 (patch)
tree13bd6bb5195f7acc8fa8683d7d24669d35c94445 /spec/rtems/support/if/workspace-greedy-free.yml
parentspec: Update /rtems/dpmen/* documentatation (diff)
downloadrtems-central-929a974cdd0f1971266fd20f53b688feb18f5624.tar.bz2
spec: Update /rtems/support/* documentation
Diffstat (limited to 'spec/rtems/support/if/workspace-greedy-free.yml')
-rw-r--r--spec/rtems/support/if/workspace-greedy-free.yml18
1 files changed, 14 insertions, 4 deletions
diff --git a/spec/rtems/support/if/workspace-greedy-free.yml b/spec/rtems/support/if/workspace-greedy-free.yml
index a54a4b0c..0a6b5920 100644
--- a/spec/rtems/support/if/workspace-greedy-free.yml
+++ b/spec/rtems/support/if/workspace-greedy-free.yml
@@ -1,7 +1,8 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+ Frees space of a greedy allocation to the RTEMS Workspace.
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:
@@ -20,10 +21,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
name: rtems_workspace_greedy_free
-notes: null
+notes: |
+ This directive is intended to be used by tests of the RTEMS test suites.
params:
-- description: '%'
+- description: |
+ is the pointer value returned by ${workspace-greedy-allocate:/name} or
+ ${workspace-greedy-allocate-all-except-largest:/name}.
dir: null
name: opaque
return: