[Bug 61171] New: adjtimex(2): incomplete description of the struct timex

[Bug 61171] New: adjtimex(2): incomplete description of the struct timex

[bugzilla-daemon-590EEB7GvNiWaY/ihj7yzEB+6BGkLq7r]

https://bugzilla.kernel.org/show_bug.cgi?id=61171

            Bug ID: 61171
           Summary: adjtimex(2): incomplete description of the struct
                    timex
           Product: Documentation
           Version: unspecified
          Hardware: All
                OS: Linux
            Status: NEW
          Severity: normal
          Priority: P1
         Component: man-pages
          Assignee: documentation_man-pages-ztI5WcYan/vQLgFONoPN62D2FQJk+8+b@public.gmane.org
          Reporter: matwey.kornilov-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
        Regression: No

Hi,

I am using 3.46 release of man-pages under openSUSE 12.3.

man adjtimex(2) says that struct timex has a member:

struct timeval time; /* current time (read-only) */

implying that timeval has two fields: seconds and microseconds (as it described
in many places, for instance GLIBC documentation). This misinforms people, and
explicit behavior must be reported.

Inspection of kernel/time/ntp.c (as for linux 3.7) demonstrates that the second
field timex.time.tv_usec may contain nanoseconds instead of microseconds. When
timex.status STA_NANO flag is not set, this field contains microseconds, as one
expects.

The previous is still also true for timex.offset which is stated to be in units
of usec. Units of offset also depend on STA_NANO flag.

-- 
You are receiving this mail because:
You are watching the assignee of the bug.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Bug 61171] adjtimex(2): incomplete description of the struct timex

[bugzilla-daemon-590EEB7GvNiWaY/ihj7yzEB+6BGkLq7r]

https://bugzilla.kernel.org/show_bug.cgi?id=61171

Tina Johnson <tinajohnson.1234-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |tinajohnson.1234-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org

--- Comment #1 from Tina Johnson <tinajohnson.1234-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> ---
Do you suggest that we edit the man page of adjtimex?

-- 
You are receiving this mail because:
You are watching the assignee of the bug.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Bug 61171] adjtimex(2): incomplete description of the struct timex

[bugzilla-daemon-590EEB7GvNiWaY/ihj7yzEB+6BGkLq7r]

https://bugzilla.kernel.org/show_bug.cgi?id=61171

--- Comment #2 from Matwey V. Kornilov <matwey.kornilov-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> ---
I hope so

2014-06-17 12:48 GMT+04:00  <bugzilla-daemon-590EEB7GvNiWaY/ihj7yzEB+6BGkLq7r@public.gmane.org>:
> https://bugzilla.kernel.org/show_bug.cgi?id=61171
>
> Tina Johnson <tinajohnson.1234-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> changed:
>
>            What    |Removed                     |Added
> ----------------------------------------------------------------------------
>                  CC|                            |tinajohnson.1234-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
>
> --- Comment #1 from Tina Johnson <tinajohnson.1234-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> ---
> Do you suggest that we edit the man page of adjtimex?
>
> --
> You are receiving this mail because:
> You reported the bug.

-- 
You are receiving this mail because:
You are watching the assignee of the bug.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Bug 61171] adjtimex(2): incomplete description of the struct timex

[bugzilla-daemon-590EEB7GvNiWaY/ihj7yzEB+6BGkLq7r]

https://bugzilla.kernel.org/show_bug.cgi?id=61171

--- Comment #3 from Tina Johnson <tinajohnson.1234-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> ---
Created attachment 140071
  --> https://bugzilla.kernel.org/attachment.cgi?id=140071&action=edit
Added information about variables of timeval structure and different units of
time used by them

Hope this is the required patch.

-- 
You are receiving this mail because:
You are watching the assignee of the bug.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Bug 61171] adjtimex(2): incomplete description of the struct timex

[bugzilla-daemon-590EEB7GvNiWaY/ihj7yzEB+6BGkLq7r]

https://bugzilla.kernel.org/show_bug.cgi?id=61171

--- Comment #4 from Michael Kerrisk <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> ---
Matwey, thanks for the report. Tina, thanks for the patch.

The bigger problem is that the adjtimex(2) is hugely out of date, and in any
case very thin on the details. The nanosecond aspect is rather more complex
than is captured in the patch, as far as I can see. I will work on some updates
to the page.

-- 
You are receiving this mail because:
You are watching the assignee of the bug.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Bug 61171] adjtimex(2): incomplete description of the struct timex

[bugzilla-daemon-590EEB7GvNiWaY/ihj7yzEB+6BGkLq7r]

https://bugzilla.kernel.org/show_bug.cgi?id=61171

Michael Kerrisk <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|---                         |CODE_FIX

--- Comment #5 from Michael Kerrisk <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> ---
Some months ago, I made same changes to the man page which I think should cover
the concerns in this report. So, closing now.

-- 
You are receiving this mail because:
You are watching the assignee of the bug.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html