[rtems commit] user/conf.t: Fix names for CONFIGURE_UNLIMITED_OBJECTS and CONFIGURE_UNLIMITED_ALLOCATION_SIZE

Joel Sherril joel at rtems.org
Mon Jun 15 18:23:30 UTC 2015


Module:    rtems
Branch:    master
Commit:    e0938c2754528fbcdec9bd434e5e7732d2c850bf
Changeset: http://git.rtems.org/rtems/commit/?id=e0938c2754528fbcdec9bd434e5e7732d2c850bf

Author:    Joel Sherrill <joel.sherrill at oarcorp.com>
Date:      Mon Jun 15 13:22:31 2015 -0500

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

closes #2368.

---

 doc/user/conf.t | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/doc/user/conf.t b/doc/user/conf.t
index 523eee5..86d0ba5 100644
--- a/doc/user/conf.t
+++ b/doc/user/conf.t
@@ -1,4 +1,4 @@
- at c  COPYRIGHT (c) 1988-2013.
+ at c  COPYRIGHT (c) 1988-2015.
 @c  On-Line Applications Research Corporation (OAR).
 @c  All rights reserved.
 
@@ -471,15 +471,15 @@ is only responsible for enabling unlimited objects and specifying the
 allocation size.
 
 @c
- at c === CONFIGURE_OBJECTS_UNLIMITED ===
+ at c === CONFIGURE_UNLIMITED_OBJECTS ===
 @c
 @subsection Enable Unlimited Object Instances
 
- at findex CONFIGURE_OBJECTS_UNLIMITED
+ at findex CONFIGURE_UNLIMITED_OBJECTS
 
 @table @b
 @item CONSTANT:
- at code{CONFIGURE_OBJECTS_UNLIMITED}
+ at code{CONFIGURE_UNLIMITED_OBJECTS}
 
 @item DATA TYPE:
 Boolean feature macro.
@@ -493,7 +493,7 @@ This is not defined by default.
 @end table
 
 @subheading DESCRIPTION:
- at code{CONFIGURE_OBJECTS_UNLIMITED} enables @code{rtems_resource_unlimited}
+ at code{CONFIGURE_UNLIMITED_OBJECTS} enables @code{rtems_resource_unlimited}
 mode for Classic API and POSIX API objects that do not already have a
 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.
 
 @c
- at c === CONFIGURE_OBJECTS_ALLOCATION_SIZE ===
+ at c === CONFIGURE_UNLIMITED_ALLOCATION_SIZE ===
 @c
 @subsection Specify Unlimited Objects Allocation Size
 
 @table @b
 @item CONSTANT:
- at code{CONFIGURE_OBJECTS_ALLOCATION_SIZE}
+ at code{CONFIGURE_UNLIMITED_ALLOCATION_SIZE}
 
 @item DATA TYPE:
 Unsigned integer (@code{uint32_t}).
@@ -518,26 +518,26 @@ Unsigned integer (@code{uint32_t}).
 Positive.
 
 @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).
 
 @end table
 
 @subheading DESCRIPTION:
- at code{CONFIGURE_OBJECTS_ALLOCATION_SIZE} provides an
+ at code{CONFIGURE_UNLIMITED_ALLOCATION_SIZE} provides an
 allocation size to use for @code{rtems_resource_unlimited} when using
- at code{CONFIGURE_OBJECTS_UNLIMITED}.
+ at code{CONFIGURE_UNLIMITED_OBJECTS}.
 
 @subheading NOTES:
 By allowing users to declare all resources as being unlimited
 the user can avoid identifying and limiting the resources used.
- at code{CONFIGURE_OBJECTS_UNLIMITED} does not support varying the allocation
+ at code{CONFIGURE_UNLIMITED_OBJECTS} does not support varying the allocation
 sizes for different objects; users who want that much control can define
 the @code{rtems_resource_unlimited} macros themselves.
 
 @example
-#define CONFIGURE_OBJECTS_UNLIMITED
-#define CONFIGURE_OBJECTS_ALLOCATION_SIZE 5
+#define CONFIGURE_UNLIMITED_OBJECTS
+#define CONFIGURE_UNLIMITED_ALLOCATION_SIZE 5
 @end example
 
 @c




More information about the vc mailing list