Re: [PATCH] man2/a*: tfix, use a one-font macro for a single argument

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

 



Hello Bjarni,

On Mon, 24 Dec 2018 at 01:43, Bjarni Ingi Gislason <bjarniig@xxxxxxxxx> wrote:
>
>   Changes to the git repository "man-pages" from Saturday 22th December
> 2018.
>
>   Use a single capital font macro for a genuine single argument.
>   The output is unchanged.

You've sent several patches along these lines, but you've not
explained why you propose the changes. Is it just general tidiness? I
can see that argument, but given that the output is unchanged, I'm
also reluctant to make such changes because of churn that may
invalidate other pending patches. Tell me some more about the
rationale for these patches please.

Cheers,

Michael

> Signed-off-by: Bjarni Ingi Gislason <bjarniig@xxxxxxxxx>
> ---
>  man2/accept.2   |  8 ++++----
>  man2/access.2   |  4 ++--
>  man2/adjtimex.2 | 44 ++++++++++++++++++++++----------------------
>  3 files changed, 28 insertions(+), 28 deletions(-)
>
> diff --git a/man2/accept.2 b/man2/accept.2
> index 3c6b276e0..17f12c92a 100644
> --- a/man2/accept.2
> +++ b/man2/accept.2
> @@ -119,7 +119,7 @@ If the socket is marked
>  nonblocking and no pending connections are present on the queue,
>  .BR accept ()
>  fails with the error
> -.BR EAGAIN
> +.B EAGAIN
>  or
>  .BR EWOULDBLOCK .
>  .PP
> @@ -139,18 +139,18 @@ when activity occurs on a socket; see
>  for details.
>  .PP
>  If
> -.IR flags
> +.I flags
>  is 0, then
>  .BR accept4 ()
>  is the same as
>  .BR accept ().
>  The following values can be bitwise ORed in
> -.IR flags
> +.I flags
>  to obtain different behavior:
>  .TP 16
>  .B SOCK_NONBLOCK
>  Set the
> -.BR O_NONBLOCK
> +.B O_NONBLOCK
>  file status flag on the open file description (see
>  .BR open (2))
>  referred to by the new file descriptor.
> diff --git a/man2/access.2 b/man2/access.2
> index 2778c8e2c..8b97d7fce 100644
> --- a/man2/access.2
> +++ b/man2/access.2
> @@ -364,9 +364,9 @@ When
>  .I pathname
>  is a relative pathname,
>  glibc constructs a pathname based on the symbolic link in
> -.IR /proc/self/fd
> +.I /proc/self/fd
>  that corresponds to the
> -.IR dirfd
> +.I dirfd
>  argument.
>  .SH BUGS
>  In kernel 2.4 (and earlier) there is some strangeness in the handling of
> diff --git a/man2/adjtimex.2 b/man2/adjtimex.2
> index 4043a20d4..5390df836 100644
> --- a/man2/adjtimex.2
> +++ b/man2/adjtimex.2
> @@ -106,7 +106,7 @@ It is a bit mask containing a
>  .RI bitwise- or
>  combination of zero or more of the following bits:
>  .TP
> -.BR ADJ_OFFSET
> +.B ADJ_OFFSET
>  Set time offset from
>  .IR buf.offset .
>  Since Linux 2.6.26,
> @@ -116,7 +116,7 @@ In older kernels, an
>  .B EINVAL
>  error occurs if the supplied value is out of range.
>  .TP
> -.BR ADJ_FREQUENCY
> +.B ADJ_FREQUENCY
>  Set frequency offset from
>  .IR buf.freq .
>  Since Linux 2.6.26,
> @@ -126,20 +126,20 @@ In older kernels, an
>  .B EINVAL
>  error occurs if the supplied value is out of range.
>  .TP
> -.BR ADJ_MAXERROR
> +.B ADJ_MAXERROR
>  Set maximum time error from
>  .IR buf.maxerror .
>  .TP
> -.BR ADJ_ESTERROR
> +.B ADJ_ESTERROR
>  Set estimated time error from
>  .IR buf.esterror .
>  .TP
> -.BR ADJ_STATUS
> +.B ADJ_STATUS
>  Set clock status bits from
>  .IR buf.status .
>  A description of these bits is provided below.
>  .TP
> -.BR ADJ_TIMECONST
> +.B ADJ_TIMECONST
>  Set PLL time constant from
>  .IR buf.constant .
>  If the
> @@ -171,9 +171,9 @@ Select microsecond resolution.
>  .\" Author: Roman Zippel <zippel@xxxxxxxxxxxxxx>
>  Select nanosecond resolution.
>  Only one of
> -.BR ADJ_MICRO
> +.B ADJ_MICRO
>  and
> -.BR ADJ_NANO
> +.B ADJ_NANO
>  should be specified.
>  .TP
>  .BR ADJ_TAI " (since Linux 2.6.26)"
> @@ -181,11 +181,11 @@ should be specified.
>  Set TAI (Atomic International Time) offset from
>  .IR buf.constant .
>  .IP
> -.BR ADJ_TAI
> +.B ADJ_TAI
>  should not be used in conjunction with
>  .BR ADJ_TIMECONST ,
>  since the latter mode also employs the
> -.IR buf.constant
> +.I buf.constant
>  field.
>  .IP
>  For a complete explanation of TAI
> @@ -194,7 +194,7 @@ and the difference between TAI and UTC, see
>  .I BIPM
>  .UE
>  .TP
> -.BR ADJ_TICK
> +.B ADJ_TICK
>  Set tick value from
>  .IR buf.tick .
>  .PP
> @@ -206,7 +206,7 @@ in which case other bits should not be specified in
>  .\" In general, the other bits are ignored, but ADJ_OFFSET_SINGLESHOT 0x8001
>  .\" ORed with ADJ_NANO (0x2000) gives 0xa0001 == ADJ_OFFSET_SS_READ!!
>  .TP
> -.BR ADJ_OFFSET_SINGLESHOT
> +.B ADJ_OFFSET_SINGLESHOT
>  .\" In user space, ADJ_OFFSET_SINGLESHOT is 0x8001
>  .\" In kernel space it is 0x0001, and must be ANDed with ADJ_ADJTIME (0x8000)
>  Old-fashioned
> @@ -222,7 +222,7 @@ which specifies an adjustment in microseconds.
>  Return (in
>  .IR buf.offset )
>  the remaining amount of time to be adjusted after an earlier
> -.BR ADJ_OFFSET_SINGLESHOT
> +.B ADJ_OFFSET_SINGLESHOT
>  operation.
>  This feature was added in Linux 2.6.24,
>  .\" commit 52bfb36050c8529d9031d2c2513b281a360922ec
> @@ -361,11 +361,11 @@ are prefixed with "MOD_" rather than "ADJ_", and have the same suffixes (thus,
>  .BR MOD_FREQUENCY ,
>  and so on), other than the exceptions noted in the following points.
>  .IP *
> -.BR MOD_CLKA
> +.B MOD_CLKA
>  is the synonym for
>  .BR ADJ_OFFSET_SINGLESHOT .
>  .IP *
> -.BR MOD_CLKB
> +.B MOD_CLKB
>  is the synonym for
>  .BR ADJ_TICK .
>  .IP *
> @@ -379,29 +379,29 @@ and
>  .BR ntp_adjtime ()
>  return the clock state; that is, one of the following values:
>  .TP 12
> -.BR TIME_OK
> +.B TIME_OK
>  Clock synchronized, no leap second adjustment pending.
>  .TP
> -.BR TIME_INS
> +.B TIME_INS
>  Indicates that a leap second will be added at the end of the UTC day.
>  .TP
> -.BR TIME_DEL
> +.B TIME_DEL
>  Indicates that a leap second will be deleted at the end of the UTC day.
>  .TP
> -.BR TIME_OOP
> +.B TIME_OOP
>  Insertion of a leap second is in progress.
>  .TP
> -.BR TIME_WAIT
> +.B TIME_WAIT
>  A leap-second insertion or deletion has been completed.
>  This value will be returned until the next
> -.BR ADJ_STATUS
> +.B ADJ_STATUS
>  operation clears the
>  .B STA_INS
>  and
>  .B STA_DEL
>  flags.
>  .TP
> -.BR TIME_ERROR
> +.B TIME_ERROR
>  The system clock is not synchronized to a reliable server.
>  This value is returned when any of the following holds true:
>  .RS
> --
> 2.19.2
>
> --
> Bjarni I. Gislason



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



[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux 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