Add units to timeout argument in EventFlags

[kegilbert]

Description

Add units to the timeout argument in wait_all/any:

#8894

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[X] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@sarahmarshy
@AnotherButler

[kjbracey]

This phrasing occurs in quite a lot of other RTOS header files, as they were a copy-and-paste from CMSIS-RTOS docs (but might be CMSIS-RTOS v1 rather than v2?). Would be worth updating the others if doing EventFlags, as I think consistency is important here - they all have exactly the same time concept.

I can immediately think of Thread, ThisThread, Semaphore, Mutex, possibly ConditionVariable.

As a sort of compromise, some of those seem to have kept the phrasing, but renamed the timeout variable to millisec.

[kegilbert]

@kjbracey-arm It looks like everything else in rtos uses the millisecond parameter name with the old description. I'm not as much of a fan of this since I find it's a bit strange to name the variable after the units and not what it does but as everything uses that I could instead change the EventFlag parameter to millisecond for consistency.

[0Grit]

#9077

Edit: Lightly related issue

[cmonr]

@loverdeg-ep Mind elaborating on your single-link comment?

[0Grit]

@loverdeg-ep Mind elaborating on your single-link comment?

Kind of a personal note I suppose. Like to be able to retrace interesting & related conversations for my future self.

I'll cut it out if causing trouble.

[kjbracey]

As per comment above, I'm going to request that this be made consistent across the rtos classes.

I don't mind whether you change this to match the others, or change all the others to match your new form here - others can express a preference.

[cmonr]

I'll cut it out if causing trouble.

Nah, no need. That's fine.

[cmonr]

@kegilbert Any progress?

[kegilbert]

Yup, updating this today.

[kegilbert]

I additionally removed the or 0 in case of no timeout segments from the comments as that implied the opposite of what a timeout of 0 actually did to me (no timeout to me sounds like the function will never timeout which is what osWaitForever will do).

@param millisec Timeout value or 0 in case of no timeout (default: osWaitForever).

As we had in Mail.h in particular threw me off. Feel free to let me know if you disagree, I can change that back if need be.

[0xc0170]

CI started

[mbed-ci]

Test run: SUCCESS

Summary: 12 of 12 test jobs passed
Build number : 1
Build artifacts