[patch] document CLOCK_MONOTONIC_COARSE

[patch] document CLOCK_MONOTONIC_COARSE

[Andy Isaacson]

Let's try that again without using gmail.

-andy

commit 782f8fd7a4ecd601d46e13e6a55a04662bae2f27
Author: Andy Isaacson <adi-psgPW5cihnJWk0Htik3J/w@public.gmane.org>
Date:   Thu May 31 16:36:30 2012 -0700

    clock_getres.2: document CLOCK_MONOTONIC_COARSE

diff --git a/man2/clock_getres.2 b/man2/clock_getres.2
index 67713c7..01289d6 100644
--- a/man2/clock_getres.2
+++ b/man2/clock_getres.2
@@ -136,6 +136,13 @@ Similar to
 but provides access to a raw hardware-based time
 that is not subject to NTP adjustments.
 .TP
+.BR CLOCK_MONOTONIC_COARSE " (since Linux 2.6.32; Linux-specific)"
+.\" Added in commit da15cfdae03351c689736f8d142618592e3cebc3, John Stultz, Aug 19 2009
+Similar to
+.BR CLOCK_MONOTONIC ,
+but provides only the time at the most recent clock tick.  This can be
+faster to access.
+.TP
 .B CLOCK_PROCESS_CPUTIME_ID
 High-resolution per-process timer from the CPU.
 .TP
--
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

Re: [patch] document CLOCK_MONOTONIC_COARSE

[Alexandre Bique]

On Fri, Jun 1, 2012 at 1:59 AM, Andy Isaacson <adi-psgPW5cihnJWk0Htik3J/w@public.gmane.org> wrote:
> +.BR CLOCK_MONOTONIC_COARSE " (since Linux 2.6.32; Linux-specific)"
> +.\" Added in commit da15cfdae03351c689736f8d142618592e3cebc3, John Stultz, Aug 19 2009

Is it necessary to specify the commit rev?

-- 
Alexandre Bique
--
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

Re: [patch] document CLOCK_MONOTONIC_COARSE

[Andy Isaacson]

On Sat, Jun 2, 2012 at 2:49 AM, Alexandre Bique
<bique.alexandre-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> On Fri, Jun 1, 2012 at 1:59 AM, Andy Isaacson <adi-psgPW5cihnJWk0Htik3J/w@public.gmane.org> wrote:
> > +.BR CLOCK_MONOTONIC_COARSE " (since Linux 2.6.32; Linux-specific)"
> > +.\" Added in commit da15cfdae03351c689736f8d142618592e3cebc3, John Stultz, Aug 19 2009
>
> Is it necessary to specify the commit rev?

Speaking as a git user, it's much more helpful to provide the commitID
than to just provide committer+date as was done for other items in
this file.  It allows "git tag --contains da15cfdae" to find out what
release it was merged in, for example.

Is there any downside to having the commit hash in the comment?

-andy
--
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

Re: [patch] document CLOCK_MONOTONIC_COARSE

[Alexandre Bique]

On Mon, Jun 4, 2012 at 8:02 PM, Andy Isaacson <adi-psgPW5cihnJWk0Htik3J/w@public.gmane.org> wrote:
> On Sat, Jun 2, 2012 at 2:49 AM, Alexandre Bique
> <bique.alexandre-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
>> On Fri, Jun 1, 2012 at 1:59 AM, Andy Isaacson <adi-psgPW5cihnJWk0Htik3J/w@public.gmane.org> wrote:
>> > +.BR CLOCK_MONOTONIC_COARSE " (since Linux 2.6.32; Linux-specific)"
>> > +.\" Added in commit da15cfdae03351c689736f8d142618592e3cebc3, John Stultz, Aug 19 2009
>>
>> Is it necessary to specify the commit rev?
>
> Speaking as a git user, it's much more helpful to provide the commitID
> than to just provide committer+date as was done for other items in
> this file.  It allows "git tag --contains da15cfdae" to find out what
> release it was merged in, for example.
>
> Is there any downside to having the commit hash in the comment?

I agree with you, it is convenient to have the commit revision when
you need to dig into Linux source code.

-- 
Alexandre Bique
--
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