[PATCH 00/16] c-user: Split up chapter files
Joel Sherrill
joel at rtems.org
Sun Aug 30 16:15:03 UTC 2020
On Sun, Aug 30, 2020, 11:02 AM Joel Sherrill <joel.sherrill at gmail.com>
wrote:
>
>
> On Sun, Aug 30, 2020, 10:22 AM Gedare Bloom <gedare at rtems.org> wrote:
>
>> this is fairly mechanical. My only question is whether it is better to
>> keep the longer names for the directory. like... timer_manager/
>> instead of timer/ or to avoid abbreviations like rate_monotonic/
>> instead of ratemon/
>>
>
> Longer names and subdirectories please. It has worked in the Users Guide.
>
> We are long past 8.3 and 13 character name limits. Just avoid spaces and
> special characters in names and stick to all lower case.
>
>
>> There are two decisions here: whether or not to say manager in a
>> directory, and whether or not to abbreviate the subdirectory. There's
>> not really a right answer, and it doesn't matter greatly, so you can
>> just push it how it is if you prefer.
>>
>> -Gedare
>> On Thu, Aug 20, 2020 at 4:19 AM Sebastian Huber
>> <sebastian.huber at embedded-brains.de> wrote:
>> >
>> > This patch set is a preparation to automatically generate parts of the
>> > documentation (introduction.rst and directives.rst) in the future from
>> > specification items.
>> >
>> > Sebastian Huber (16):
>> > c-user: Split up semaphore manager
>> > c-user: Split up event manager
>> > c-user: Split up barrier manager
>> > c-user: Split up clock manager
>> > c-user: Split up dual-ported memory manager
>> > c-user: Split up interrupt manager
>> > c-user: Split up IO manager
>> > c-user: Split up message manager
>> > c-user: Split up partition manager
>> > c-user: Split up rate-monotonic manager
>> > c-user: Split up region manager
>> > c-user: Split up signal manager
>> > c-user: Split up task manager
>> > c-user: Split up timer manager
>> > c-user: Split up user extensions manager
>> > c-user: Split up scheduling concepts
>> >
>> > c-user/barrier/background.rst | 68 +
>> > .../directives.rst} | 169 +--
>> > c-user/barrier/index.rst | 14 +
>> > c-user/barrier/introduction.rst | 20 +
>> > c-user/barrier/operations.rst | 60 +
>> > c-user/clock/background.rst | 96 ++
>> > .../directives.rst} | 238 +---
>> > c-user/clock/index.rst | 15 +
>> > c-user/clock/introduction.rst | 36 +
>> > c-user/clock/operations.rst | 78 ++
>> > c-user/dpmem/background.rst | 23 +
>> > .../directives.rst} | 84 --
>> > c-user/dpmem/index.rst | 16 +
>> > c-user/dpmem/introduction.rst | 20 +
>> > c-user/dpmem/operations.rst | 44 +
>> > c-user/event/background.rst | 96 ++
>> > c-user/event/directives.rst | 142 +++
>> > c-user/event/index.rst | 15 +
>> > c-user/event/introduction.rst | 13 +
>> > c-user/event/operations.rst | 63 +
>> > c-user/event_manager.rst | 309 -----
>> > c-user/index.rst | 32 +-
>> > c-user/intr/background.rst | 106 ++
>> > .../directives.rst} | 251 ----
>> > c-user/intr/index.rst | 15 +
>> > c-user/intr/introduction.rst | 37 +
>> > c-user/intr/operations.rst | 112 ++
>> > c-user/io/background.rst | 162 +++
>> > c-user/{io_manager.rst => io/directives.rst} | 215 ----
>> > c-user/io/index.rst | 16 +
>> > c-user/io/introduction.rst | 30 +
>> > c-user/io/operations.rst | 26 +
>> > c-user/message/background.rst | 91 ++
>> > .../directives.rst} | 205 ----
>> > c-user/message/index.rst | 16 +
>> > c-user/message/introduction.rst | 28 +
>> > c-user/message/operations.rst | 89 ++
>> > c-user/part/background.rst | 50 +
>> > .../directives.rst} | 120 --
>> > c-user/part/index.rst | 15 +
>> > c-user/part/introduction.rst | 19 +
>> > c-user/part/operations.rst | 55 +
>> > c-user/rate_monotonic_manager.rst | 1091 -----------------
>> > c-user/ratemon/background.rst | 390 ++++++
>> > c-user/ratemon/directives.rst | 474 +++++++
>> > c-user/ratemon/index.rst | 16 +
>> > c-user/ratemon/introduction.rst | 33 +
>> > c-user/ratemon/operations.rst | 200 +++
>> > c-user/region/background.rst | 87 ++
>> > .../directives.rst} | 213 ----
>> > c-user/region/index.rst | 15 +
>> > c-user/region/introduction.rst | 29 +
>> > c-user/region/operations.rst | 101 ++
>> > c-user/sched/background.rst | 327 +++++
>> > c-user/sched/directives.rst | 424 +++++++
>> > c-user/sched/index.rst | 19 +
>> > c-user/sched/introduction.rst | 42 +
>> > c-user/sched/smp-schedulers.rst | 69 ++
>> > c-user/sched/uniprocessor-schedulers.rst | 113 ++
>> > c-user/scheduling_concepts.rst | 968 ---------------
>> > c-user/sem/background.rst | 180 +++
>> > .../directives.rst} | 309 -----
>> > c-user/sem/index.rst | 18 +
>> > c-user/sem/introduction.rst | 25 +
>> > c-user/sem/operations.rst | 105 ++
>> > c-user/signal/background.rst | 112 ++
>> > c-user/signal/directives.rst | 126 ++
>> > c-user/signal/index.rst | 15 +
>> > c-user/signal/introduction.rst | 13 +
>> > c-user/signal/operations.rst | 75 ++
>> > c-user/signal_manager.rst | 322 -----
>> > c-user/tasks/background.rst | 390 ++++++
>> > .../directives.rst} | 625 ----------
>> > c-user/tasks/index.rst | 15 +
>> > c-user/tasks/introduction.rst | 50 +
>> > c-user/tasks/operations.rst | 192 +++
>> > c-user/timer/background.rst | 71 ++
>> > .../directives.rst} | 180 ---
>> > c-user/timer/index.rst | 15 +
>> > c-user/timer/introduction.rst | 29 +
>> > c-user/timer/operations.rst | 84 ++
>> > .../background.rst} | 161 ---
>> > c-user/userext/directives.rst | 143 +++
>> > c-user/userext/index.rst | 16 +
>> > c-user/userext/introduction.rst | 17 +
>> > 85 files changed, 5759 insertions(+), 5449 deletions(-)
>> > create mode 100644 c-user/barrier/background.rst
>> > rename c-user/{barrier_manager.rst => barrier/directives.rst} (55%)
>> > create mode 100644 c-user/barrier/index.rst
>> > create mode 100644 c-user/barrier/introduction.rst
>> > create mode 100644 c-user/barrier/operations.rst
>> > create mode 100644 c-user/clock/background.rst
>> > rename c-user/{clock_manager.rst => clock/directives.rst} (65%)
>> > create mode 100644 c-user/clock/index.rst
>> > create mode 100644 c-user/clock/introduction.rst
>> > create mode 100644 c-user/clock/operations.rst
>> > create mode 100644 c-user/dpmem/background.rst
>> > rename c-user/{dual_ports_memory_manager.rst => dpmem/directives.rst}
>> (64%)
>> > create mode 100644 c-user/dpmem/index.rst
>> > create mode 100644 c-user/dpmem/introduction.rst
>> > create mode 100644 c-user/dpmem/operations.rst
>> > create mode 100644 c-user/event/background.rst
>> > create mode 100644 c-user/event/directives.rst
>> > create mode 100644 c-user/event/index.rst
>> > create mode 100644 c-user/event/introduction.rst
>> > create mode 100644 c-user/event/operations.rst
>> > delete mode 100644 c-user/event_manager.rst
>> > create mode 100644 c-user/intr/background.rst
>> > rename c-user/{interrupt_manager.rst => intr/directives.rst} (61%)
>> > create mode 100644 c-user/intr/index.rst
>> > create mode 100644 c-user/intr/introduction.rst
>> > create mode 100644 c-user/intr/operations.rst
>> > create mode 100644 c-user/io/background.rst
>> > rename c-user/{io_manager.rst => io/directives.rst} (61%)
>> > create mode 100644 c-user/io/index.rst
>> > create mode 100644 c-user/io/introduction.rst
>> > create mode 100644 c-user/io/operations.rst
>> > create mode 100644 c-user/message/background.rst
>> > rename c-user/{message_manager.rst => message/directives.rst} (69%)
>> > create mode 100644 c-user/message/index.rst
>> > create mode 100644 c-user/message/introduction.rst
>> > create mode 100644 c-user/message/operations.rst
>> > create mode 100644 c-user/part/background.rst
>> > rename c-user/{partition_manager.rst => part/directives.rst} (70%)
>> > create mode 100644 c-user/part/index.rst
>> > create mode 100644 c-user/part/introduction.rst
>> > create mode 100644 c-user/part/operations.rst
>> > delete mode 100644 c-user/rate_monotonic_manager.rst
>> > create mode 100644 c-user/ratemon/background.rst
>> > create mode 100644 c-user/ratemon/directives.rst
>> > create mode 100644 c-user/ratemon/index.rst
>> > create mode 100644 c-user/ratemon/introduction.rst
>> > create mode 100644 c-user/ratemon/operations.rst
>> > create mode 100644 c-user/region/background.rst
>> > rename c-user/{region_manager.rst => region/directives.rst} (66%)
>> > create mode 100644 c-user/region/index.rst
>> > create mode 100644 c-user/region/introduction.rst
>> > create mode 100644 c-user/region/operations.rst
>> > create mode 100644 c-user/sched/background.rst
>> > create mode 100644 c-user/sched/directives.rst
>> > create mode 100644 c-user/sched/index.rst
>> > create mode 100644 c-user/sched/introduction.rst
>> > create mode 100644 c-user/sched/smp-schedulers.rst
>> > create mode 100644 c-user/sched/uniprocessor-schedulers.rst
>> > delete mode 100644 c-user/scheduling_concepts.rst
>> > create mode 100644 c-user/sem/background.rst
>> > rename c-user/{semaphore_manager.rst => sem/directives.rst} (64%)
>> > create mode 100644 c-user/sem/index.rst
>> > create mode 100644 c-user/sem/introduction.rst
>> > create mode 100644 c-user/sem/operations.rst
>> > create mode 100644 c-user/signal/background.rst
>> > create mode 100644 c-user/signal/directives.rst
>> > create mode 100644 c-user/signal/index.rst
>> > create mode 100644 c-user/signal/introduction.rst
>> > create mode 100644 c-user/signal/operations.rst
>> > delete mode 100644 c-user/signal_manager.rst
>> > create mode 100644 c-user/tasks/background.rst
>> > rename c-user/{task_manager.rst => tasks/directives.rst} (63%)
>> > create mode 100644 c-user/tasks/index.rst
>> > create mode 100644 c-user/tasks/introduction.rst
>> > create mode 100644 c-user/tasks/operations.rst
>> > create mode 100644 c-user/timer/background.rst
>> > rename c-user/{timer_manager.rst => timer/directives.rst} (64%)
>> > create mode 100644 c-user/timer/index.rst
>> > create mode 100644 c-user/timer/introduction.rst
>> > create mode 100644 c-user/timer/operations.rst
>> > rename c-user/{user_extensions.rst => userext/background.rst} (77%)
>> > create mode 100644 c-user/userext/directives.rst
>> > create mode 100644 c-user/userext/index.rst
>> > create mode 100644 c-user/userext/introduction.rst
>> >
>> > --
>> > 2.26.2
>> >
>> > _______________________________________________
>> > devel mailing list
>> > devel at rtems.org
>> > http://lists.rtems.org/mailman/listinfo/devel
>> _______________________________________________
>> 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/20200830/ded3768f/attachment-0001.html>
More information about the devel
mailing list