Deprecated/removed function in the user manual?

Chris Johns chrisj at rtems.org
Mon Dec 12 21:23:31 UTC 2016


On 12/12/2016 22:28, Sebastian Huber wrote:
> I work currently on documentation updates. How do we deal with
> deprecated/remove functions in the user manual? For example
> rtems_iterate_over_all_threads() is deprecated (replacement is
> rtems_task_iterate()). Task variables/notes are removed in RTEMS 4.12.

I would add a new section and group the removed functions etc by the 
version they are first removed. The record is historical, for example a 
4.9 user moving to 4.12 can use the 4.12 docs to see what has been 
removed without having to review the docs from each preceding release.

Chris


More information about the devel mailing list