From patchwork Sun Oct 22 18:58:06 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vegard Nossum X-Patchwork-Id: 13432051 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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id D1317CDB474 for ; Sun, 22 Oct 2023 18:58:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:Cc :To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=fP7LvEmH8njPBgm6FdUUAcmK3wVeVoDmB3AUt7cj0ak=; b=rN9cjsFzZsmYCV OnHgz00/sHGHTol0FlbYL8/oaZIz6Rr3+bfB8P0p/1soPHXLiEfuWeKHigyp6B7xQdWutVYJpd5T0 grBxbWVqOQgpvPPOsVWi2Sl54l0Ap7fuEX2iJHaWROY1lOeDsDqgvHoLhsXZ1j3dehBjwVEhk0rNn 2WaT7cIZIzjiIxuKSxAAmmWGgO241WU5aKXdRPyA4AOCvhFMRhnjARhDuvqM/AKb3ek6+GcB7NDz8 OB3kNQOaOrW7XCuSfgPaUKewMHHS79lKsjzxyBd2nZT4A4Kzxf73JiIalnnmzGaZZE3IgMOZDlt0p BdX/CDVIBdqWHMog7Pfg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qudej-005puJ-0d; Sun, 22 Oct 2023 18:58:33 +0000 Received: from mx0b-00069f02.pphosted.com ([205.220.177.32]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1qudeg-005ptz-20 for linux-arm-kernel@lists.infradead.org; Sun, 22 Oct 2023 18:58:31 +0000 Received: from pps.filterd (m0246632.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 39MIqxiW016711; Sun, 22 Oct 2023 18:58:18 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding; s=corp-2023-03-30; bh=Z5FjhE0lXP7yPcnsHyhXfQkfD/iyz239cGkuzlE7Ktg=; b=RmrXWFsD7KNtCttW7ojuKc78oT1JdDKrfycHCYmsfz9CpxrSkhi4jgme76+mgOaYWmpS J6yIwuzE2SJ/U0YNpGZCqhcoiBPx7d0akExwEd/1crswrYw6rZ0cF2obtjSB3RpYeBeI 0FJ9MwCYDe1vunXdlPZR+iJ6pERx6xzVcoZbvaWHSdpV6QW//Z5ivWjdD8QTEr91je0y GoE9uyqvRdQxfrklIKrNxqtLBuPrPmhbsMDsVRphCdN99WGRTBNak5b18CO/sWznOjCv MdVDWETm/jHOR1xLoZ77PQYyJ+IS1HUwKbeFfw9FbbgB7yCyAX1a2PB2QUBLjdgf71zn Jw== Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.appoci.oracle.com [138.1.37.129]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3tv68t9tp9-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 22 Oct 2023 18:58:17 +0000 Received: from pps.filterd (phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (8.17.1.19/8.17.1.19) with ESMTP id 39MHe2wh034522; Sun, 22 Oct 2023 18:58:16 GMT Received: from pps.reinject (localhost [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTPS id 3tv533795r-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 22 Oct 2023 18:58:16 +0000 Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by pps.reinject (8.17.1.5/8.17.1.5) with ESMTP id 39MIwG0O035256; Sun, 22 Oct 2023 18:58:16 GMT Received: from localhost.localdomain (dhcp-10-175-52-84.vpn.oracle.com [10.175.52.84]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTP id 3tv533794v-1; Sun, 22 Oct 2023 18:58:15 +0000 From: Vegard Nossum To: Suzuki K Poulose , Mike Leach , James Clark , Leo Yan , Jonathan Corbet Cc: coresight@lists.linaro.org, linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Vegard Nossum , Mathieu Poirier , Rob Herring , linux-next@vger.kernel.org, Stephen Rothwell , Bagas Sanjaya Subject: [PATCH] Documentation: coresight: fix `make refcheckdocs` warning Date: Sun, 22 Oct 2023 20:58:06 +0200 Message-Id: <20231022185806.919434-1-vegard.nossum@oracle.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.980,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2023-10-22_16,2023-10-19_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 adultscore=0 phishscore=0 mlxlogscore=999 mlxscore=0 bulkscore=0 suspectscore=0 malwarescore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2310170001 definitions=main-2310220175 X-Proofpoint-ORIG-GUID: zWnmiCGfJCLpShlQU7tsgurc83z9kgtE X-Proofpoint-GUID: zWnmiCGfJCLpShlQU7tsgurc83z9kgtE X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20231022_115830_799320_4F75F5D9 X-CRM114-Status: GOOD ( 19.02 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org This reference uses a glob pattern to match multiple files, but the asterisk was escaped as \* in order to not be interpreted by sphinx as reStructuredText markup. refcheckdocs/documentation-file-ref-check doesn't know about rST syntax and tries to interpret the \* literally (instead of as a glob). We can work around the warning by putting the Documentation reference inside double backticks (``..``), which allows us to not escape the asterisk. Fixes: c06475910b52 ("Documentation: coresight: Escape coresight bindings file wildcard") Cc: Mathieu Poirier Cc: Suzuki K Poulose Cc: Mike Leach Cc: Leo Yan Cc: Jonathan Corbet Cc: Rob Herring Cc: coresight@lists.linaro.org Cc: linux-arm-kernel@lists.infradead.org Cc: linux-next@vger.kernel.org Cc: linux-kernel@vger.kernel.org Cc: Stephen Rothwell Cc: Bagas Sanjaya Signed-off-by: Vegard Nossum Reviewed-by: Bagas Sanjaya --- 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.