[PATCH] c-user: Clarify partition manager documentation
sebastian.huber at embedded-brains.de
Tue Feb 2 19:16:31 UTC 2021
On 02/02/2021 17:10, Gedare Bloom wrote:
> +The partition as the user-defined object name specified in
> ``name``. The
> The "as" is strange although it may be correct if you mean "Use the
> partition as" but since the language parsing is awkward. Or did you
> mean "has"?
Good catch, I used this phrase eight times, but only this one had a
typo. It should be "has".
> +assigned object identifier is returned in ``id``. This
> identifier is used to
> +access the partition with other partition related directives.
> -The total number of global objects, including partitions, is
> limited by the
> -value of the :ref:`CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS` application
> -configuration option.
> +.. rubric:: CONSTRAINTS:
> +The following constraints apply to this directive:
> +* The directive may obtain and release the object allocator
> mutex. This may
> + cause the calling task to be preempted.
> +* The directive may be called from within device driver
> initialization context.
> +* The directive may be called from within task context.
> +* The number of partitions available to the application is
> configured through
> + the :ref:`CONFIGURE_MAXIMUM_PARTITIONS` application
> configuration option.
> +* Where the object class corresponding to the directive is
> configured to use
> + unlimited objects, the directive may allocate memory from the RTEMS
> + Workspace.
> +* The number of global objects available to the application is
> + through the :ref:`CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS` application
> + configuration option.
> I like this, but it made me also think whether it makes sense and
> would be possible to provide a separate section for Configuration
> notes/constraints? Some constraints are 'hard'/system constraints, but
> others are 'soft'/application (configuration) constraints. Maybe
> lumping them together doesn't matter too much. This is already a great
> improvement over the previous way.
For now I would just use one CONSTRAINTS section. Most directives don't
depend directly on application configuration options.
embedded brains GmbH
Herr Sebastian HUBER
email: sebastian.huber at embedded-brains.de
phone: +49-89-18 94 741 - 16
fax: +49-89-18 94 741 - 08
Registergericht: Amtsgericht München
Registernummer: HRB 157899
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
Unsere Datenschutzerklärung finden Sie hier:
More information about the devel