[PATCH 0/2] perf docs: Fix build with asciidoctor

[PATCH 0/2] perf docs: Fix build with asciidoctor

[Ben Hutchings]

[-- Attachment #1: Type: text/plain, Size: 833 bytes --]

Although I made a minor fix in 2023 for asciidoctor builds, I missed
an earlier regression from 2020 that had been fixed locally in the
Debian package but not upstream.  I'm sending 2 more fixes that should
make all manual pages build properly with asciidoctor.

However, given that asciidoctor support has been broken upstream for
nearly 5 years now, it might make more sense to remove it instead.  We
only moved to asciidoctor in Debian to remove a Python 2 dependency.
Since asciidoc was ported to Python 3 that's no longer a concern.

Ben.

Ben Hutchings (2):
  perf docs: Fix build with asciidoctor
  perf docs: Fix perf-check manual page built with asciidoctor

 tools/perf/Documentation/Makefile       | 17 +++++++++--------
 tools/perf/Documentation/perf-check.txt |  2 +-
 2 files changed, 10 insertions(+), 9 deletions(-)


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[PATCH 1/2] perf docs: Fix build with asciidoctor

[Ben Hutchings]

[-- Attachment #1: Type: text/plain, Size: 1499 bytes --]

Currently we unconditionally add "--unsafe -f asciidoc.conf" to
ASCIIDOC_EXTRA, but asciidoctor doesn't support these options.

Make all the ASCIIDOC_* variable assignments conditional on whether
USE_ASCIIDOCTOR is set.

Fixes: e9cfa47e687d ("perf doc: allow ASCIIDOC_EXTRA to be an argument")
Signed-off-by: Ben Hutchings <benh@debian.org>
---
 tools/perf/Documentation/Makefile | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/tools/perf/Documentation/Makefile b/tools/perf/Documentation/Makefile
index 4407b106d977..f566e3e98c22 100644
--- a/tools/perf/Documentation/Makefile
+++ b/tools/perf/Documentation/Makefile
@@ -44,17 +44,11 @@ man1dir=$(mandir)/man1
 man5dir=$(mandir)/man5
 man7dir=$(mandir)/man7
 
+ifndef USE_ASCIIDOCTOR
 ASCIIDOC=asciidoc
 ASCIIDOC_EXTRA += --unsafe -f asciidoc.conf
 ASCIIDOC_HTML = xhtml11
-MANPAGE_XSL = manpage-normal.xsl
-XMLTO_EXTRA =
-INSTALL?=install
-RM ?= rm -f
-DOC_REF = origin/man
-HTML_REF = origin/html
-
-ifdef USE_ASCIIDOCTOR
+else
 ASCIIDOC = asciidoctor
 ASCIIDOC_EXTRA += -a compat-mode
 ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
@@ -62,6 +56,13 @@ ASCIIDOC_EXTRA += -a mansource="perf" -a manmanual="perf Manual"
 ASCIIDOC_HTML = xhtml5
 endif
 
+MANPAGE_XSL = manpage-normal.xsl
+XMLTO_EXTRA =
+INSTALL?=install
+RM ?= rm -f
+DOC_REF = origin/man
+HTML_REF = origin/html
+
 infodir?=$(prefix)/share/info
 MAKEINFO=makeinfo
 INSTALL_INFO=install-info


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[PATCH 2/2] perf docs: Fix perf-check manual page built with asciidoctor

[Ben Hutchings]

[-- Attachment #1: Type: text/plain, Size: 1037 bytes --]

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>
---
 tools/perf/Documentation/perf-check.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/perf-check.txt b/tools/perf/Documentation/perf-check.txt
index a764a4629220..80eb1de4eee0 100644
--- a/tools/perf/Documentation/perf-check.txt
+++ b/tools/perf/Documentation/perf-check.txt
@@ -1,5 +1,5 @@
 perf-check(1)
-===============
+=============
 
 NAME
 ----

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]