[PATCH v2] c-user: Generate I/O Manager documentation

Sebastian Huber sebastian.huber at embedded-brains.de
Tue Oct 6 06:15:23 UTC 2020


On 06/10/2020 03:25, Chris Johns wrote:

> On 6/10/20 1:39 am, Sebastian Huber wrote:
>> +.. This file was automatically generated.  Do not edit it manually.
>> +.. Please have a look at
>> +..
>> +..https://docs.rtems.org/branches/master/eng/req/howto.html
>> +..
>> +.. for information how to maintain and re-generate this file.
> This section is a good idea but I think it needs to be aimed at a user with no
> knowledge or interest in the qualification process and what it involves.
>
> What about something like ...
>
> .. Do not manually edit this file. It is part of the RTEMS quality process
> .. and was automatically generated.
> ..
> .. If you find something that needs to be fixed or worded better please
> .. post a report to an RTEMS mailing list or raise a bug report:
> ..
> ..https://docs.rtems.org/branches/master/user/support/bugs.html
> ..
> .. For information on updating and re-generating please refer to:
> ..
> ..https://docs.rtems.org/branches/master/eng/req/howto.html
>
> ?
>
> Should ...
>
> https://docs.rtems.org/branches/master/c-user/index.html
>
> ... etc, have a similar statement before the Online Resources table that states:
>
>
> This document is part of the RTEMS Quality Process and contains generated
> sections. If you find something that needs to be fixed or worded better
> please post a report to an RTEMS mailing list or raise a bug report:
>
> https://docs.rtems.org/branches/master/user/support/bugs.html
>
>
> This means for now core developers are accepting maintenance of this part of the
> documentation. This seems like a sensible place to start.
Ok, good, this is pragmatic approach. I will change accordingly it in v3 
of the patch.


More information about the devel mailing list