[PATCH 00/16] c-user: Split up chapter files

[Gedare Bloom]

On Tue, Sep 1, 2020 at 11:55 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> On 31/08/2020 08:55, Sebastian Huber wrote:
>
> > On 30/08/2020 18:41, Gedare Bloom wrote:
> >
> >> On Sun, Aug 30, 2020 at 10:15 AM Joel Sherrill<joel at rtems.org>  wrote:
> >>>
> >>> 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.
> >>>>
> >> Should we explicitly say _manager on each of them though? Or it is ok
> >> to say timer/ clock/ rate_monotonic/ and so on?
> >
> > If you prefer long names, then I would simply use the chapter names,
> > for example "rate-monotonic-manager", "scheduling-concepts", etc.
> >
> > The directory names of the patch correspond to the header file names
> > in cpukit/include/rtems/rtems and I used them also for the specification:
> >
> > https://git.rtems.org/rtems-central/tree/spec/req/rtems
> >
> > https://git.rtems.org/rtems-central/tree/spec/if/rtems
> >
> Just to make sure I don't change things in the wrong direction. You
> prefer long names which correspond to the chapter names and not the
> abbreviated names which are used elsewhere?

I do. That will keep the file names associated with their generated
content. I think it will help newcomers to contribute documentation
patches easier.

-Gedare