Re: [PATCH 2/2] adjtimex.2: Change 'PPM' (parts per million) to 'ppm'

["Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>]

On 01/03/2015 12:07 AM, Laurent Georget wrote:
> Hi again,
> 
> this is the second patch of the new series of patchs for adjtimex.2. 
> 
> This is a trivia patch correcting "PPM" (parts per million) to 
> the more usual "ppm".
> Credits to Jeff Epler <jepler@unpythonic.net>.

Thanks, Laurent (andf Jeff). Patch applied.

Laurent, please watch out: your patches are injecting trailing
white space on lines. My release scripts clean those up, but
it means that patches apply with "noise".

Cheers,

Michael

> 
> ---
>  man2/adjtimex.2 | 15 +++++++--------
>  1 file changed, 7 insertions(+), 8 deletions(-)
> 
> diff --git a/man2/adjtimex.2 b/man2/adjtimex.2
> index ff4b23e..dbb2333 100644
> --- a/man2/adjtimex.2
> +++ b/man2/adjtimex.2
> @@ -54,7 +54,7 @@ struct timex {
>      long offset;      /* Time offset; nanoseconds, if STA_NANO
>                           status flag is set, otherwise
>                           microseconds */
> -    long freq;        /* Frequency offset, in units of 2^-16 PPM
> +    long freq;        /* Frequency offset, in units of 2^-16 ppm
>                           (parts per million) (see NOTES below) */
>      long maxerror;    /* Maximum error (microseconds) */
>      long esterror;    /* Estimated error (microseconds) */
> @@ -62,8 +62,7 @@ struct timex {
>      long constant;    /* PLL (phase-locked loop) time constant */
>      long precision;   /* Clock precision (microseconds,
>                           read-only) */
> -    long tolerance;   /* Clock frequency tolerance (PPM,
> -                         read-only) */
> +    long tolerance;   /* Clock frequency tolerance (ppm, read-only) */
>      struct timeval time;
>                        /* Current time (read-only, except for
>                           ADJ_SETOFFSET); upon return, time.tv_usec
> @@ -71,13 +70,13 @@ struct timex {
>                           flag is set, otherwise microseconds */
>      long tick;        /* Microseconds between clock ticks */
>      long ppsfreq;     /* PPS (pulse per second) frequency
> -                         (2^-16 PPM (see NOTES), read-only) */
> +                         (2^-16 ppm (see NOTES), read-only) */
>      long jitter;      /* PPS jitter (read-only); nanoseconds, if
>                           STA_NANO status flag is set, otherwise
>                           microseconds */
>      int  shift;       /* PPS interval duration
>                           (seconds, read-only) */
> -    long stabil;      /* PPS stability (2^-16 PPM (see NOTES), read-only) */
> +    long stabil;      /* PPS stability (2^-16 ppm (see NOTES), read-only) */
>      long jitcnt;      /* PPS jitter limit exceeded (read-only) */
>      long calcnt;      /* PPS calibration intervals (read-only) */
>      long errcnt;      /* PPS calibration errors (read-only) */
> @@ -349,9 +348,9 @@ In struct
>  .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
> +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.
>  .SH CONFORMING TO
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/