diff mbox series

libtracefs: Fix libtracefs-instance-affinity.txt document

Message ID 20220119111901.0a18aa2c@gandalf.local.home (mailing list archive)
State Accepted
Commit 085a4841bd314e8e24fa841efc4cd6dadb671715
Headers show
Series libtracefs: Fix libtracefs-instance-affinity.txt document | expand

Commit Message

Steven Rostedt Jan. 19, 2022, 4:19 p.m. UTC
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>

The building of the Documentation directory errors with:

  DESCEND            Documentation all
  ASCIIDOC libtracefs-instances-affinity.html
asciidoc: ERROR: libtracefs-instances-affinity.txt: line 8: malformed name section body
asciidoc: FAILED: libtracefs-instances-affinity.txt: line 8: unexpected error:
asciidoc: ------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/asciidoc/asciidoc.py", line 6081, in asciidoc
    document.translate(has_header)  # Generate the output.
  File "/usr/lib/python3/dist-packages/asciidoc/asciidoc.py", line 1380, in translate
    self.attributes['manname'] = mo.group('manname').strip()
AttributeError: 'NoneType' object has no attribute 'group'
make[1]: *** [Makefile:237: libtracefs-instances-affinity.html] Error 1
make: *** [Makefile:286: doc] Error 2

This was due to a cut and paste error and the first line did not have a
hyphen for the description of the man page.

Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
 Documentation/libtracefs-instances-affinity.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Krzysztof Kozlowski Jan. 24, 2022, 9:50 a.m. UTC | #1
On 19/01/2022 17:19, Steven Rostedt wrote:
> From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
> 
> The building of the Documentation directory errors with:
> 
>   DESCEND            Documentation all
>   ASCIIDOC libtracefs-instances-affinity.html
> asciidoc: ERROR: libtracefs-instances-affinity.txt: line 8: malformed name section body
> asciidoc: FAILED: libtracefs-instances-affinity.txt: line 8: unexpected error:
> asciidoc: ------------------------------------------------------------
> Traceback (most recent call last):
>   File "/usr/lib/python3/dist-packages/asciidoc/asciidoc.py", line 6081, in asciidoc
>     document.translate(has_header)  # Generate the output.
>   File "/usr/lib/python3/dist-packages/asciidoc/asciidoc.py", line 1380, in translate
>     self.attributes['manname'] = mo.group('manname').strip()
> AttributeError: 'NoneType' object has no attribute 'group'
> make[1]: *** [Makefile:237: libtracefs-instances-affinity.html] Error 1
> make: *** [Makefile:286: doc] Error 2
> 
> This was due to a cut and paste error and the first line did not have a
> hyphen for the description of the man page.
> 
> Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
> ---
>  Documentation/libtracefs-instances-affinity.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 


Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>


Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/libtracefs-instances-affinity.txt b/Documentation/libtracefs-instances-affinity.txt
index 107334dd1298..385d65035ece 100644
--- a/Documentation/libtracefs-instances-affinity.txt
+++ b/Documentation/libtracefs-instances-affinity.txt
@@ -4,8 +4,8 @@  libtracefs(3)
 NAME
 ----
 tracefs_instance_set_affinity, tracefs_instance_set_affinity_set, tracefs_set_affinity_raw,
-tracefs_instance_get_affinity, tracefs_instance_get_affinity_set, tracefs_get_affinity_raw,
-Sets or retrieves the affinity for an instance or top level for what CPUs enable tracing.
+tracefs_instance_get_affinity, tracefs_instance_get_affinity_set, tracefs_get_affinity_raw
+- Sets or retrieves the affinity for an instance or top level for what CPUs enable tracing.
 
 SYNOPSIS
 --------