Re: [PATCH 3/4] hwclock: update man page for v2.26 rc

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Jan 8, 2015, at 05:18, JWP wrote:
> +.\" 2015-01-07 J William Piggott
> +.\" Authored new section: DATE-TIME CONFIGURATION.
> +.\" Subsections: Keeping Time..., LOCAL vs UTC, POSIX vs 'RIGHT'.
> +.\" Errata and drop outdated language.
> +.\" Updates for v2.26

Please don't add such changelog stuff to files -- this is what git is for.

> +.\" Included for troff portability.
> +.\" Continuation line for .TP header.
> +.de TQ
> [...]

Is this really needed?  Is there any chance that this new hwclock
will get installed on a legacy Unix system (instead of on a recent
Linux system with complete man macros)?

> +is a tool for accessing the Hardware Clock.  It can: display the
> +Hardware Clock time; set the Hardware Clock to a specified time; set the
> +Hardware Clock from the System Clock; set the System Clock from the
> +Hardware Clock; compensate for Hardware Clock drift; correct the System
> +Clock timescale; set the kernel's timezone, NTP timescale, and epoch
> +(Alpha only); compare the System and Hardware Clocks; and predict future
> +Hardware Clock values based on its drift rate.

Nice.

> +.

Why all these added dots?  No other man page contains them.

> +The following functions are mutually exclusive, only one can be given at
> +a time. If none are given the default is
> +.BR \-\-show .

s/none are/none is/
because at most one may be given.

> -.B hwclock
> +.B \%hwclock

What does \% do?  Why is it not used fully everywhere where
.B hwclock occurs?

> [...]

Too much text to review.  :|

For such a huge change, it would have been nice to keep the
formatting changes and text changes in separate patches.

Benno

-- 
http://www.fastmail.com - mmm... Fastmail...

--
To unsubscribe from this list: send the line "unsubscribe util-linux" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Netdev]     [Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux