Changeset 9ba26e7 in rtems-docs


Ignore:
Timestamp:
05/20/22 13:45:16 (7 weeks ago)
Author:
Joel Sherrill <joel@…>
Branches:
master
Children:
d5509d6
Parents:
c16c8c6
Message:

c-user: Update references to --enable-* configure options.

Also updated list of SMP architectures and added enough lead in
to let users know the source code was the definitive answer.

Location:
c-user
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • c-user/config/general.rst

    rc16c8c6 r9ba26e7  
    438438ignored.
    439439
    440 This configuration option is only evaluated in SMP configurations (e.g. RTEMS
    441 was built with the ``--enable-smp`` build configuration option).  In all
    442 other configurations it has no effect.
     440This configuration option is only evaluated in SMP configurations of RTEMS
     441(e.g. RTEMS was built with the SMP build configuration option enabled).
     442In all other configurations it has no effect.
    443443
    444444.. rubric:: CONSTRAINTS:

  • c-user/config/mpci.rst

    rc16c8c6 r9ba26e7  
    2424=============================
    2525
    26 This section describes multiprocessing related configuration options.  The
    27 options are only used if RTEMS was built with the ``--enable-multiprocessing``
    28 build configuration option.  Additionally, this class of configuration options
    29 are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION`
    30 is defined.  The multiprocessing (MPCI) support must not be confused with the
    31 SMP support.
     26This section describes multiprocessing related configuration options.
     27The options are only used if RTEMS was built when the multiprocessing
     28build configuration option is enabled. The multiprocessing configuration
     29is distinct from the SMP configuration.  Additionally, this class of
     30configuration options are only applicable if the configuration option
     31:ref:`CONFIGURE_MP_APPLICATION` is defined.  The multiprocessing (MPCI)
     32support must not be confused with the SMP support.
    3233
    3334.. Generated from spec:/acfg/if/mp-extra-server-stack
    … …  
    116117
    117118This configuration option shall be undefined if the multiprocessing support
    118 is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing``
    119 build configuration option).  Otherwise a compile time error in the
     119is not enabled (e.g. RTEMS was built without the multiprocessing build
     120configuration option enabled).  Otherwise a compile time error in the
    120121configuration file will occur.
    121122

  • c-user/config/posix-api.rst

    rc16c8c6 r9ba26e7  
    2626This section describes configuration options related to the POSIX API.  Most
    2727POSIX API objects are available by default since RTEMS 5.1.  The queued signals
    28 and timers are only available if RTEMS was built with the ``--enable-posix``
     28and timers are only available if RTEMS was built with the enable POSIX
    2929build configuration option.
    3030
    … …  
    232232Unlimited objects are not available for queued signals.
    233233
    234 Queued signals are only available if RTEMS was built with the
    235 ``--enable-posix`` build configuration option.
     234Queued signals are only available if RTEMS was built with the POSIX API
     235build configuration option enabled.
    236236
    237237.. rubric:: CONSTRAINTS:
    … …  
    471471:ref:`ConfigUnlimitedObjects`.
    472472
    473 Timers are only available if RTEMS was built with the
    474 ``--enable-posix`` build configuration option.
    475 
    476 .. rubric:: CONSTRAINTS:
    477 
    478 The following constraints apply to this configuration option:
    479 
    480 * The value of the configuration option shall be greater than or equal to zero.
    481 
    482 * The value of the configuration option shall be less than or equal to 65535.
    483 
    484 * The value of the configuration option shall be less than or equal to a
    485   BSP-specific and application-specific value which depends on the size of the
    486   memory available to the application.
     473Timers are only available if RTEMS was built with the POSIX API build
     474configuration option enabled.
     475
     476.. rubric:: CONSTRAINTS:
     477
     478The following constraints apply to this configuration option:
     479
     480* The value of the configuration option shall be greater than or equal
     481to zero.
     482
     483* The value of the configuration option shall be less than or equal
     484to 65535.
     485
     486* The value of the configuration option shall be less than or equal to a
     487  BSP-specific and application-specific value which depends on the size
     488  of the memory available to the application.
    487489
    488490* The value of the configuration option may be defined through
    … …  
    491493  satisfies all other constraints of the configuration option.
    492494
    493 * The value of the configuration option shall be zero if the POSIX API is not
    494   enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True`` build
    495   configuration option).  Otherwise a compile time error in the configuration
     495* The value of the configuration option shall be zero if the POSIX API
     496is not
     497  enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True``
     498  build configuration option).  Otherwise a compile time error in the
     499  configuration
    496500  file will occur.
    497501

  • c-user/symmetric_multiprocessing_services.rst

    rc16c8c6 r9ba26e7  
    1414============
    1515
    16 The Symmetric Multiprocessing (SMP) support of the RTEMS is available on
     16RTEMS Symmetric Multiprocessing (SMP) support is available on a subset
     17of target architectures supported by RTEMS. Further on some target
     18architectures, it is only available on a subset of BSPs. The user is
     19advised to check the BSP specific documentation and RTEMS source code
     20to verify the status of SMP support for a specific BSP. The following
     21architectures have support for SMP:
     22
     23-- AArch64
    1724
    1825- ARMv7-A,
    1926
     27- i386,
     28
    2029- PowerPC,
    2130
    … …  
    2635.. warning::
    2736
    28     The SMP support is only available if RTEMS was built with the
    29     ``--enable-smp`` build configuration option.
     37    SMP support is only available if RTEMS was built with the
     38    SMP build configuration option enabled.
    3039
    3140RTEMS is supposed to be a real-time operating system.  What does this mean in
    … …  
    581590
    582591To identify the bottlenecks in the system, support for profiling of low-level
    583 synchronization is optionally available.  The profiling support is a BSP build
    584 time configuration option (``--enable-profiling``) and is implemented with an
    585 acceptable overhead, even for production systems.  A low-overhead counter for
    586 short time intervals must be provided by the hardware.
     592synchronization is optionally available.  The profiling support is
     593an RTEMS build time configuration option and is implemented with an
     594acceptable overhead, even for production systems.  A low-overhead counter
     595for short time intervals must be provided by the hardware.
    587596
    588597Profiling reports are generated in XML for most test programs of the RTEMS
Note: See TracChangeset for help on using the changeset viewer.