use standard .\" comment style
PATCH 1/1 use standard .\" comment style
From: Mike Frysinger <[email protected]>
The \" comment produces blank lines. Use the .\" that the vast majority of the codebase uses instead.
Signed-off-by Mike Frysinger <[email protected]>
--- 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(-)
man2/keyctl.2 +4 -4
@@ -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:
man2/perf_event_open.2 +5 -5
@@ -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,
man3/makecontext.3 +1 -1
@@ -1,4 +1,4 @@ -\" Copyright (C) 2001 Andries Brouwer ([email protected]) +.\" Copyright (C) 2001 Andries Brouwer ([email protected]) .\" and Copyright (C) 2006 Michael Kerrisk <[email protected]> .\" .\" %%%LICENSE_START(VERBATIM)
man7/keyrings.7 +3 -3
@@ -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.
man7/pid_namespaces.7 +1 -1
@@ -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. .\" .\" ============================================================
Signature · 1 line
2.26.2
Hello Mike,
Quoted 4 lines · Mike Frysinger
From: Mike Frysinger <[email protected]>
The \" comment produces blank lines. Use the .\" that the vast majority of the codebase uses instead.
Thanks. Applied.
Cheers,
Michael
Quoted 125 lines
Signed-off-by Mike Frysinger <[email protected]>--- 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(-)man2/keyctl.2 +4
-4@@ -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:man2/perf_event_open.2 +5
-5@@ -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,man3/makecontext.3 +1
-1@@ -1,4 +1,4 @@ -\" Copyright (C) 2001 Andries Brouwer ([email protected]) +.\" Copyright (C) 2001 Andries Brouwer ([email protected]) .\" and Copyright (C) 2006 Michael Kerrisk <[email protected]> .\" .\" %%%LICENSE_START(VERBATIM)man7/keyrings.7 +3
-3@@ -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.man7/pid_namespaces.7 +1
-1@@ -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. .\" .\" ============================================================
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/