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 A5E62C36010 for ; Fri, 4 Apr 2025 17:43:00 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id D82A46B000A; Fri, 4 Apr 2025 13:42:59 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id D321E6B000C; Fri, 4 Apr 2025 13:42:59 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id BFA2D6B000E; Fri, 4 Apr 2025 13:42:59 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 9EE946B000A for ; Fri, 4 Apr 2025 13:42:59 -0400 (EDT) Received: from smtpin14.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id 573D11206EC for ; Fri, 4 Apr 2025 17:42:59 +0000 (UTC) X-FDA: 83297082078.14.6BB4781 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by imf22.hostedemail.com (Postfix) with ESMTP id 7EB8BC000B for ; Fri, 4 Apr 2025 17:42:57 +0000 (UTC) Authentication-Results: imf22.hostedemail.com; dkim=pass header.d=lwn.net header.s=20201203 header.b=gjzgvuRx; spf=pass (imf22.hostedemail.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net; dmarc=pass (policy=none) header.from=lwn.net ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1743788577; 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:dkim-signature; bh=JzbhxxufdLBWNEgR9vh1QpsUJVM3j8df+P7niCurQOQ=; b=6CD7XsHVItrw/Ix3oeKr/8EjiExr+g0miprDc2jAgi6XS05jQQtuKue9OKwovGNV4EMi6j 7QIrOcKZ/IUwLFINy/8uAk41a8emfRuaR53eIgo9yRYsYogEYkO+2jAkRuE6CvoUYWOH0m IPlAwJnqqGdcjJ6pRWJ7EMKSshu58x8= ARC-Authentication-Results: i=1; imf22.hostedemail.com; dkim=pass header.d=lwn.net header.s=20201203 header.b=gjzgvuRx; spf=pass (imf22.hostedemail.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net; dmarc=pass (policy=none) header.from=lwn.net ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1743788577; a=rsa-sha256; cv=none; b=KUkHaqKgHog4KUEhwqGvrg17sexhmUWOgPAfgLT+w8XPUnVdMpUrKRe2uhj8/LLKYP4Bwn ajSF5CeKswYzILdd1K3ziXBuhqFR/gJ3dlnzCxVdHmKh09P9YYSIcU+owwcPK6dSvGtWdL eUzWv/ZtfyYESdxl+Uv8+GCNrajMxFw= DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 712B140407 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1743788575; bh=JzbhxxufdLBWNEgR9vh1QpsUJVM3j8df+P7niCurQOQ=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=gjzgvuRxZCBmi8B6mkrqXXRmMKQkpGQhbiqLXejxp/qRwu5yW7JSeYWStGwDZMaO+ B3f79u/9zrKGbFs5vQRDl/ICF/laMc5MDfcYEBYHwtMMTcfRWPwvW7+/gel1Nc42gY DkfUyQLmULGr9Q08Npj3bYSv74wwxIaM7vXi0npgl0MqVahgRfkb/AhVrG1s/46cIj zvUfYkYmt1a52pM4Gs14ivgHcAR+r8skBoqp8C1wzyt9JXJZYNfn7prWSbPfW3Rqa/ GieNnfvB9yehHrM8xXgX5u5KMqO7ag8pturer7DhZ+rq9ooE0/m8bgOq5AUQQv3iTH gCYovv7u8iTTQ== Received: from localhost (unknown [IPv6:2601:280:4600:2da9::1fe]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 712B140407; Fri, 4 Apr 2025 17:42:55 +0000 (UTC) From: Jonathan Corbet To: Jonathan Cameron , =?utf-8?Q?N=C3=ADcolas?= =?utf-8?Q?_F=2E_R=2E_A=2E_Prado?= Cc: Andrew Morton , 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 , kernel@collabora.com, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, dmaengine@vger.kernel.org, linux-fscrypt@vger.kernel.org, linux-iio@vger.kernel.org, netdev@vger.kernel.org, workflows@vger.kernel.org, linux-integrity@vger.kernel.org, keyrings@vger.kernel.org, linux-sound@vger.kernel.org, linux-media@vger.kernel.org, linux-um@lists.infradead.org Subject: Re: [PATCH] docs: Remove literal markup from Documentation/ paths In-Reply-To: <20250404182006.000038cc@huawei.com> References: <20250404-doc-paths-unliteral-v1-1-74718785444e@collabora.com> <20250404182006.000038cc@huawei.com> Date: Fri, 04 Apr 2025 11:42:54 -0600 Message-ID: <874iz3g6w1.fsf@trenco.lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Rspam-User: X-Rspamd-Server: rspam09 X-Rspamd-Queue-Id: 7EB8BC000B X-Stat-Signature: jg771c5pthygnu39pa4majqqgafzmkgr X-HE-Tag: 1743788577-213816 X-HE-Meta: U2FsdGVkX19JeJyrB/Pbw5pljNWC7yHEV4QAonKI4/1gTWvNDnU/8nsH926jRkdnqlsZ9sb/xQYQKioHjxitGsBVjxYEn8Z8Sk/60bFMz/Rdz9Bra9y/FxF2YD/7m+6c5c1tsLOo0Rii+1hiJIXr+fYjj9b0VObYl4seJCF20tR5irdmBP2wlpH/9WptU+sZ/PCZHNJBg7WTjgr2DODuiPzjL2jq5BNyaVCU0BlLxc0KVVpmZWXLioa3JRZRU1SARE8WVtTQ6+lSAolh8mB6ouCSRhAz5iIxLABmkR/CEG6r5AvtDS1XOfVjmyvJHXPUSyoTHXpBESNKAEU+/4oO3pQ9JWIob9014KHGr+c6iQj7UkouN8oSYBR7nBlMWESJ6KGqsxusXaWMruWHZCUEmxijLTbYwbPNyUdUVF7YmFSivL/+K/2Wmwax9JrZ3Y7Lzp6WZ3eysqiumbSyENc1B1DEIz+cnVBceBwqWOBnvndrpqgrljVFrBec5EB3PqP1YnT2rDpFtMjiTvsQwIEH8NfNsJ4j6u7mODXic6Lmw9meIbsJDGz0coXooHQvyRw8gGY6RbMVtyrUj0pd7Q5BeKMOoFd1E0qZmxZW08pNdTseqsZRv767+vx874H3BxGbSKIax4ZwvPPc4PpNc44hp9Bkf414sPAKAOXA5sJyo8/Q2Y21QC1Oyn1hNfPf+RWSMdTc+UnGG7yj9ctNVvZw3lKj5vf4z6xZbheI9BVV1ySUFfbS3ilAPqPoefUEf4l0Cy1bGlBSOsnih9WP5NUjgu7yH7Owtvu3nnE4eXRtAa1E10ij1LHrmXzG9ysO8AKmNq7wu+kALFh63BFf3COl9gGhWXk5OapIVPb59K6T9a6P6PgXTf4WicH/+fCPiCLOmpW2NVQ/9N40g5U/e5YLq14KdMvY1EUTcEdav9sBgNQ6x/kunar8LCLdrXYpnYOY01ScfeQcy9Ugrq1cliM lWpBH+fy 0YtlAFl2ah8a14xtswK6PjSf176tra/3+46F5SytqPNji7zvr2Pk4jwK3G/1mzt3rSLSpSK6LgvA9iRg7VPZnLOpQwQR9z2vyntywceC+NgOEKZdCNzsV4HhxnIX7fP/MiNb5ukqNm0BCQCbNpoLRQMQ5dOG3KUaymDJL7GKMN1+ueqKdvUY8oY3eB0c+bllql5eNu8wSncpltmJZMHcfdD3K+gbjsu5UP93Hymtzs3egndSu9TtDnw2nqfv/i9yfdySlT8sDaVS8fKrQE6gKa6xMMmQWldW2FRv+tqKWgoFJKDcosDCErcJojD9TO43MVZjG2KrVsRNZE9uESHHdlUXsy5i2a9ia4/QPYB9rmUCzQcC/Pi3EGuTDbLVs9POhkQ+LSYfJqc5iEFu5Y2rl3aQf8nbZzO8AHVJ8Qx8b3ssOChg= 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: Jonathan Cameron writes: > On Fri, 04 Apr 2025 11:37:28 -0400 > N=C3=ADcolas 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=C3=ADcolas 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. That seems like a way to add a significant amount of pain to a basic (but indeed useful) cleanup patch like this. If the relevant maintainers insist on it then that's how it has to be done, but I bet I could just take the whole thing through docs with almost no trouble. jon