[riot-notifications] [RIOT-OS/RIOT] sys/xtimer.h: fix XTIMER_BACKOFF doc (#11538)

Francisco notifications at github.com
Thu May 16 23:14:01 CEST 2019


<!--
The RIOT community cares a lot about code quality.
Therefore, before describing what your contribution is about, we would like
you to make sure that your modifications are compliant with the RIOT
coding conventions, see https://github.com/RIOT-OS/RIOT/wiki/Coding-conventions.
-->

### Contribution description

<!--
Put here the description of your contribution:
- describe which part(s) of RIOT is (are) involved
- if it's a bug fix, describe the bug that it solves and how it is solved
- you can also give more information to reviewers about how to test your changes
-->

This PR fixes the XTIMER_BACKOFF documentation inconsistency detailed in #11522. XTIMER_BACKOFF is used:

https://github.com/RIOT-OS/RIOT/blob/568a3514557fe301aaf8b2413b76c701dac98492/sys/xtimer/xtimer_core.c#L147-L154

https://github.com/RIOT-OS/RIOT/blob/568a3514557fe301aaf8b2413b76c701dac98492/sys/xtimer/xtimer_core.c#L201-L206

in both cases it is used as 'ticks' while in some places documentation insinuates it has 'us' units

### Testing procedure

<!--
Details steps to test your contribution:
- which test/example to compile for which board and is there a 'test' command
- how to know that it was not working/available in master
- the expected success test output
-->

None.

### Issues/PRs references

<!--
Examples: Fixes #1234. See also #5678. Depends on PR #9876.

Please use keywords (e.g., fixes, resolve) with the links to the issues you
resolved, this way they will be automatically closed when your pull request
is merged. See https://help.github.com/articles/closing-issues-using-keywords/.
-->

Part of #11522 

You can view, comment on, or merge this pull request online at:

  https://github.com/RIOT-OS/RIOT/pull/11538

-- Commit Summary --

  * sys/xtimer.h: fix XTIMER_BACKOFF doc

-- File Changes --

    M sys/include/xtimer.h (12)

-- Patch Links --

https://github.com/RIOT-OS/RIOT/pull/11538.patch
https://github.com/RIOT-OS/RIOT/pull/11538.diff

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/11538
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190516/52448f21/attachment-0001.html>


More information about the notifications mailing list