[RTEMS Project] #4572: Improve Clarity for New Clock Manager Directives

[RTEMS trac]

#4572: Improve Clarity for New Clock Manager Directives
----------------------------+-----------------------------
  Reporter:  Joel Sherrill  |      Owner:  Sebastian Huber
      Type:  defect         |     Status:  assigned
  Priority:  normal         |  Milestone:  6.1
 Component:  doc            |    Version:  6
  Severity:  normal         |   Keywords:
Blocked By:                 |   Blocking:
----------------------------+-----------------------------
 Looking through the Clock Manager at the new APIs, I noticed that there is
 nothing about what bintime and sbintime are in the "Time and Date Data
 Structures" section. Explaining what these time representations are is
 needed.

 struct timeval and timespec are also not described in "Time and Data Data
 Structures" but this may be OK since they are from C and/or POSIX.

 There is no discussion of what coarse is versus the non-coarse and what
 this means in practice.

 There is no background on what the various clock sources are.

 There may be other similar typos but rtems_clock_get_monotonic() describes
 its sole argument as being of the wrong type.

 Without some background on the various time formats, sources, and
 terminology, the distinction between these APIs and their intended uses is
 impossible to figure out.

--
Ticket URL: <http://devel.rtems.org/ticket/4572>
RTEMS Project <http://www.rtems.org/>
RTEMS Project