diff mbox series

perf tools: Fix man page build wrt perf-arm-coresight.txt

Message ID a176a3e1-6ddc-bb63-e41c-15cda8c2d5d2@intel.com
State New
Headers
Series perf tools: Fix man page build wrt perf-arm-coresight.txt |

Commit Message

Adrian Hunter Oct. 17, 2022, 9:35 a.m. UTC 
  perf build assumes documentation files starting with "perf-" are man
pages but perf-arm-coresight.txt is not a man page:

asciidoc: ERROR: perf-arm-coresight.txt: line 2: malformed manpage title
asciidoc: ERROR: perf-arm-coresight.txt: line 3: name section expected
asciidoc: FAILED: perf-arm-coresight.txt: line 3: section title expected
make[3]: *** [Makefile:266: perf-arm-coresight.xml] Error 1
make[3]: *** Waiting for unfinished jobs....
make[2]: *** [Makefile.perf:895: man] Error 2

Fix by renaming it.

Reported-by: Sven Schnelle <svens@linux.ibm.com>
Reported-by: Christian Borntraeger <borntraeger@linux.ibm.com>
Fixes: dc2e0fb00bb2 ("perf test coresight: Add relevant documentation about ARM64 CoreSight testing")
Signed-off-by: Adrian Hunter <adrian.hunter@intel.com>
---
 .../Documentation/{perf-arm-coresight.txt => arm-coresight.txt}   | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename tools/perf/Documentation/{perf-arm-coresight.txt => arm-coresight.txt} (100%)

Comments

Leo Yan Oct. 17, 2022, 9:57 a.m. UTC | #1 
On Mon, Oct 17, 2022 at 12:35:49PM +0300, Adrian Hunter wrote:
> perf build assumes documentation files starting with "perf-" are man
> pages but perf-arm-coresight.txt is not a man page:
> 
> asciidoc: ERROR: perf-arm-coresight.txt: line 2: malformed manpage title
> asciidoc: ERROR: perf-arm-coresight.txt: line 3: name section expected
> asciidoc: FAILED: perf-arm-coresight.txt: line 3: section title expected
> make[3]: *** [Makefile:266: perf-arm-coresight.xml] Error 1
> make[3]: *** Waiting for unfinished jobs....
> make[2]: *** [Makefile.perf:895: man] Error 2
> 
> Fix by renaming it.
> 
> Reported-by: Sven Schnelle <svens@linux.ibm.com>
> Reported-by: Christian Borntraeger <borntraeger@linux.ibm.com>
> Fixes: dc2e0fb00bb2 ("perf test coresight: Add relevant documentation about ARM64 CoreSight testing")
> Signed-off-by: Adrian Hunter <adrian.hunter@intel.com>

Thanks for fixing, Adrian.  The change LGTM:

Reviewed-by: Leo Yan <leo.yan@linaro.org>

> ---
>  .../Documentation/{perf-arm-coresight.txt => arm-coresight.txt}   | 0
>  1 file changed, 0 insertions(+), 0 deletions(-)
>  rename tools/perf/Documentation/{perf-arm-coresight.txt => arm-coresight.txt} (100%)
> 
> diff --git a/tools/perf/Documentation/perf-arm-coresight.txt b/tools/perf/Documentation/arm-coresight.txt
> similarity index 100%
> rename from tools/perf/Documentation/perf-arm-coresight.txt
> rename to tools/perf/Documentation/arm-coresight.txt
> -- 
> 2.25.1
>
Arnaldo Carvalho de Melo Oct. 17, 2022, 12:19 p.m. UTC | #2 
Em Mon, Oct 17, 2022 at 05:57:43PM +0800, Leo Yan escreveu:
> On Mon, Oct 17, 2022 at 12:35:49PM +0300, Adrian Hunter wrote:
> > perf build assumes documentation files starting with "perf-" are man
> > pages but perf-arm-coresight.txt is not a man page:
> > 
> > asciidoc: ERROR: perf-arm-coresight.txt: line 2: malformed manpage title
> > asciidoc: ERROR: perf-arm-coresight.txt: line 3: name section expected
> > asciidoc: FAILED: perf-arm-coresight.txt: line 3: section title expected
> > make[3]: *** [Makefile:266: perf-arm-coresight.xml] Error 1
> > make[3]: *** Waiting for unfinished jobs....
> > make[2]: *** [Makefile.perf:895: man] Error 2
> > 
> > Fix by renaming it.
> > 
> > Reported-by: Sven Schnelle <svens@linux.ibm.com>
> > Reported-by: Christian Borntraeger <borntraeger@linux.ibm.com>
> > Fixes: dc2e0fb00bb2 ("perf test coresight: Add relevant documentation about ARM64 CoreSight testing")
> > Signed-off-by: Adrian Hunter <adrian.hunter@intel.com>
> 
> Thanks for fixing, Adrian.  The change LGTM:
> 
> Reviewed-by: Leo Yan <leo.yan@linaro.org>

Thanks, applied.

- Arnaldo

 
> > ---
> >  .../Documentation/{perf-arm-coresight.txt => arm-coresight.txt}   | 0
> >  1 file changed, 0 insertions(+), 0 deletions(-)
> >  rename tools/perf/Documentation/{perf-arm-coresight.txt => arm-coresight.txt} (100%)
> > 
> > diff --git a/tools/perf/Documentation/perf-arm-coresight.txt b/tools/perf/Documentation/arm-coresight.txt
> > similarity index 100%
> > rename from tools/perf/Documentation/perf-arm-coresight.txt
> > rename to tools/perf/Documentation/arm-coresight.txt
> > -- 
> > 2.25.1
> >
diff mbox series

Patch

diff --git a/tools/perf/Documentation/perf-arm-coresight.txt b/tools/perf/Documentation/arm-coresight.txt
similarity index 100%
rename from tools/perf/Documentation/perf-arm-coresight.txt
rename to tools/perf/Documentation/arm-coresight.txt