All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jeff Epler <jepler-ixP+gI44yfQ4d9/VWYMlNA@public.gmane.org>
To: Laurent Georget
	<laurent.georget-vbcOdlJ0SulGWvitb5QawA@public.gmane.org>
Cc: Richard Cochran
	<richardcochran-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>,
	linux-man <linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	"Michael Kerrisk (man-pages)"
	<mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
Subject: Re: [PATCH] adjtimex: PPM scaling is by 2^-16
Date: Fri, 2 Jan 2015 15:15:21 -0600	[thread overview]
Message-ID: <20150102211519.GA55815@unpythonic.net> (raw)
In-Reply-To: <54A6C9B5.4050904-vbcOdlJ0SulGWvitb5QawA@public.gmane.org>

On Fri, Jan 02, 2015 at 05:39:17PM +0100, Laurent Georget wrote:
> +    long freq;        /* Frequency offset, in units of 2^-16 PPM
> +                         (parts per million) (see NOTES below) */
...
> +.SH NOTES
> +In struct
> +.IR timex ,
> +.IR freq ,
> +.IR ppsfreq ,
> +and
> +.I stabil
> +are PPM (parts per million) with a 16-bits fractional part, which means that a
> +value of 1 in one of those fields actually means 2^-16 PPM, and 2^16=65535 is
> +1 PPM. This is the case for both input values (in the case of
> +.IR freq )
> +and output values.

I appreciate the addition of the NOTES section, this is likely to be
unclear to first-time readers and that section should clear it up
nicely.  Giving the definition of PPM as "parts per million" is good
too.

However, the patch got line-wrapped again (I fixed it manually above).
With line-wrapped fix, consider it

Reviewed-by: Jeff Epler <jepler-ixP+gI44yfQ4d9/VWYMlNA@public.gmane.org>

hm, as a separate issue, "ppm" seems to typically be written in
lowercase.  see e.g., http://en.wikipedia.org/wiki/Parts-per_notation

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

WARNING: multiple messages have this Message-ID (diff)
From: Jeff Epler <jepler@unpythonic.net>
To: Laurent Georget <laurent.georget@supelec.fr>
Cc: Richard Cochran <richardcochran@gmail.com>,
	linux-man <linux-man@vger.kernel.org>,
	linux-kernel@vger.kernel.org,
	"Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
Subject: Re: [PATCH] adjtimex: PPM scaling is by 2^-16
Date: Fri, 2 Jan 2015 15:15:21 -0600	[thread overview]
Message-ID: <20150102211519.GA55815@unpythonic.net> (raw)
In-Reply-To: <54A6C9B5.4050904@supelec.fr>

On Fri, Jan 02, 2015 at 05:39:17PM +0100, Laurent Georget wrote:
> +    long freq;        /* Frequency offset, in units of 2^-16 PPM
> +                         (parts per million) (see NOTES below) */
...
> +.SH NOTES
> +In struct
> +.IR timex ,
> +.IR freq ,
> +.IR ppsfreq ,
> +and
> +.I stabil
> +are PPM (parts per million) with a 16-bits fractional part, which means that a
> +value of 1 in one of those fields actually means 2^-16 PPM, and 2^16=65535 is
> +1 PPM. This is the case for both input values (in the case of
> +.IR freq )
> +and output values.

I appreciate the addition of the NOTES section, this is likely to be
unclear to first-time readers and that section should clear it up
nicely.  Giving the definition of PPM as "parts per million" is good
too.

However, the patch got line-wrapped again (I fixed it manually above).
With line-wrapped fix, consider it

Reviewed-by: Jeff Epler <jepler@unpythonic.net>

hm, as a separate issue, "ppm" seems to typically be written in
lowercase.  see e.g., http://en.wikipedia.org/wiki/Parts-per_notation

Jeff

  parent reply	other threads:[~2015-01-02 21:15 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-12-30 17:19 [PATCH] adjtimex.2: Add details about ADJ_FREQUENCY Laurent Georget
2014-12-30 17:19 ` Laurent Georget
     [not found] ` <54A2DEAD.2050708-vbcOdlJ0SulGWvitb5QawA@public.gmane.org>
2014-12-30 18:05   ` Richard Cochran
2014-12-30 18:05     ` Richard Cochran
     [not found]     ` <20141230180549.GB7403-bi+AKbBUZKY6gyzm1THtWbp2dZbC/Bob@public.gmane.org>
2014-12-30 18:47       ` Laurent Georget
2014-12-30 18:47         ` Laurent Georget
2015-01-02  2:41   ` [PATCH] adjtimex: PPM scaling is by 2^-16 Jeff Epler
2015-01-02  2:41     ` Jeff Epler
2015-01-02  6:29     ` Richard Cochran
     [not found]       ` <20150102062920.GB4221-bi+AKbBUZKY6gyzm1THtWbp2dZbC/Bob@public.gmane.org>
2015-01-02 16:39         ` Laurent Georget
2015-01-02 16:39           ` Laurent Georget
     [not found]           ` <54A6C9B5.4050904-vbcOdlJ0SulGWvitb5QawA@public.gmane.org>
2015-01-02 18:51             ` Richard Cochran
2015-01-02 18:51               ` Richard Cochran
2015-01-02 21:15             ` Jeff Epler [this message]
2015-01-02 21:15               ` Jeff Epler
     [not found]               ` <20150102211519.GA55815-ixP+gI44yfQ4d9/VWYMlNA@public.gmane.org>
2015-01-02 22:48                 ` Laurent Georget
2015-01-02 22:48                   ` Laurent Georget
2015-01-02 23:01   ` [PATCH 1/2] adjtimex.2: Clarify the 'ppm scaling' used in struct timex Laurent Georget
2015-01-02 23:01     ` Laurent Georget
2015-01-02 23:07     ` [PATCH 2/2] adjtimex.2: Change 'PPM' (parts per million) to 'ppm' Laurent Georget
     [not found]       ` <54A724BE.8050409-vbcOdlJ0SulGWvitb5QawA@public.gmane.org>
2015-01-06 15:20         ` Michael Kerrisk (man-pages)
2015-01-06 15:20           ` Michael Kerrisk (man-pages)
     [not found]           ` <54ABFD54.9000705-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2015-01-06 15:42             ` Laurent Georget
     [not found]               ` <54AC0250.5080005-vbcOdlJ0SulGWvitb5QawA@public.gmane.org>
2015-01-07  5:59                 ` Michael Kerrisk (man-pages)
     [not found]                   ` <54ACCB28.50100-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2015-01-08 16:29                     ` Laurent Georget
     [not found]     ` <54A72360.3070807-vbcOdlJ0SulGWvitb5QawA@public.gmane.org>
2015-01-06 15:19       ` [PATCH 1/2] adjtimex.2: Clarify the 'ppm scaling' used in struct timex Michael Kerrisk (man-pages)
2015-01-06 15:19         ` Michael Kerrisk (man-pages)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20150102211519.GA55815@unpythonic.net \
    --to=jepler-ixp+gi44yfq4d9/vwymlna@public.gmane.org \
    --cc=laurent.georget-vbcOdlJ0SulGWvitb5QawA@public.gmane.org \
    --cc=linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
    --cc=richardcochran-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.