> Time which could be devoted to this subject > is too short, when other duties have to be carried out as well. Usual > dilemma, usual outcome so far.
Anything I and the community (us) can do to help with this? Pull requests with documentation amendments? ________________________________________ From: Philippe Gerum <r...@xenomai.org> Sent: 11 June 2017 16:47 To: Giulio Moro; xenomai@xenomai.org Subject: Re: [Xenomai] rt_taks_bind() returns -EAGAIN for existing task On 06/11/2017 04:11 AM, Giulio Moro wrote: > Great info, it would be good to integrate these in the main docs somewhere. I > had been at that URL a few times already, but the brief description of > "session" given there is really not as complete as the one you just gave. I > now see that "session" is mentioned twice in the task API documentation: > The task documentation, for instance, > mhttp://xenomai.org/documentation/xenomai-3/html/xeno3prm/group__alchemy__task.html > Unfortunately, someone finding it there would struggle to link it back to the > command line options page and to put it in a wider context. > > Perhaps a solution would be to add an "API tag" to rt_task_shadow, > rt_task_create, rt_task_bind and all the other relevant functions (I assume > there must be something also, e.g.: under pipe/queue/message/semaphore?) and > add your description here > http://xenomai.org/documentation/xenomai-3/html/xeno3prm/api-tags.html ? > Yes, that would make sense. There is a lot to do for better documenting Xenomai, especially introducing a user guide and application notes. Today, most of the existing documentation we have belongs to the reference manual category, which is clearly not enough to bring newcomers up to speed for working with Xenomai. Technically speaking, a painful issue is that Doxygen is not very handy to work with, when it comes to organizing the information - not to speak of its parser which tend to drive people nuts when trying to figure out the location of a deeply buried glitch in some obscure syntax. The documentation on the website is fortunately based on asciidoc, but there is not much there yet. Time which could be devoted to this subject is too short, when other duties have to be carried out as well. Usual dilemma, usual outcome so far. -- Philippe. _______________________________________________ Xenomai mailing list Xenomai@xenomai.org https://xenomai.org/mailman/listinfo/xenomai
