Changeset 0832ca7 in rtems


Ignore:
Timestamp:
Apr 29, 2014, 2:57:37 PM (5 years ago)
Author:
Ralf Kirchner <ralf.kirchner@…>
Branches:
4.11, master
Children:
dabf423
Parents:
03b7789
git-author:
Ralf Kirchner <ralf.kirchner@…> (04/29/14 14:57:37)
git-committer:
Sebastian Huber <sebastian.huber@…> (04/30/14 06:29:55)
Message:

doc: Extend documentation for unlimited objects

Mark POSIX Keys and POSIX Key Value Pairs as supported.
Add list of unsupported object classes.
Add hint to unified work areas.
Add example.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/conf.t

    r03b7789 r0832ca7  
    356356the new software to run; later they can tune the workspace size as needed.
    357357
     358The following API-independent object classes can be configured in
     359unlimited mode:
     360
     361@itemize @bullet
     362@item POSIX Keys
     363@item POSIX Key Value Pairs
     364@end itemize
     365
    358366The following object classes in the Classic API can be configured in
    359367unlimited mode:
     
    378386@item Mutexes
    379387@item Condition Variables
    380 @item Keys
    381388@item Timers
    382389@item Message Queues
     
    388395@end itemize
    389396
    390 Due to how the POSIX object memory requirements are configured the
    391 unlimited object support does not provide unlimited size declarations
    392 for POSIX keys or queued signals.
     397The following object classes can @strong{not} be configured in unlimited mode:
     398@itemize @bullet
     399@item Drivers
     400@item File Descriptors
     401@item User Extensions
     402@item POSIX Queued Signals
     403@end itemize
     404
     405Due to the memory requirements of unlimited objects it is strongly recommended
     406to use them only in combination with the unified work areas. See
     407@ref{Configuring a System Separate or Unified Work Areas} for more information
     408on unified work areas.
     409
     410The following example demonstrates how the two simple configuration defines for
     411unlimited objects and unified works areas can replace many seperate
     412configuration defines for supported object classes:
     413@example
     414#define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
     415#define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
     416
     417#define CONFIGURE_UNIFIED_WORK_AREAS
     418#define CONFIGURE_UNLIMITED_OBJECTS
     419
     420#define CONFIGURE_RTEMS_INIT_TASKS_TABLE
     421
     422#define CONFIGURE_INIT
     423
     424#include <rtems/confdefs.h>
     425@end example
    393426
    394427Users are cautioned that using unlimited objects is not recommended for
Note: See TracChangeset for help on using the changeset viewer.