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 kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 53FE4C36010 for ; Fri, 4 Apr 2025 17:20:16 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 8042A6B0008; Fri, 4 Apr 2025 13:20:14 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 7B3706B000A; Fri, 4 Apr 2025 13:20:14 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 655146B000C; Fri, 4 Apr 2025 13:20:14 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 477BE6B0008 for ; Fri, 4 Apr 2025 13:20:14 -0400 (EDT) Received: from smtpin05.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id 30D4A160613 for ; Fri, 4 Apr 2025 17:20:15 +0000 (UTC) X-FDA: 83297024790.05.7258635 Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) by imf12.hostedemail.com (Postfix) with ESMTP id B482F4000A for ; Fri, 4 Apr 2025 17:20:12 +0000 (UTC) Authentication-Results: imf12.hostedemail.com; dkim=none; dmarc=pass (policy=quarantine) header.from=huawei.com; spf=pass (imf12.hostedemail.com: domain of jonathan.cameron@huawei.com designates 185.176.79.56 as permitted sender) smtp.mailfrom=jonathan.cameron@huawei.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1743787213; a=rsa-sha256; cv=none; b=hUaOj2V3dWUAVWQQ2UxJNvqHF9UzLhU4Cb6OqTrRXUJQC/xmqZfDb8gUMiHz1jVJq9RaZN qwu5X7KBqGr7vcoDLBp0KQrRoYitpGzbZPF+zYs8TB4N/Tm+WFsJrHAG1gxyjbTaOWLfsg bQ9rJ0/hqCOuOuJvNV8s2jh5wcfeCq0= ARC-Authentication-Results: i=1; imf12.hostedemail.com; dkim=none; dmarc=pass (policy=quarantine) header.from=huawei.com; spf=pass (imf12.hostedemail.com: domain of jonathan.cameron@huawei.com designates 185.176.79.56 as permitted sender) smtp.mailfrom=jonathan.cameron@huawei.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1743787213; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=4gfzC1kaXPJBeIoczqDFpLahGxMxOt2ucNV2CUeZ1pg=; b=rJUnDXC8VjaA3izc0/Yf3OFIwfehO8OzW8hfpfFJJiLfCH6SCnPfEa/opwgRVOUXX/1gtQ JfEXTjdaWLgs1lscBE/sc2ijsKlVv47gw0Rt+KQv6tR/HuVsJZe8kut/RovEThU4EJfEe2 XPCQlQMhoHgzbCHu839ezxbM9ChX0Oc= Received: from mail.maildlp.com (unknown [172.18.186.231]) by frasgout.his.huawei.com (SkyGuard) with ESMTP id 4ZTld74xBKz6K9J8; Sat, 5 Apr 2025 01:16:27 +0800 (CST) Received: from frapeml500008.china.huawei.com (unknown [7.182.85.71]) by mail.maildlp.com (Postfix) with ESMTPS id BEE601402C7; Sat, 5 Apr 2025 01:20:08 +0800 (CST) Received: from localhost (10.203.177.66) by frapeml500008.china.huawei.com (7.182.85.71) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.39; Fri, 4 Apr 2025 19:20:07 +0200 Date: Fri, 4 Apr 2025 18:20:06 +0100 From: Jonathan Cameron To: "=?ISO-8859-1?Q?N=EDcolas?= F. R. A. Prado" CC: Andrew Morton , Jonathan Corbet , Vinod Koul , Eric Biggers , "Theodore Y. Ts'o" , Jaegeuk Kim , Jonathan Cameron , "Lars-Peter Clausen" , "David S. Miller" , "Eric Dumazet" , Jakub Kicinski , "Paolo Abeni" , Simon Horman , "Maxime Chevallier" , James Bottomley , Jarkko Sakkinen , Mimi Zohar , Jaroslav Kysela , Takashi Iwai , Mauro Carvalho Chehab , Richard Weinberger , Anton Ivanov , Johannes Berg , , , , , , , , , , , , , , Subject: Re: [PATCH] docs: Remove literal markup from Documentation/ paths Message-ID: <20250404182006.000038cc@huawei.com> In-Reply-To: <20250404-doc-paths-unliteral-v1-1-74718785444e@collabora.com> References: <20250404-doc-paths-unliteral-v1-1-74718785444e@collabora.com> X-Mailer: Claws Mail 4.3.0 (GTK 3.24.42; x86_64-w64-mingw32) MIME-Version: 1.0 Content-Type: text/plain; charset="ISO-8859-1" Content-Transfer-Encoding: quoted-printable X-Originating-IP: [10.203.177.66] X-ClientProxiedBy: lhrpeml100006.china.huawei.com (7.191.160.224) To frapeml500008.china.huawei.com (7.182.85.71) X-Rspamd-Server: rspam04 X-Rspamd-Queue-Id: B482F4000A X-Stat-Signature: cioeyhdhs4ruognmjo9w8mpt41ogca3j X-Rspam-User: X-HE-Tag: 1743787212-546957 X-HE-Meta: U2FsdGVkX1+ixGWUDJ/dGk2QSEkLbZGIiBXH6GfZ/fKvtVegHkzh6Cgp+Y4ntdfq7A8lmmb0qgxg30agQUVeefFQdvIcZRVnzIMvVi/56hlrjqfh6uQ8Jr9q6YZZu65EpbMA/kTqlb+uheHwZ39v/ZVSdOn+DakXzk4nj1WIbxJ3pfN1oWtjBcZM6G5D6dewZtDhaoPSIIzAFa366bKoFoxtRYea5XA6ZVgJTseVa942IFghyDgz/tD7OCDB8QPoLOrOxjxGd6k5AI9dK/6mrdgZCeXnhYrXVmuUQQ5z2KmweAARkNgTQ6uauBroqhVuDWI3EVkcdhBKqwSP3IlGxmqh6XcUacVuKOQFmFh59vJvn9CsD0HndqwCypxEca2OfB/LOGbajx0RffFmoK0gdQjl3mva2ru+9yVgPvlIkAA+prjyMYfFiAxpoDNuLFpUiyL4vdJe9oUFNX6GkeDMU8yDct1FJqAS3KPy60RvErA5vlgPH7wzqC/0MmJ6msL7QX/skK0Q67n0l+ovcIBQ4+MHL/bCe+wdVvbfjeOrco9hXaZR8ROSBM3u6CKdv4FFdvnvLufm8+k+2gVBTqYA8wFFfilBJGPBBMmbfxZuiSJ2wzUNg6B44e76U0+QafCEoO39HqeRu8S2PQSls/cccv0+6eSe6TcOa5Q2zyTZ+XGXqd+DQMdnTvrvpdM4n2olYFpNK56lPfuM8qUuBuUo02UgQAcV0aSMRQkMhjsM2uQpp4Sgx2Y8v8MKwNgS4Kn8Tj28oMmcgBCLbDkTxDPvIQyZo9njbNl2E76aNxs1ZrfYngts1ZF8D6GI/6gTh/TQIBPoQkL9zJTw3bKdkESRmaZplPmfS1rl X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: On Fri, 04 Apr 2025 11:37:28 -0400 N=EDcolas F. R. A. Prado wrote: > Given that the automarkup Sphinx plugin cross-references > "Documentation/*.rst" strings in the text to the corresponding > documents, surrounding those strings with the literal markup (``) not > only adds unnecessary markup in the source files, but actually prevents > the automatic cross-referencing to happen (as it doesn't happen in > literal blocks). >=20 > Remove all the occurrences of the literal markup in > "Documentation/*.rst" paths, except when the actual source file is being > referred. Also change the surrounding text when needed so it reads well > both in the source and the web page (eg. 'see file Doc...' -> 'see > Doc...'). >=20 > Signed-off-by: N=EDcolas F. R. A. Prado > --- > Documentation/admin-guide/mm/numa_memory_policy.rst | 2 +- > Documentation/admin-guide/serial-console.rst | 2 +- > Documentation/driver-api/dmaengine/client.rst | 2 +- > Documentation/driver-api/nvdimm/security.rst | 2 +- > Documentation/filesystems/fscrypt.rst | 4 ++-- > Documentation/iio/adis16475.rst | 4 ++-- > Documentation/iio/adis16480.rst | 4 ++-- > Documentation/iio/adis16550.rst | 4 ++-- > Documentation/iio/adxl380.rst | 4 ++-- Split patch up by subsystem would be a good thing here as we may get other changes to these docs during the cycle and resulting merge conflicts if this all goes in as one patch. > Documentation/kernel-hacking/hacking.rst | 6 +++--- > Documentation/kernel-hacking/locking.rst | 2 +- > Documentation/networking/dsa/b53.rst | 2 +- > Documentation/networking/dsa/bcm_sf2.rst | 2 +- > Documentation/networking/dsa/dsa.rst | 2 +- > Documentation/networking/dsa/lan9303.rst | 2 +- > Documentation/networking/phy-link-topology.rst | 2 +- > Documentation/process/adding-syscalls.rst | 2 +- > Documentation/process/submit-checklist.rst | 7 ++++--- > Documentation/security/keys/trusted-encrypted.rst | 4 ++-- > Documentation/sound/kernel-api/writing-an-alsa-driver.rst | 2 +- > Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst | 2 +- > Documentation/userspace-api/media/v4l/diff-v4l.rst | 2 +- > Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst | 4 ++-- > Documentation/virt/uml/user_mode_linux_howto_v2.rst | 2 +- > 24 files changed, 36 insertions(+), 35 deletions(-)