[PATCH] perf docs: Fix perf-check manual page built with asciidoctor
authorBen Hutchings <benh@debian.org>
Sun, 23 Mar 2025 20:04:02 +0000 (21:04 +0100)
committerSalvatore Bonaccorso <carnil@debian.org>
Wed, 16 Jul 2025 07:13:16 +0000 (09:13 +0200)
Forwarded: https://lore.kernel.org/linux-perf-users/Z-BxCE8WrcRmR_5f@decadent.org.uk/

asciidoctor is more picky than asciidoc about the length of heading
underlines, and currently mis-parses perf-check.txt:

  ASCIIDOC perf-check.1
asciidoctor: ERROR: perf-check.txt: line 1: non-conforming manpage title
asciidoctor: ERROR: perf-check.txt: line 1: name section expected
asciidoctor: WARNING: perf-check.txt: line 2: unterminated example block
asciidoctor: WARNING: perf-check.txt: line 5: unterminated listing block

Fix the length of the title underline so it works properly.

Fixes: 98ad0b77323c ("perf check: Introduce 'check' subcommand")
Signed-off-by: Ben Hutchings <benh@debian.org>
Gbp-Pq: Topic bugfix/all
Gbp-Pq: Name perf-docs-Fix-perf-check-manual-page-built-with-asci.patch

tools/perf/Documentation/perf-check.txt

index 10f69fb6850bcc8cadf0a66d3fc22d30e0e031d4..4bfbf59d0b9b6951bb05fd5194ca8c09d12ccb63 100644 (file)
@@ -1,5 +1,5 @@
 perf-check(1)
-===============
+=============
 
 NAME
 ----