include/nuttx/clock.h: Fix wrong comment

include/nuttx/clock.h:

    * USEC_PER_TICK: The docstring for this define mistakenly said
      that the default value of USEC_PER_TICK, 10000, corresponded
      to 100 KHz. However, it is actually 100 Hz. Corrected the
      comment. No functional changes.
This commit is contained in:
Nathan Hartman 2020-11-22 17:08:23 -05:00 committed by Xiang Xiao
parent 8e8ead3224
commit f13ee2848d
1 changed files with 1 additions and 1 deletions

View File

@ -124,7 +124,7 @@
* the system timer is given by USEC_PER_TICK. This is the expected number
* of microseconds between calls from the processor-specific logic to
* nxsched_process_timer(). The default value of USEC_PER_TICK is 10000
* microseconds (100KHz). However, this default setting can be overridden
* microseconds (100 Hz). However, this default setting can be overridden
* by defining the interval in microseconds as CONFIG_USEC_PER_TICK in the
* NuttX configuration file.
*