Re: [PATCH] man2/a-z.2: srcfix: print punctuation marks with a regular style

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

 



Hello Bjarni,


On 2/3/19 4:36 AM, Bjarni Ingi Gislason wrote:
>   Print punctuation marks (",.) with a regular style.

But, they aren't punctuation marks, as such. The whole sequence
"..." is a value. It doesn't seem wrong to me to have the quote
characters formatted. It isn't I common style in the manual pages,
but on a quick search, I could not find other cases where it was 
inconsistent either.

Thanks,

Michael


>   The output from "nroff" and "groff" is unchanged, except for the style
> changes of some punctuation marks.
> 
> Signed-off-by: Bjarni Ingi Gislason <bjarniig@xxxxxxxxx>
> ---
>  man2/add_key.2     | 18 +++++++++---------
>  man2/keyctl.2      |  4 ++--
>  man2/request_key.2 |  6 +++---
>  3 files changed, 14 insertions(+), 14 deletions(-)
> 
> diff --git a/man2/add_key.2 b/man2/add_key.2
> index dcb2026d7..5aafe6eb7 100644
> --- a/man2/add_key.2
> +++ b/man2/add_key.2
> @@ -98,7 +98,7 @@ argument to
>  .BR add_key ()
>  are the following:
>  .TP
> -.I """keyring"""
> +.RI """" keyring """"
>  Keyrings are special key types that may contain links to sequences of other
>  keys of any type.
>  If this interface is used to create a keyring, then
> @@ -107,17 +107,17 @@ should be NULL and
>  .I plen
>  should be zero.
>  .TP
> -.I """user"""
> +.RI """" user """"
>  This is a general purpose key type whose payload may be read and updated
>  by user-space applications.
>  The key is kept entirely within kernel memory.
>  The payload for keys of this type is a blob of arbitrary data
>  of up to 32,767 bytes.
>  .TP
> -.IR """logon""" " (since Linux 3.3)"
> +.RI """" logon """ (since Linux 3.3)"
>  .\" commit 9f6ed2ca257fa8650b876377833e6f14e272848b
>  This key type is essentially the same as
> -.IR """user""" ,
> +.RI """" user ""","
>  but it does not permit the key to read.
>  This is suitable for storing payloads
>  that you do not want to be readable from user space.
> @@ -129,10 +129,10 @@ by checking to ensure that the
>  .I description
>  contains a ':' that is preceded by other characters.
>  .TP
> -.IR """big_key""" " (since Linux 3.13)"
> +.RI """" big_key """ (since Linux 3.13)"
>  .\" commit ab3c3587f8cda9083209a61dbe3a4407d3cada10
>  This key type is similar to
> -.IR """user""" ,
> +.RI """" user ""","
>  but may hold a payload of up to 1\ MiB.
>  If the key payload is large enough,
>  then it may be stored encrypted in tmpfs
> @@ -177,11 +177,11 @@ The payload data was invalid.
>  .B EINVAL
>  .I type
>  was
> -.I """logon"""
> +.RI """" logon """"
>  and the
>  .I description
>  was not qualified with a prefix string of the form
> -.IR """service:""" .
> +.RI """" service: """."
>  .TP
>  .B EKEYEXPIRED
>  The keyring has expired.
> @@ -204,7 +204,7 @@ Key types that begin with a period are reserved to the implementation.
>  .B EPERM
>  .I type
>  was
> -.I """keyring"""
> +.RI """" keyring """"
>  and the
>  .I description
>  started with a period (\(aq.\(aq).
> diff --git a/man2/keyctl.2 b/man2/keyctl.2
> index 69df345cb..23c8517db 100644
> --- a/man2/keyctl.2
> +++ b/man2/keyctl.2
> @@ -1424,7 +1424,7 @@ The
>  .I arg2
>  argument is a pointer to a set of parameters containing
>  serial numbers for three
> -.I """user"""
> +.RI """" user """"
>  keys used in the Diffie-Hellman calculation,
>  packaged in a structure of the following form:
>  .IP
> @@ -1898,7 +1898,7 @@ was
>  .B KEYCTL_READ
>  and the key type does not support reading
>  (e.g., the type is
> -.IR """login""" ).
> +.RI """" login """)."
>  .TP
>  .B EOPNOTSUPP
>  .I operation
> diff --git a/man2/request_key.2 b/man2/request_key.2
> index c24a92e5a..78e7325e1 100644
> --- a/man2/request_key.2
> +++ b/man2/request_key.2
> @@ -232,7 +232,7 @@ The authorization key is constructed as follows:
>  .RS
>  .IP * 3
>  The key type is
> -.IR """.request_key_auth""" .
> +.RI """" .request_key_auth """."
>  .IP *
>  The key's UID and GID are the same as the corresponding filesystem IDs
>  of the requesting process.
> @@ -268,10 +268,10 @@ This program is supplied with the following command-line arguments:
>  .RS
>  .IP [0] 4
>  The string
> -.IR """/sbin/request-key""" .
> +.RI """" /sbin/request-key """."
>  .IP [1]
>  The string
> -.I """create"""
> +.RI """" create """"
>  (indicating that a key is to be created).
>  .IP [2]
>  The ID of the key that is to be instantiated.
> 


-- 
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