[PATCH v2 06/12] c-user: Add labels to the manager chapters
Gedare Bloom
gedare at rtems.org
Wed Feb 10 16:45:20 UTC 2021
On Wed, Feb 10, 2021 at 9:28 AM Sebastian Huber <
sebastian.huber at embedded-brains.de> wrote:
> Update #3993.
> ---
> c-user/board_support_packages.rst | 2 +-
> c-user/clock/index.rst | 2 ++
> c-user/config/scheduler-general.rst | 2 +-
> c-user/dual-ported-memory/index.rst | 2 ++
> c-user/event/index.rst | 2 ++
> c-user/interrupt/index.rst | 2 ++
> c-user/io/index.rst | 2 ++
> c-user/message/index.rst | 2 ++
> c-user/object-services/index.rst | 2 ++
> c-user/partition/index.rst | 2 ++
> c-user/rate-monotonic/index.rst | 2 ++
> c-user/region/index.rst | 2 ++
> c-user/scheduling-concepts/index.rst | 2 +-
> c-user/semaphore/index.rst | 2 ++
> c-user/signal/index.rst | 2 ++
> c-user/task/index.rst | 2 ++
> c-user/user-extensions/index.rst | 2 +-
> 17 files changed, 30 insertions(+), 4 deletions(-)
>
> diff --git a/c-user/board_support_packages.rst
> b/c-user/board_support_packages.rst
> index e163190..4e1c991 100644
> --- a/c-user/board_support_packages.rst
> +++ b/c-user/board_support_packages.rst
> @@ -205,7 +205,7 @@ deallocating the context area, the task initiation and
> reinitiation extensions
> would be responsible for priming the context area, and the task context
> switch
> extension would save and restore the context of the device.
>
> -For more information on user extensions, refer to :ref:`User Extensions
> Manager`.
> +For more information on user extensions, refer to
> :ref:`RTEMSAPIClassicUserext`.
>
Is there a naming rule you used, especially to determine how to abbreviate?
It would be more mechanical to avoid abbreviations and instead CamelCase
the directory names?
c-user/user-extension -> RTEMSAPIClassicUserExtensions
c-user/scheduling-concepts -> RTEMSAPIClassicSchedulingConcepts
This will make identifying and recalling the labels easier.
> Multiprocessor Communications Interface (MPCI)
> ==============================================
> diff --git a/c-user/clock/index.rst b/c-user/clock/index.rst
> index 010299f..11f2790 100644
> --- a/c-user/clock/index.rst
> +++ b/c-user/clock/index.rst
> @@ -4,6 +4,8 @@
>
> .. index:: clock
>
> +.. _RTEMSAPIClassicClock:
> +
> Clock Manager
> *************
>
> diff --git a/c-user/config/scheduler-general.rst
> b/c-user/config/scheduler-general.rst
> index 7bdd044..cbdb145 100644
> --- a/c-user/config/scheduler-general.rst
> +++ b/c-user/config/scheduler-general.rst
> @@ -38,7 +38,7 @@ than one, then the
> :ref:`SchedulerSMPEDF`
> is selected as the default scheduler algorithm.
>
> -For the schedulers provided by RTEMS (see :ref:`SchedulingConcepts`), the
> +For the schedulers provided by RTEMS (see
> :ref:`RTEMSAPIClassicScheduler`), the
> configuration is straightforward. All that is required is to define the
> configuration option which specifies which scheduler you want for in your
> application.
> diff --git a/c-user/dual-ported-memory/index.rst
> b/c-user/dual-ported-memory/index.rst
> index 07628ce..cc114ac 100644
> --- a/c-user/dual-ported-memory/index.rst
> +++ b/c-user/dual-ported-memory/index.rst
> @@ -5,6 +5,8 @@
> .. index:: ports
> .. index:: dual ported memory
>
> +.. _RTEMSAPIClassicDPMem:
> +
> Dual-Ported Memory Manager
> **************************
>
> diff --git a/c-user/event/index.rst b/c-user/event/index.rst
> index 6503c35..17ccfbc 100644
> --- a/c-user/event/index.rst
> +++ b/c-user/event/index.rst
> @@ -4,6 +4,8 @@
>
> .. index:: events
>
> +.. _RTEMSAPIClassicEvent:
> +
> Event Manager
> *************
>
> diff --git a/c-user/interrupt/index.rst b/c-user/interrupt/index.rst
> index e1c529e..d3e4429 100644
> --- a/c-user/interrupt/index.rst
> +++ b/c-user/interrupt/index.rst
> @@ -4,6 +4,8 @@
>
> .. index:: interrupts
>
> +.. _RTEMSAPIClassicIntr:
> +
> Interrupt Manager
> *****************
>
> diff --git a/c-user/io/index.rst b/c-user/io/index.rst
> index 0b6ff6f..424c776 100644
> --- a/c-user/io/index.rst
> +++ b/c-user/io/index.rst
> @@ -5,6 +5,8 @@
> .. index:: device drivers
> .. index:: IO Manager
>
> +.. _RTEMSAPIClassicIO:
> +
> I/O Manager
> ***********
>
> diff --git a/c-user/message/index.rst b/c-user/message/index.rst
> index 456d177..92ebdae 100644
> --- a/c-user/message/index.rst
> +++ b/c-user/message/index.rst
> @@ -5,6 +5,8 @@
> .. index:: messages
> .. index:: message queues
>
> +.. _RTEMSAPIClassicMessage:
> +
> Message Manager
> ***************
>
> diff --git a/c-user/object-services/index.rst
> b/c-user/object-services/index.rst
> index 878e47b..43a2c10 100644
> --- a/c-user/object-services/index.rst
> +++ b/c-user/object-services/index.rst
> @@ -4,6 +4,8 @@
>
> .. index:: object manipulation
>
> +.. _RTEMSAPIClassicObject:
> +
> Object Services
> ***************
>
> diff --git a/c-user/partition/index.rst b/c-user/partition/index.rst
> index c8e7348..1396e5c 100644
> --- a/c-user/partition/index.rst
> +++ b/c-user/partition/index.rst
> @@ -4,6 +4,8 @@
>
> .. index:: partitions
>
> +.. _RTEMSAPIClassicPart:
> +
> Partition Manager
> *****************
>
> diff --git a/c-user/rate-monotonic/index.rst
> b/c-user/rate-monotonic/index.rst
> index 44a5765..a703ca0 100644
> --- a/c-user/rate-monotonic/index.rst
> +++ b/c-user/rate-monotonic/index.rst
> @@ -5,6 +5,8 @@
> .. index:: rate mononitonic tasks
> .. index:: periodic tasks
>
> +.. _RTEMSAPIClassicRatemon:
> +
> Rate Monotonic Manager
> **********************
>
> diff --git a/c-user/region/index.rst b/c-user/region/index.rst
> index 90560a8..f0be2f7 100644
> --- a/c-user/region/index.rst
> +++ b/c-user/region/index.rst
> @@ -4,6 +4,8 @@
>
> .. index:: regions
>
> +.. _RTEMSAPIClassicRegion:
> +
> Region Manager
> **************
>
> diff --git a/c-user/scheduling-concepts/index.rst
> b/c-user/scheduling-concepts/index.rst
> index 6d06d91..6b16f1b 100644
> --- a/c-user/scheduling-concepts/index.rst
> +++ b/c-user/scheduling-concepts/index.rst
> @@ -5,7 +5,7 @@
> .. index:: scheduling
> .. index:: task scheduling
>
> -.. _SchedulingConcepts:
> +.. _RTEMSAPIClassicScheduler:
>
> Scheduling Concepts
> *******************
> diff --git a/c-user/semaphore/index.rst b/c-user/semaphore/index.rst
> index 2110744..c281104 100644
> --- a/c-user/semaphore/index.rst
> +++ b/c-user/semaphore/index.rst
> @@ -7,6 +7,8 @@
> .. index:: counting semaphores
> .. index:: mutual exclusion
>
> +.. _RTEMSAPIClassicSemaphore:
> +
> Semaphore Manager
> *****************
>
> diff --git a/c-user/signal/index.rst b/c-user/signal/index.rst
> index ad28b9f..e418491 100644
> --- a/c-user/signal/index.rst
> +++ b/c-user/signal/index.rst
> @@ -4,6 +4,8 @@
>
> .. index:: signals
>
> +.. _RTEMSAPIClassicSignal:
> +
> Signal Manager
> **************
>
> diff --git a/c-user/task/index.rst b/c-user/task/index.rst
> index f4edd40..2ce8edb 100644
> --- a/c-user/task/index.rst
> +++ b/c-user/task/index.rst
> @@ -4,6 +4,8 @@
>
> .. index:: tasks
>
> +.. _RTEMSAPIClassicTask:
> +
> Task Manager
> ************
>
> diff --git a/c-user/user-extensions/index.rst
> b/c-user/user-extensions/index.rst
> index 294fcac..56aa9c4 100644
> --- a/c-user/user-extensions/index.rst
> +++ b/c-user/user-extensions/index.rst
> @@ -4,7 +4,7 @@
>
> .. index:: user extensions
>
> -.. _User Extensions Manager:
> +.. _RTEMSAPIClassicUserext:
>
> User Extensions Manager
> ***********************
> --
> 2.26.2
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20210210/7c940216/attachment-0001.html>
More information about the devel
mailing list