Re: [PATCH 4/4] docs: improve wording and formattin of man page of hwclock

[Benno Schulenberg <bensberg@justemail.net>]

On Tue, Oct 28, 2014, at 02:09, JWP wrote:
> On 10/27/2014 05:18 PM, Benno Schulenberg wrote:
> >  Since v2.26
> >  .B hwclock
> >  does not update the Hardware Clock's drift factor in @ADJTIME_PATH@ by default.
> > -It is necessary to use \fB\-\-update-drift\fR, with \fB\-\-set\fR or
> > +It is necessary to use the option \fB\-\-update-drift\fR, with \fB\-\-set\fR or
> >  \fB\-\-systohc\fR, to force drift factor updates.
> 
> The rest of the manual uses 'the --xxxx option'.

Well, I can't explain, but in this case "the option --xxxx" is better.

> >  Since v2.26
> >  .B hwclock \-\-hctosys
> > -automatically compensates time read from the Hardware Clock to account for
> > -systematic drift before using it to set the System Clock.  Therefore,
> > -\fB\-\-adjust\fR is no longer necessary during boot. This functionality makes
> > -hwclock usable early in the boot process when the root filesystem is read-only.
> > +automatically takes a systematic drift of the Hardware Clock into account,
> > +setting the System Clock to the drift-compensated time.  Therefore the option
> > +\fB\-\-adjust\fR is no longer necessary during boot.  This feature makes
> > +.B hwclock
> > +usable early on in the boot process when the root filesystem is read-only.
> 
> "a systematic drift"? That entire phrase does not sound natural to me.

:|

> I think it is important to
> stress that *the_time_read* from the Clock is what is being compensated as this is
> a new behavior.

Well, then suggest how exactly to phrase that.

Benno

-- 
http://www.fastmail.fm - Or how I learned to stop worrying and
                          love email again