diff options
Diffstat (limited to 'spec/rtems/config/if/get-maximum-processors.yml')
| -rw-r--r-- | spec/rtems/config/if/get-maximum-processors.yml | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/spec/rtems/config/if/get-maximum-processors.yml b/spec/rtems/config/if/get-maximum-processors.yml index 9b3c0366..63f02bfd 100644 --- a/spec/rtems/config/if/get-maximum-processors.yml +++ b/spec/rtems/config/if/get-maximum-processors.yml @@ -1,7 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - Returns the maximum number of processors which are configured for this - application. + Gets the maximum number of processors configured for this application. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: @@ -19,13 +18,16 @@ links: name: rtems_configuration_get_maximum_processors notes: | The actual number of processors available to the application is returned by - ${../../scheduler/if/get-processor-maximum:/name}. It will be less than or - equal to the configured maximum number of processors. + ${../../scheduler/if/get-processor-maximum:/name} which less than or + equal to the configured maximum number of processors + (${/acfg/if/max-processors:/name}). In uniprocessor configurations, this macro is a compile time constant which evaluates to one. params: [] return: - return: null + return: | + Returns the maximum number of processors configured for this + application. return-values: [] type: interface |