Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <46328b62-d948-a5c2-25c6-f5caec123412@foss.arm.com>
Date:   Wed, 19 Oct 2022 09:16:03 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.3.2
Subject: Re: [PATCH v9 13/13] perf test: Add relevant documentation about
 CoreSight testing
To:     Sven Schnelle <svens@linux.ibm.com>
Cc:     linux-kernel@vger.kernel.org, coresight@lists.linaro.org,
        suzuki.poulose@arm.com, mathieu.poirier@linaro.org,
        mike.leach@linaro.org, leo.yan@linaro.org,
        linux-perf-users@vger.kernel.org, acme@kernel.org
References: <20220909152803.2317006-1-carsten.haitzler@foss.arm.com>
 <20220909152803.2317006-14-carsten.haitzler@foss.arm.com>
 <yt9dr0zex1j4.fsf@linux.ibm.com>
Content-Language: en-US
From:   Carsten Haitzler <carsten.haitzler@foss.arm.com>
Organization: Arm Ltd.
In-Reply-To: <yt9dr0zex1j4.fsf@linux.ibm.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk

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@foss.arm.com writes:
> 
>> From: Carsten Haitzler <carsten.haitzler@arm.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@vger.kernel.org
>> Signed-off-by: Carsten Haitzler <carsten.haitzler@arm.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!