How to contribute code improvements?

edeviser wrote on Thursday, October 17, 2019:

Hey there I just found an incomplete documentation in one of the freeRTOS API functions.

I would like to complete the documentation in the source code and to share the modification. But I wonder how to do so.

In fact the changes are about the return value of ´xQueueAddToSet´. The incomplete description had taken me two days. In the current version of FreeRTOS it says:

...
 * @return If the queue or semaphore was successfully added to the queue set
 * then pdPASS is returned.  If the queue could not be successfully added to the
 * queue set because it is already a member of a different queue set then pdFAIL
 * is returned.
 */
BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;

A better descrption would be:

...
 * @return If the queue or semaphore was successfully added to the queue set
 * then pdPASS is returned.  If the queue could not be successfully added to the
 * queue set because it is already a member of a different queue set or if the 
 * queue already contains items then pdFAIL is returned.
 */
BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;

rtel wrote on Thursday, October 17, 2019:

Hi - many thanks for taking the time. We are currently experimenting
with a move to git to make contributions a bit easier (eagle eyed folks
may have noticed a git repo which is currently synced with the SVN repo)

  • but at this time we are not sure how that will end up. Anyway in this
    case, as this is a simple comment change, I can just cut and paste it
    into the code if you are ok with that.