linux-kernel - Re: [PATCH v9 13/13] perf test: Add relevant documentation about CoreSight testing

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <46328b62-d948-a5c2-25c6-f5caec123412@foss.arm.com>
Date:   Wed, 19 Oct 2022 09:16:03 +0100
From:   Carsten Haitzler <carsten.haitzler@...s.arm.com>
To:     Sven Schnelle <svens@...ux.ibm.com>
Cc:     linux-kernel@...r.kernel.org, coresight@...ts.linaro.org,
        suzuki.poulose@....com, mathieu.poirier@...aro.org,
        mike.leach@...aro.org, leo.yan@...aro.org,
        linux-perf-users@...r.kernel.org, acme@...nel.org
Subject: Re: [PATCH v9 13/13] perf test: Add relevant documentation about
 CoreSight testing

This is weird. This shouldn't be making its way into any man page at 
all. It's just a file pointing people at other parts of the kernel tree 
for docs (because when I looked for docs - i found nothing for any kind 
of getting started guide - I put something here as this was the obvious 
place for perf related docs for testing - but was told to put the docs 
elsewhere in core kernel documentation, but I put a reference here for 
those who follow after to be able to more easily find it).

There is some rule somewhere it seems that makes anything perf-*.txt 
into a man page. I need to rename this file it seems.

On 10/11/22 08:27, Sven Schnelle wrote:
> Hi Carsten,
> 
> carsten.haitzler@...s.arm.com writes:
> 
>> From: Carsten Haitzler <carsten.haitzler@....com>
>>
>> Add/improve documentation helping people get started with CoreSight and
>> perf as well as describe the testing and how it works.
>>
>> Cc: linux-doc@...r.kernel.org
>> Signed-off-by: Carsten Haitzler <carsten.haitzler@....com>
>> ---
>>   .../trace/coresight/coresight-perf.rst        | 158 ++++++++++++++++++
>>   .../perf/Documentation/perf-arm-coresight.txt |   5 +
>>   2 files changed, 163 insertions(+)
>>   create mode 100644 Documentation/trace/coresight/coresight-perf.rst
>>   create mode 100644 tools/perf/Documentation/perf-arm-coresight.txt
>>
> 
> Investigating a rpm build failure i see the following error with next-20221011:
> 
> % cd tools/perf/Documentation
> % make O=/home/svens/linux-build/ man V=1
> rm -f /home/svens/linux-build/perf-arm-coresight.xml+ /home/svens/linux-build/perf-arm-coresight.xml && \
> asciidoc -b docbook -d manpage \
>          --unsafe -f asciidoc.conf -aperf_version= \
>          -aperf_date=2022-10-06 \
>          -o /home/svens/linux-build/perf-arm-coresight.xml+ perf-arm-coresight.txt && \
> mv /home/svens/linux-build/perf-arm-coresight.xml+ /home/svens/linux-build/perf-arm-coresight.xml
> asciidoc: FAILED: manpage document title is mandatory
> make: *** [Makefile:266: /home/svens/linux-build/perf-arm-coresight.xml] Error 1
> 
> Can you please fix this?
> 
> Thanks!