[incubator-nuttx] branch master updated: include/nuttx/clock.h: Fix wrong comment

[xi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx.git


The following commit(s) were added to refs/heads/master by this push:
     new f13ee28  include/nuttx/clock.h: Fix wrong comment
f13ee28 is described below

commit f13ee2848d16966338ec19788629024c935084cf
Author: Nathan Hartman <59...@users.noreply.github.com>
AuthorDate: Sun Nov 22 17:08:23 2020 -0500

    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.
---
 include/nuttx/clock.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/nuttx/clock.h b/include/nuttx/clock.h
index ab6f55b..b11b1cf 100644
--- a/include/nuttx/clock.h
+++ b/include/nuttx/clock.h
@@ -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.
  *