RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

user/conf.t: Fix names for CONFIGURE_UNLIMITED_OBJECTS and CONFIGURE_UNLIMITED_ALLOCATION_SIZE

Browse Source 
closes #2368.
This commit is contained in:
Joel Sherrill
2015-06-15 13:22:31 -05:00
parent e6b31b27fb
commit e0938c2754
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/user/conf.t
View File

@@ -1,4 +1,4 @@
@c COPYRIGHT (c) 1988-2013. @c COPYRIGHT (c) 1988-2015.
@c On-Line Applications Research Corporation (OAR). @c On-Line Applications Research Corporation (OAR).
@c All rights reserved. @c All rights reserved.
@@ -471,15 +471,15 @@ is only responsible for enabling unlimited objects and specifying the
allocation size. allocation size.
@c @c
@c === CONFIGURE_OBJECTS_UNLIMITED === @c === CONFIGURE_UNLIMITED_OBJECTS ===
@c @c
@subsection Enable Unlimited Object Instances @subsection Enable Unlimited Object Instances
@findex CONFIGURE_OBJECTS_UNLIMITED @findex CONFIGURE_UNLIMITED_OBJECTS
@table @b @table @b
@item CONSTANT: @item CONSTANT:
@code{CONFIGURE_OBJECTS_UNLIMITED} @code{CONFIGURE_UNLIMITED_OBJECTS}
@item DATA TYPE: @item DATA TYPE:
Boolean feature macro. Boolean feature macro.
@@ -493,7 +493,7 @@ This is not defined by default.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
@code{CONFIGURE_OBJECTS_UNLIMITED} enables @code{rtems_resource_unlimited} @code{CONFIGURE_UNLIMITED_OBJECTS} enables @code{rtems_resource_unlimited}
mode for Classic API and POSIX API objects that do not already have a mode for Classic API and POSIX API objects that do not already have a
specific maximum limit defined. specific maximum limit defined.
@@ -503,13 +503,13 @@ When using unlimited objects, it is common practice to also specify
pool of memory for both RTEMS and application memory allocations. pool of memory for both RTEMS and application memory allocations.
@c @c
@c === CONFIGURE_OBJECTS_ALLOCATION_SIZE === @c === CONFIGURE_UNLIMITED_ALLOCATION_SIZE ===
@c @c
@subsection Specify Unlimited Objects Allocation Size @subsection Specify Unlimited Objects Allocation Size
@table @b @table @b
@item CONSTANT: @item CONSTANT:
@code{CONFIGURE_OBJECTS_ALLOCATION_SIZE} @code{CONFIGURE_UNLIMITED_ALLOCATION_SIZE}
@item DATA TYPE: @item DATA TYPE:
Unsigned integer (@code{uint32_t}). Unsigned integer (@code{uint32_t}).
@@ -518,26 +518,26 @@ Unsigned integer (@code{uint32_t}).
Positive. Positive.
@item DEFAULT VALUE: @item DEFAULT VALUE:
If not defined and @code{CONFIGURE_OBJECTS_UNLIMITED} is defined, the If not defined and @code{CONFIGURE_UNLIMITED_OBJECTS} is defined, the
default value is eight (8). default value is eight (8).
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
@code{CONFIGURE_OBJECTS_ALLOCATION_SIZE} provides an @code{CONFIGURE_UNLIMITED_ALLOCATION_SIZE} provides an
allocation size to use for @code{rtems_resource_unlimited} when using allocation size to use for @code{rtems_resource_unlimited} when using
@code{CONFIGURE_OBJECTS_UNLIMITED}. @code{CONFIGURE_UNLIMITED_OBJECTS}.
@subheading NOTES: @subheading NOTES:
By allowing users to declare all resources as being unlimited By allowing users to declare all resources as being unlimited
the user can avoid identifying and limiting the resources used. the user can avoid identifying and limiting the resources used.
@code{CONFIGURE_OBJECTS_UNLIMITED} does not support varying the allocation @code{CONFIGURE_UNLIMITED_OBJECTS} does not support varying the allocation
sizes for different objects; users who want that much control can define sizes for different objects; users who want that much control can define
the @code{rtems_resource_unlimited} macros themselves. the @code{rtems_resource_unlimited} macros themselves.
@example @example
#define CONFIGURE_OBJECTS_UNLIMITED #define CONFIGURE_UNLIMITED_OBJECTS
#define CONFIGURE_OBJECTS_ALLOCATION_SIZE 5 #define CONFIGURE_UNLIMITED_ALLOCATION_SIZE 5
@end example @end example
@c @c