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
next prev parent reply other threads:[~2015-01-02 21:15 UTC|newest]
Thread overview: 13+ 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 18:05 ` Richard Cochran
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 6:29 ` Richard Cochran
2015-01-02 16:39 ` Laurent Georget
2015-01-02 18:51 ` Richard Cochran
2015-01-02 21:15 ` Jeff Epler [this message]
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:07 ` [PATCH 2/2] adjtimex.2: Change 'PPM' (parts per million) to 'ppm' Laurent Georget
2015-01-06 15:20 ` Michael Kerrisk (man-pages)
2015-01-06 15:19 ` [PATCH 1/2] adjtimex.2: Clarify the 'ppm scaling' used in struct timex 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@unpythonic.net \
--cc=laurent.georget@supelec.fr \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
--cc=richardcochran@gmail.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox