STM32CubeWB icon indicating copy to clipboard operation
STM32CubeWB copied to clipboard

Documentation issues

Open marc6h opened this issue 1 year ago • 3 comments

There is some unclear/sloppy documentation in this repo, such as here. What is meant by "this tadhr" or "this Take"? "Through the mutex" means what?

    /* The first time through the mutex will be immediately available, on
    subsequent times through the mutex will be held by the low priority thread
    at this point and this Take will cause the low priority thread to inherit
    the priority of this tadhr.  In this case the block time must be
    long enough to ensure the low priority thread will execute again before the
    block time expires.  If the block time does expire then the error
    flag will be set here */
    if (osMutexWait(osMutexHandle, mutexTWO_TICK_DELAY) != osOK)
    {
      /* Toggle LED3 to indicate error */
      BSP_LED_Toggle(LED3);
    }

marc6h avatar May 17 '24 08:05 marc6h

Hi @marc6h,

Thank you for this report. Please note the word "through" is part of both expressions "the first time through" and "on subsequent times through".

Regarding the word "tadhr", it is likely to be a typo. I will ask to check the relevance of the word "Take". I will keep you informed.

With regards,

ALABSTM avatar May 21 '24 16:05 ALABSTM

ST Internal Reference: 182341

ALABSTM avatar May 24 '24 17:05 ALABSTM

See also STM32CubeG4#44

ALABSTM avatar May 27 '24 16:05 ALABSTM

Fixed in commit fac4f05637d6444c1f624ec4ec70d785466789fc

ALABSTM avatar Jul 12 '24 14:07 ALABSTM