[PATCH 1/2] c-user: Generate Event Manager documentation

[Sebastian Huber]

On 10/11/2020 00:03, Chris Johns wrote:
> On 10/11/20 1:47 am, Sebastian Huber wrote:
>> The manager documentation is a consolidation of the comments in Doxygen
>> markup and the documentation sources in Sphinx markup.  The
>> documentation was transfered to interface specification items.  This
>> header file was generated from the items by a script.
>>
>> Update #3993.
>> ---
>>   c-user/event/directives.rst   | 320 +++++++++++++++++++++-------------
>>   c-user/event/introduction.rst |  31 +++-
>>   2 files changed, 230 insertions(+), 121 deletions(-)
>>
>> diff --git a/c-user/event/directives.rst b/c-user/event/directives.rst
>> index ef94115..95ae456 100644
>> --- a/c-user/event/directives.rst
>> +++ b/c-user/event/directives.rst
>> @@ -1,142 +1,228 @@
>>   .. SPDX-License-Identifier: CC-BY-SA-4.0
>>   
>> +.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
>>   .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
>>   
>> +.. Do not manually edit this file.  It is part of the RTEMS quality process
>> +.. and was automatically generated.
> I am wondering if we need to pull back a little from "Do not manually edit this
> file"? A patch to this file that fixes something may be better than not getting
> a fix and being notified of a problem. What about ...
>
>   .. This file has been automatically generated and is under the control of
>   .. the RTEMS quality process. Manual edits to the following content may be
>   .. lost.
>
> ?
>
>> +..
>> +.. 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 regenerating please refer to:
>> +..
>> +..https://docs.rtems.org/branches/master/eng/req/howto.html
>> +

Maybe we should remove the manual edit part entirely:

.. This file 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 or patch 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 regenerating please refer to:
..
.. https://docs.rtems.org/branches/master/eng/req/howto.html

-- 
embedded brains GmbH
Sebastian HUBER
Dornierstr. 4
82178 Puchheim
Germany
email: sebastian.huber at embedded-brains.de
Phone: +49-89-18 94 741 - 16
Fax:   +49-89-18 94 741 - 08
PGP: Public key available on request.

embedded brains GmbH
Registergericht: Amtsgericht München
Registernummer: HRB 157899
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
Unsere Datenschutzerklärung finden Sie hier: https://embedded-brains.de/datenschutzerklaerung/