From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A84B2ECAAA1 for ; Mon, 12 Sep 2022 09:40:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229881AbiILJkI (ORCPT ); Mon, 12 Sep 2022 05:40:08 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60986 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229778AbiILJkE (ORCPT ); Mon, 12 Sep 2022 05:40:04 -0400 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id A8BF11AF08; Mon, 12 Sep 2022 02:40:00 -0700 (PDT) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id CC22D113E; Mon, 12 Sep 2022 02:40:05 -0700 (PDT) Received: from [10.57.49.22] (unknown [10.57.49.22]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id EB79C3F71A; Mon, 12 Sep 2022 02:39:57 -0700 (PDT) Message-ID: <1037211f-6c10-16de-4819-2a51d115f65b@arm.com> Date: Mon, 12 Sep 2022 10:39:56 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0) Gecko/20100101 Thunderbird/91.13.0 Subject: Re: [PATCH 06/13] Documentation: coresight: fix a documentation build warning To: Mauro Carvalho Chehab , Linux Doc Mailing List , corbet@lwn.net Cc: Bagas Sanjaya , Leo Yan , Mathieu Poirier , Mike Leach , coresight@lists.linaro.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org References: From: Suzuki K Poulose In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 18/08/2022 14:38, Mauro Carvalho Chehab wrote: > Using wildcards for cross-reference doesn't work, as the Sphinx > automarkup plugin is not smart enough. So, changeset > c06475910b52 ("Documentation: coresight: Escape coresight bindings file wildcard") > tried to fix it, but at the wrong way, as it the building system > will keep producing warnings about that: > > Warning: Documentation/trace/coresight/coresight.rst references a file that doesn't exist: Documentation/devicetree/bindings/arm/arm,coresight- > > As automarkup will still try (and fail) to create a cross reference. > So, instead, change the markup to ensure that the warning won't be > reported. > > Fixes: c06475910b52 ("Documentation: coresight: Escape coresight bindings file wildcard") > Cc: Bagas Sanjaya > Signed-off-by: Mauro Carvalho Chehab Acked-by: Suzuki K Poulose > --- > > See [PATCH 00/13] at: https://lore.kernel.org/all/cover.1660829433.git.mchehab@kernel.org/ > > Documentation/trace/coresight/coresight.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/trace/coresight/coresight.rst b/Documentation/trace/coresight/coresight.rst > index 4a71ea6cb390..826e59a698da 100644 > --- a/Documentation/trace/coresight/coresight.rst > +++ b/Documentation/trace/coresight/coresight.rst > @@ -130,7 +130,7 @@ Misc: > Device Tree Bindings > -------------------- > > -See Documentation/devicetree/bindings/arm/arm,coresight-\*.yaml for details. > +See ``Documentation/devicetree/bindings/arm/arm,coresight-*.yaml`` for details. > > As of this writing drivers for ITM, STMs and CTIs are not provided but are > expected to be added as the solution matures.