Linux-man Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] use standard .\" comment style
@ 2020-07-23 21:53 Mike Frysinger
  2020-07-24 10:57 ` Michael Kerrisk (man-pages)
  0 siblings, 1 reply; 2+ messages in thread
From: Mike Frysinger @ 2020-07-23 21:53 UTC (permalink / raw)
  To: Michael Kerrisk; +Cc: linux-man

From: Mike Frysinger <vapier@chromium.org>

The \" comment produces blank lines.  Use the .\" that the vast
majority of the codebase uses instead.

Signed-off-by: Mike Frysinger <vapier@gentoo.org>
---
 man2/keyctl.2          |  8 ++++----
 man2/perf_event_open.2 | 10 +++++-----
 man3/makecontext.3     |  2 +-
 man7/keyrings.7        |  6 +++---
 man7/pid_namespaces.7  |  2 +-
 5 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/man2/keyctl.2 b/man2/keyctl.2
index b758f331bd28..ea954d7fab85 100644
--- a/man2/keyctl.2
+++ b/man2/keyctl.2
@@ -592,9 +592,9 @@ Writing to the buffer is attempted only when
 is non-NULL and the specified buffer size
 is large enough to accept the descriptive string
 (including the terminating null byte).
-'\" Function commentary says it copies up to buflen bytes, but see the
-'\" (buffer && buflen >= ret) condition in keyctl_describe_key() in
-'\" security/keyctl.c
+.\" Function commentary says it copies up to buflen bytes, but see the
+.\" (buffer && buflen >= ret) condition in keyctl_describe_key() in
+.\" security/keyctl.c
 In order to determine whether the buffer size was too small,
 check to see if the return value of the operation is greater than
 .IR arg4 .
@@ -963,7 +963,7 @@ Use the UID-specific session keyring
 as the new default keyring.
 .TP
 .BR KEY_REQKEY_DEFL_REQUESTOR_KEYRING " (since Linux 2.6.29)"
-'\" 8bbf4976b59fc9fc2861e79cab7beb3f6d647640
+.\" 8bbf4976b59fc9fc2861e79cab7beb3f6d647640
 Use the requestor keyring.
 .\" FIXME The preceding explanation needs to be expanded.
 .\" Is the following correct:
diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
index eee3b887074b..2492fc75a815 100644
--- a/man2/perf_event_open.2
+++ b/man2/perf_event_open.2
@@ -2601,7 +2601,7 @@ is a string describing the backing of the allocated memory.
 .RE
 .TP
 .BR PERF_RECORD_AUX " (since Linux 4.1)"
-\" commit 68db7e98c3a6ebe7284b6cf14906ed7c55f3f7f0
+.\" commit 68db7e98c3a6ebe7284b6cf14906ed7c55f3f7f0
 This record reports that new data is available in the separate
 AUX buffer region.
 .IP
@@ -2638,7 +2638,7 @@ if set, then the data returned has overwritten previous data.
 .RE
 .TP
 .BR PERF_RECORD_ITRACE_START " (since Linux 4.1)"
-\" ec0d7729bbaed4b9d2d3fada693278e13a3d1368
+.\" ec0d7729bbaed4b9d2d3fada693278e13a3d1368
 This record indicates which process has initiated an instruction
 trace event, allowing tools to properly correlate the instruction
 addresses in the AUX buffer with the proper executable.
@@ -2661,7 +2661,7 @@ thread ID of the thread starting an instruction trace.
 .RE
 .TP
 .BR PERF_RECORD_LOST_SAMPLES " (since Linux 4.2)"
-\" f38b0dbb491a6987e198aa6b428db8692a6480f8
+.\" f38b0dbb491a6987e198aa6b428db8692a6480f8
 When using hardware sampling (such as Intel PEBS) this record
 indicates some number of samples that may have been lost.
 .IP
@@ -2680,7 +2680,7 @@ the number of potentially lost samples.
 .RE
 .TP
 .BR PERF_RECORD_SWITCH " (since Linux 4.3)"
-\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
+.\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
 This record indicates a context switch has happened.
 The
 .B PERF_RECORD_MISC_SWITCH_OUT
@@ -2698,7 +2698,7 @@ struct {
 .EE
 .TP
 .BR PERF_RECORD_SWITCH_CPU_WIDE " (since Linux 4.3)"
-\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
+.\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
 As with
 .B PERF_RECORD_SWITCH
 this record indicates a context switch has happened,
diff --git a/man3/makecontext.3 b/man3/makecontext.3
index 1d8429fa45db..c311f49f9496 100644
--- a/man3/makecontext.3
+++ b/man3/makecontext.3
@@ -1,4 +1,4 @@
-\" Copyright (C) 2001 Andries Brouwer (aeb@cwi.nl)
+.\" Copyright (C) 2001 Andries Brouwer (aeb@cwi.nl)
 .\" and Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
 .\"
 .\" %%%LICENSE_START(VERBATIM)
diff --git a/man7/keyrings.7 b/man7/keyrings.7
index 0e0bd0a9514a..0983a4da948e 100644
--- a/man7/keyrings.7
+++ b/man7/keyrings.7
@@ -105,9 +105,9 @@ the key is scheduled for garbage collection.
 The kernel provides several basic types of key:
 .TP
 .I """keyring"""
-'\" Note that keyrings use different fields in struct key in order to store
-'\" their data - index_key instead of type/description and name_link/keys
-'\" instead of payload.
+.\" Note that keyrings use different fields in struct key in order to store
+.\" their data - index_key instead of type/description and name_link/keys
+.\" instead of payload.
 Keyrings are special keys which store a set of links
 to other keys (including other keyrings),
 analogous to a directory holding links to files.
diff --git a/man7/pid_namespaces.7 b/man7/pid_namespaces.7
index f2aa25884de3..9d893fcf26c1 100644
--- a/man7/pid_namespaces.7
+++ b/man7/pid_namespaces.7
@@ -262,7 +262,7 @@ namespace that is the
 .I parent
 of the child's PID namespace,
 rather than the "init" process in the child's own PID namespace.
-\" Furthermore, by definition, the parent of the "init" process
+.\" Furthermore, by definition, the parent of the "init" process
 .\" of a PID namespace resides in the parent PID namespace.
 .\"
 .\" ============================================================
-- 
2.26.2


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] use standard .\" comment style
  2020-07-23 21:53 [PATCH] use standard .\" comment style Mike Frysinger
@ 2020-07-24 10:57 ` Michael Kerrisk (man-pages)
  0 siblings, 0 replies; 2+ messages in thread
From: Michael Kerrisk (man-pages) @ 2020-07-24 10:57 UTC (permalink / raw)
  To: Mike Frysinger; +Cc: mtk.manpages, linux-man

Hello Mike,

On 7/23/20 11:53 PM, Mike Frysinger wrote:
> From: Mike Frysinger <vapier@chromium.org>
> 
> The \" comment produces blank lines.  Use the .\" that the vast
> majority of the codebase uses instead.

Thanks. Applied.

Cheers,

Michael

> Signed-off-by: Mike Frysinger <vapier@gentoo.org>
> ---
>  man2/keyctl.2          |  8 ++++----
>  man2/perf_event_open.2 | 10 +++++-----
>  man3/makecontext.3     |  2 +-
>  man7/keyrings.7        |  6 +++---
>  man7/pid_namespaces.7  |  2 +-
>  5 files changed, 14 insertions(+), 14 deletions(-)
> 
> diff --git a/man2/keyctl.2 b/man2/keyctl.2
> index b758f331bd28..ea954d7fab85 100644
> --- a/man2/keyctl.2
> +++ b/man2/keyctl.2
> @@ -592,9 +592,9 @@ Writing to the buffer is attempted only when
>  is non-NULL and the specified buffer size
>  is large enough to accept the descriptive string
>  (including the terminating null byte).
> -'\" Function commentary says it copies up to buflen bytes, but see the
> -'\" (buffer && buflen >= ret) condition in keyctl_describe_key() in
> -'\" security/keyctl.c
> +.\" Function commentary says it copies up to buflen bytes, but see the
> +.\" (buffer && buflen >= ret) condition in keyctl_describe_key() in
> +.\" security/keyctl.c
>  In order to determine whether the buffer size was too small,
>  check to see if the return value of the operation is greater than
>  .IR arg4 .
> @@ -963,7 +963,7 @@ Use the UID-specific session keyring
>  as the new default keyring.
>  .TP
>  .BR KEY_REQKEY_DEFL_REQUESTOR_KEYRING " (since Linux 2.6.29)"
> -'\" 8bbf4976b59fc9fc2861e79cab7beb3f6d647640
> +.\" 8bbf4976b59fc9fc2861e79cab7beb3f6d647640
>  Use the requestor keyring.
>  .\" FIXME The preceding explanation needs to be expanded.
>  .\" Is the following correct:
> diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
> index eee3b887074b..2492fc75a815 100644
> --- a/man2/perf_event_open.2
> +++ b/man2/perf_event_open.2
> @@ -2601,7 +2601,7 @@ is a string describing the backing of the allocated memory.
>  .RE
>  .TP
>  .BR PERF_RECORD_AUX " (since Linux 4.1)"
> -\" commit 68db7e98c3a6ebe7284b6cf14906ed7c55f3f7f0
> +.\" commit 68db7e98c3a6ebe7284b6cf14906ed7c55f3f7f0
>  This record reports that new data is available in the separate
>  AUX buffer region.
>  .IP
> @@ -2638,7 +2638,7 @@ if set, then the data returned has overwritten previous data.
>  .RE
>  .TP
>  .BR PERF_RECORD_ITRACE_START " (since Linux 4.1)"
> -\" ec0d7729bbaed4b9d2d3fada693278e13a3d1368
> +.\" ec0d7729bbaed4b9d2d3fada693278e13a3d1368
>  This record indicates which process has initiated an instruction
>  trace event, allowing tools to properly correlate the instruction
>  addresses in the AUX buffer with the proper executable.
> @@ -2661,7 +2661,7 @@ thread ID of the thread starting an instruction trace.
>  .RE
>  .TP
>  .BR PERF_RECORD_LOST_SAMPLES " (since Linux 4.2)"
> -\" f38b0dbb491a6987e198aa6b428db8692a6480f8
> +.\" f38b0dbb491a6987e198aa6b428db8692a6480f8
>  When using hardware sampling (such as Intel PEBS) this record
>  indicates some number of samples that may have been lost.
>  .IP
> @@ -2680,7 +2680,7 @@ the number of potentially lost samples.
>  .RE
>  .TP
>  .BR PERF_RECORD_SWITCH " (since Linux 4.3)"
> -\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
> +.\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
>  This record indicates a context switch has happened.
>  The
>  .B PERF_RECORD_MISC_SWITCH_OUT
> @@ -2698,7 +2698,7 @@ struct {
>  .EE
>  .TP
>  .BR PERF_RECORD_SWITCH_CPU_WIDE " (since Linux 4.3)"
> -\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
> +.\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
>  As with
>  .B PERF_RECORD_SWITCH
>  this record indicates a context switch has happened,
> diff --git a/man3/makecontext.3 b/man3/makecontext.3
> index 1d8429fa45db..c311f49f9496 100644
> --- a/man3/makecontext.3
> +++ b/man3/makecontext.3
> @@ -1,4 +1,4 @@
> -\" Copyright (C) 2001 Andries Brouwer (aeb@cwi.nl)
> +.\" Copyright (C) 2001 Andries Brouwer (aeb@cwi.nl)
>  .\" and Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
>  .\"
>  .\" %%%LICENSE_START(VERBATIM)
> diff --git a/man7/keyrings.7 b/man7/keyrings.7
> index 0e0bd0a9514a..0983a4da948e 100644
> --- a/man7/keyrings.7
> +++ b/man7/keyrings.7
> @@ -105,9 +105,9 @@ the key is scheduled for garbage collection.
>  The kernel provides several basic types of key:
>  .TP
>  .I """keyring"""
> -'\" Note that keyrings use different fields in struct key in order to store
> -'\" their data - index_key instead of type/description and name_link/keys
> -'\" instead of payload.
> +.\" Note that keyrings use different fields in struct key in order to store
> +.\" their data - index_key instead of type/description and name_link/keys
> +.\" instead of payload.
>  Keyrings are special keys which store a set of links
>  to other keys (including other keyrings),
>  analogous to a directory holding links to files.
> diff --git a/man7/pid_namespaces.7 b/man7/pid_namespaces.7
> index f2aa25884de3..9d893fcf26c1 100644
> --- a/man7/pid_namespaces.7
> +++ b/man7/pid_namespaces.7
> @@ -262,7 +262,7 @@ namespace that is the
>  .I parent
>  of the child's PID namespace,
>  rather than the "init" process in the child's own PID namespace.
> -\" Furthermore, by definition, the parent of the "init" process
> +.\" Furthermore, by definition, the parent of the "init" process
>  .\" of a PID namespace resides in the parent PID namespace.
>  .\"
>  .\" ============================================================
> 


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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, back to index

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-23 21:53 [PATCH] use standard .\" comment style Mike Frysinger
2020-07-24 10:57 ` Michael Kerrisk (man-pages)

Linux-man Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-man/0 linux-man/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-man linux-man/ https://lore.kernel.org/linux-man \
		linux-man@vger.kernel.org
	public-inbox-index linux-man

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-man


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git