Changeset e0938c2 in rtems


Ignore:
Timestamp:
Jun 15, 2015, 6:22:31 PM (5 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, 5, master
Children:
9d838902
Parents:
e6b31b27
Message:

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

closes #2368.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/conf.t

    re6b31b27 re0938c2  
    1 @c  COPYRIGHT (c) 1988-2013.
     1@c  COPYRIGHT (c) 1988-2015.
    22@c  On-Line Applications Research Corporation (OAR).
    33@c  All rights reserved.
     
    472472
    473473@c
    474 @c === CONFIGURE_OBJECTS_UNLIMITED ===
     474@c === CONFIGURE_UNLIMITED_OBJECTS ===
    475475@c
    476476@subsection Enable Unlimited Object Instances
    477477
    478 @findex CONFIGURE_OBJECTS_UNLIMITED
    479 
    480 @table @b
    481 @item CONSTANT:
    482 @code{CONFIGURE_OBJECTS_UNLIMITED}
     478@findex CONFIGURE_UNLIMITED_OBJECTS
     479
     480@table @b
     481@item CONSTANT:
     482@code{CONFIGURE_UNLIMITED_OBJECTS}
    483483
    484484@item DATA TYPE:
     
    494494
    495495@subheading DESCRIPTION:
    496 @code{CONFIGURE_OBJECTS_UNLIMITED} enables @code{rtems_resource_unlimited}
     496@code{CONFIGURE_UNLIMITED_OBJECTS} enables @code{rtems_resource_unlimited}
    497497mode for Classic API and POSIX API objects that do not already have a
    498498specific maximum limit defined.
     
    504504
    505505@c
    506 @c === CONFIGURE_OBJECTS_ALLOCATION_SIZE ===
     506@c === CONFIGURE_UNLIMITED_ALLOCATION_SIZE ===
    507507@c
    508508@subsection Specify Unlimited Objects Allocation Size
     
    510510@table @b
    511511@item CONSTANT:
    512 @code{CONFIGURE_OBJECTS_ALLOCATION_SIZE}
     512@code{CONFIGURE_UNLIMITED_ALLOCATION_SIZE}
    513513
    514514@item DATA TYPE:
     
    519519
    520520@item DEFAULT VALUE:
    521 If not defined and @code{CONFIGURE_OBJECTS_UNLIMITED} is defined, the
     521If not defined and @code{CONFIGURE_UNLIMITED_OBJECTS} is defined, the
    522522default value is eight (8).
    523523
     
    525525
    526526@subheading DESCRIPTION:
    527 @code{CONFIGURE_OBJECTS_ALLOCATION_SIZE} provides an
     527@code{CONFIGURE_UNLIMITED_ALLOCATION_SIZE} provides an
    528528allocation size to use for @code{rtems_resource_unlimited} when using
    529 @code{CONFIGURE_OBJECTS_UNLIMITED}.
     529@code{CONFIGURE_UNLIMITED_OBJECTS}.
    530530
    531531@subheading NOTES:
    532532By allowing users to declare all resources as being unlimited
    533533the user can avoid identifying and limiting the resources used.
    534 @code{CONFIGURE_OBJECTS_UNLIMITED} does not support varying the allocation
     534@code{CONFIGURE_UNLIMITED_OBJECTS} does not support varying the allocation
    535535sizes for different objects; users who want that much control can define
    536536the @code{rtems_resource_unlimited} macros themselves.
    537537
    538538@example
    539 #define CONFIGURE_OBJECTS_UNLIMITED
    540 #define CONFIGURE_OBJECTS_ALLOCATION_SIZE 5
     539#define CONFIGURE_UNLIMITED_OBJECTS
     540#define CONFIGURE_UNLIMITED_ALLOCATION_SIZE 5
    541541@end example
    542542
Note: See TracChangeset for help on using the changeset viewer.