[PATCH 0/1] Generate application configuration option documentation

Sebastian Huber sebastian.huber at embedded-brains.de
Wed Jul 8 06:09:31 UTC 2020

On 08/07/2020 07:35, Sebastian Huber wrote:

>> It seems to me the key is the central repo and how it functions, how 
>> easy or
>> hard it is to learn about it and how well it will work in practice. A 
>> key
>> concern is taking it from a single person repo, ie you, to a project 
>> wide repo
>> with concurrent updates ad lots of moving pieces. It is easy to ask 
>> these
>> questions and I appreciate they are not all easy to answer but I 
>> think we need
>> to try.
> My approach would be to document common tasks for the every day RTEMS 
> maintenance:
> https://docs.rtems.org/branches/master/eng/req/howto.html
> You also have to consider the future rate of change. The API parts, 
> application configuration options, and glossary terms for example are 
> all things which don't change every week. 
We have a new employee since last week. He has no RTEMS, embedded 
system, ECSS, and ESA experience. He should help me with the 
pre-qualification work. My approach would be to document the tasks in 
the howto section of the RTEMS Software Engineering manual and try to 
avoid instructions in person. This should help to work out documentation 
relevant for the RTEMS maintenance which is understandable for newcomers.

More information about the devel mailing list