Documentation | Make example app compile again. (!231)

[Joel Sherrill (@joel)]

Merge request https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/231 was reviewed by Joel Sherrill

--
  
Joel Sherrill started a new discussion on c-user/example_application.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/231#note_145946

 > -*  a user initialization task and a simple task.
 > -*/
 > + *  This file contains an example of a simple RTEMS

Comments should only be indented one space. If this is just white space change, please undo it.

--
  
Joel Sherrill started a new discussion on c-user/example_application.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/231#note_145947

 >  {
 >      /* application specific initialization goes here */
 >      while ( 1 )  {              /* infinite loop */

This needs to be one space indent.

--
  
Joel Sherrill started a new discussion on c-user/example_application.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/231#note_145948

 >  
 > -    status = rtems_task_delete( SELF );    /* should not return */
 > +    status = rtems_task_delete( rtems_task_self() );    /* should not return */

There are three ways in the Classic API to delete the calling thread:

- _rtems_task_delete(RTEMS_SELF)_
- _rtems_task_exit()_
- _rtems_task_delete( rtems_task_self() )_

The first is the usual way of deleting the calling thread because this call is supported from the earliest days of RTEMS.

The second is the newest way but it is cleaner in the implementation because it only deals with the deleting self case.

The third uses _rtems_task_self()_ which was not in the oldest RTEMS versions.

Since this is in current documentation, it does not have to worry about using a new-ish API. I would recommend changing this to option 2 above.

--
  
Joel Sherrill started a new discussion on c-user/example_application.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/231#note_145949

 > +    status = rtems_task_delete( rtems_task_self() );    /* should not return */
 >  
 >      printf( "rtems_task_delete returned with status of %d.\n", status );

These should be deleted and a comment about not getting to this point added.


-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/231
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20260318/5a48ca42/attachment-0001.htm>