Skip to contentSkip to conversation

perf: doc: Correct title markers for asciidoctor

PATCH In review Takashi Iwai 3 participants 3 messages Mar 7, 2018 – Mar 9, 2018 perf events

lore
Share & tools
lore

Takashi Iwai

author
#0 lore raw

PATCH 1/1 perf: doc: Correct title markers for asciidoctor

I've tested to process the perf man pages with asciidoctor that is picker than asciidoc, and it revealed minor syntax errors in some documents. Namely, the title markers aren't aligned with the previous line, hence asciidoctor didn't recognize as titles.

This patch corrects these markers to be processed properly.

Signed-off-by Takashi Iwai <[email protected]>
---
 tools/perf/Documentation/perf-data.txt        | 2 +-
 tools/perf/Documentation/perf-ftrace.txt      | 2 +-
 tools/perf/Documentation/perf-kallsyms.txt    | 2 +-
 tools/perf/Documentation/perf-sched.txt       | 2 +-
 tools/perf/Documentation/perf-script-perl.txt | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)
tools/perf/Documentation/perf-data.txt +1 -1
index 90bb4aabe4f8..c87180764829 100644
@@ -1,5 +1,5 @@
 perf-data(1)
-==============
+============
 
 NAME
 ----
tools/perf/Documentation/perf-ftrace.txt +1 -1
index 721a447f046e..b80c84307dc9 100644
@@ -1,5 +1,5 @@
 perf-ftrace(1)
-=============
+==============
 
 NAME
 ----
tools/perf/Documentation/perf-kallsyms.txt +1 -1
index 954ea9e21236..cdd421cd1c57 100644
@@ -1,5 +1,5 @@
 perf-kallsyms(1)
-==============
+================
 
 NAME
 ----
tools/perf/Documentation/perf-sched.txt +1 -1
index c7e50f263887..bb33601a823b 100644
@@ -1,5 +1,5 @@
 perf-sched(1)
-==============
+=============
 
 NAME
 ----
tools/perf/Documentation/perf-script-perl.txt +1 -1
index 142606c0ec9c..5a1f68122f50 100644
@@ -1,5 +1,5 @@
 perf-script-perl(1)
-==================
+===================
 
 NAME
 ----
Signature · 1 line
2.16.2
maintainer
#1 lore raw

Em Wed, Mar 07, 2018 at 11:54:41AM +0100, Takashi Iwai escreveu:

Quoted 6 lines

I've tested to process the perf man pages with asciidoctor that is picker than asciidoc, and it revealed minor syntax errors in some documents. Namely, the title markers aren't aligned with the previous line, hence asciidoctor didn't recognize as titles.

This patch corrects these markers to be processed properly.

Thanks, applying.

- Arnaldo

Quoted 66 lines
Signed-off-by Takashi Iwai <[email protected]>
---
 tools/perf/Documentation/perf-data.txt        | 2 +-
 tools/perf/Documentation/perf-ftrace.txt      | 2 +-
 tools/perf/Documentation/perf-kallsyms.txt    | 2 +-
 tools/perf/Documentation/perf-sched.txt       | 2 +-
 tools/perf/Documentation/perf-script-perl.txt | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)
tools/perf/Documentation/perf-data.txt +1 -1
index 90bb4aabe4f8..c87180764829 100644
@@ -1,5 +1,5 @@
 perf-data(1)
-==============
+============
 
 NAME
 ----
tools/perf/Documentation/perf-ftrace.txt +1 -1
index 721a447f046e..b80c84307dc9 100644
@@ -1,5 +1,5 @@
 perf-ftrace(1)
-=============
+==============
 
 NAME
 ----
tools/perf/Documentation/perf-kallsyms.txt +1 -1
index 954ea9e21236..cdd421cd1c57 100644
@@ -1,5 +1,5 @@
 perf-kallsyms(1)
-==============
+================
 
 NAME
 ----
tools/perf/Documentation/perf-sched.txt +1 -1
index c7e50f263887..bb33601a823b 100644
@@ -1,5 +1,5 @@
 perf-sched(1)
-==============
+=============
 
 NAME
 ----
tools/perf/Documentation/perf-script-perl.txt +1 -1
index 142606c0ec9c..5a1f68122f50 100644
@@ -1,5 +1,5 @@
 perf-script-perl(1)
-==================
+===================
 
 NAME
 ----
Signature · 1 line
2.16.2
merge bot
#2 lore raw

[tip:perf/core] perf tools: Correct title markers for asciidoctor

In reply to Takashi Iwai
perf tools: Correct title markers for asciidoctor
Commit-ID:  ea66536ab2cac7ba1553a677b8114f1b120cd9f2
Gitweb:     https://git.kernel.org/tip/ea66536ab2cac7ba1553a677b8114f1b120cd9f2
Author:     Takashi Iwai <[email protected]>
AuthorDate: Wed, 7 Mar 2018 11:54:41 +0100
Committer:  Arnaldo Carvalho de Melo <[email protected]>
CommitDate: Wed, 7 Mar 2018 10:26:32 -0300

perf tools: Correct title markers for asciidoctor

I've tested to process the perf man pages with asciidoctor that is picker than asciidoc, and it revealed minor syntax errors in some documents. Namely, the title markers aren't aligned with the previous line, hence asciidoctor didn't recognize as titles.

This patch corrects these markers to be processed properly.

Signed-off-by Takashi Iwai <[email protected]>
Cc Peter Zijlstra <[email protected]>
Link http://lkml.kernel.org/r/[email protected] open here
Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
---
 tools/perf/Documentation/perf-data.txt        | 2 +-
 tools/perf/Documentation/perf-ftrace.txt      | 2 +-
 tools/perf/Documentation/perf-kallsyms.txt    | 2 +-
 tools/perf/Documentation/perf-sched.txt       | 2 +-
 tools/perf/Documentation/perf-script-perl.txt | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)
tools/perf/Documentation/perf-data.txt +1 -1
index 90bb4aabe4f8..c87180764829 100644
@@ -1,5 +1,5 @@
 perf-data(1)
-==============
+============
 
 NAME
 ----
tools/perf/Documentation/perf-ftrace.txt +1 -1
index 721a447f046e..b80c84307dc9 100644
@@ -1,5 +1,5 @@
 perf-ftrace(1)
-=============
+==============
 
 NAME
 ----
tools/perf/Documentation/perf-kallsyms.txt +1 -1
index cf9f4040ea5c..f3c620951f6e 100644
@@ -1,5 +1,5 @@
 perf-kallsyms(1)
-==============
+================
 
 NAME
 ----
tools/perf/Documentation/perf-sched.txt +1 -1
index c7e50f263887..bb33601a823b 100644
@@ -1,5 +1,5 @@
 perf-sched(1)
-==============
+=============
 
 NAME
 ----
tools/perf/Documentation/perf-script-perl.txt +1 -1
index 142606c0ec9c..5a1f68122f50 100644
@@ -1,5 +1,5 @@
 perf-script-perl(1)
-==================
+===================
 
 NAME
 ----