Future of Doc Was: Re: [rtems commit] rtems: Add task get/set scheduler

[Gedare Bloom]

On Wed, Apr 16, 2014 at 4:08 AM, Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
> On 2014-04-15 18:20, Joel Sherrill wrote:
>>
>>
>> On 4/15/2014 11:14 AM, Sebastian Huber wrote:
>>>
>>> On 04/15/2014 02:48 PM, Sebastian Huber wrote:
>>>>
>>>> On 2014-04-15 14:36, Joel Sherrill wrote:
>>>>>
>>>>> You added to the API and added no documentation.
>>>>
>>>> I added the documentation in Doxygen:
>>>>
>>>> http://www.rtems.org/pipermail/rtems-devel/2014-March/005901.html
>>>>
>>> Ok, since we are close to the RTEMS 4.11 release I will add texinfo
>>> documentation to all new high-level functions.  After the RTEMS 4.11
>>> release we should definitely do something against this copy and paste
>>> nightmare.
>>>
>>> Joel, what is your opinion with respect to the future documentation
>>> infrastructure of RTEMS?
>>>
>> User Guides should not be in Doxygen.
>
>
> It is possible to write user guides with Doxygen (see @page command).
>
I completely agree that we need to eliminate so much copy-paste. We
need to have a better plan for managing documentation, for user
developers and for kernel developers. I'd like to hear some more
thoughts on the subject and also see some initial requirements.

Gedare