Skip to contentSkip to conversation

libtracefs: Fix libtracefs-instance-affinity.txt document

PATCH In review Steven Rostedt 2 participants 2 messages Jan 19, 2022 – Jan 24, 2022 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 libtracefs: Fix libtracefs-instance-affinity.txt document

From: "Steven Rostedt (Google)" <[email protected]>

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.

---
 Documentation/libtracefs-instances-affinity.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/libtracefs-instances-affinity.txt +2 -2
index 107334dd1298..385d65035ece 100644
@@ -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
 --------
Signature · 1 line
2.33.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 18 lines · Steven Rostedt

From: "Steven Rostedt (Google)" <[email protected]>

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

Quoted 8 lines

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.

---
 Documentation/libtracefs-instances-affinity.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Best regards,
Krzysztof