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 29F5CC36010 for ; Fri, 4 Apr 2025 17:43:47 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 742236B0007; Fri, 4 Apr 2025 13:43:46 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 6CCA06B000E; Fri, 4 Apr 2025 13:43:46 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 545DC6B0010; Fri, 4 Apr 2025 13:43:46 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id 31C606B0007 for ; Fri, 4 Apr 2025 13:43:46 -0400 (EDT) Received: from smtpin07.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id 9F351160699 for ; Fri, 4 Apr 2025 17:43:45 +0000 (UTC) X-FDA: 83297084010.07.0413771 Received: from nyc.source.kernel.org (nyc.source.kernel.org [147.75.193.91]) by imf07.hostedemail.com (Postfix) with ESMTP id 277604000D for ; Fri, 4 Apr 2025 17:43:43 +0000 (UTC) Authentication-Results: imf07.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=J4KPLgyY; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf07.hostedemail.com: domain of sj@kernel.org designates 147.75.193.91 as permitted sender) smtp.mailfrom=sj@kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1743788624; 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=CVpjpyZ90nxMR9O1nH7CdqvQxhWzU4ekajBODCtUhYQ=; b=pZGJwumGSSuYkXlFQhAb3vkNQJiXtkSNW2gB34aEQVTI29Bd8ywgZEfioAcT8VuXDiuD4B vyOamGQhdn6dYKJy7VajJuhVLT1qyWtHbcC53v8djSpAR+l7zKMOWIuLUW8RNmLfuU6uB9 cneoEoqAGv6hfY/KMjrFFaqSgwQ/KAg= ARC-Authentication-Results: i=1; imf07.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=J4KPLgyY; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf07.hostedemail.com: domain of sj@kernel.org designates 147.75.193.91 as permitted sender) smtp.mailfrom=sj@kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1743788624; a=rsa-sha256; cv=none; b=L2Ars7iw2Wc6xcHUpi41Hp8a1NxlXmCYRMXKxLwm9VAiqIE20wZX02RWF3vPpcAlwRdzj6 WkwkSB+u9/jVabEQjE5wwLfVaGgAEtjM07+mUvcIGn2LHfNm4lcNJEpwhxawCUV3ej7p1f sdi71KEqiYFgIAVD45PShl/vcvyPW2o= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by nyc.source.kernel.org (Postfix) with ESMTP id 7641BA41702; Fri, 4 Apr 2025 17:38:14 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id C47B2C4CEDD; Fri, 4 Apr 2025 17:43:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1743788622; bh=WJeqcUtnD+JvPCp95BzhzODUCYYMvFFmmq3rDIUcqSs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=J4KPLgyY3xGfSNoxx05BGJCDtfOgYphVQM1ZoldOdeeso2SYhM1km51rPHKPwB/pQ GJ06NvvjBNhsMQzJIvUMvXMETtTXsO0LWkcjP7CtqBfxJSSCZoye7qjPeoiOx1kiDt ZWKMHiBmHZU27kWXOQI7fbYGkDq4pvMtkkRYR1VoVIR6ij5Gkg20gJVinnvxc+4Hln 0pLMb4KNxVCrO46a7TfFtjc086KPWG07DJC5spzimeJtmGzO94ULDmiHBAOlWDVvJp ZHbUkDK/UYEW9K0mv7yvUZ5RZIpRiMCeq9pji34ELH1v5T9ZN5jyVg1V4+LWXJ2tCM WVxxdgswoKZSw== From: SeongJae Park To: =?UTF-8?q?N=C3=ADcolas=20F=20=2E=20R=20=2E=20A=20=2E=20Prado?= Cc: SeongJae Park , 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 , 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 Date: Fri, 4 Apr 2025 10:43:39 -0700 Message-Id: <20250404174339.59650-1-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250404-doc-paths-unliteral-v1-1-74718785444e@collabora.com> References: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Server: rspam11 X-Rspamd-Queue-Id: 277604000D X-Stat-Signature: ci5oqkqr1p8m3n4sfwjfqz5f336ponb9 X-Rspam-User: X-HE-Tag: 1743788623-790388 X-HE-Meta: U2FsdGVkX18kN2OM7HNdnmq2JWs3NKuJ1KdLC/XB/Rgicp70/+LJkt1ztVrnthRM4sGHfX+fwRpdH+GqzRxx9RZi+oMR1bXrz6KRgY4mVXOUI51TRSGMn4Ibko+aUbkJ2Ok7Hcp+vu5alcglazGuoxAIh7gdriTnYMvCgsvTYwdQwF/tljMbL1r+jG/z4wYtOpxNMVJ5PPJVYPFJi6EMUe+Qoy63W+Rt31pN31n2Jtuf5GgI5+hdzaNL7t3nQrqI6uxQLzM7ATjI9i+IpDX/Ps0HGUjqP7zi4eQJM51PUDmDK2VK/fwrDOZZOTE/pIz+qa/uQATxc8NogJIvp/NlVgjVVpIPtayidgF3E2Bx9zsUPUf9NXW8Mi3q6BfjtY3BS5ymdAjri7/lv906BZZRdNV/I+YsNy54zOsLQQQoLAzJAw4PpKPveHSLlCfTZWSweIcvTEg7sg7LijCA3QW/TODIe+pd/bf8RzY/fBYK5xqgeoZJ6Su0lfo3sa0KdyOQstMNqpUiaCubTFVtkpynJP2MQPfOmmkzW+y9l04ZCSaVmsfKFPQzGBim26Znw2lDxQmLJqQhRX91DOpPjJG5RwxoCWxBnqHnGp73ZY1HF6ZNIlvCf3rFzikp0NbLDfhKj1LqMLP9/MBXPz8o/GarDd/X8y5OunHfrr/3lCnDX2vhAGEaUfVE+dCUN8lZI15TsBbowbkf0+EhDEqt+nwZewPNKjJN97v42yjCpH0GNQOzOCA8wFbXLVbbCAt+NKrBaU3IQsSCIj0Cr86KyAQ7+T/d2tvY9pAMvB52uF+bOKVG8b759KDnkeWgha/quJ+c06M+++nAxkbX+c32vKtqX0UTCDfw8022W5h2fFcxW0fRU7XNLI3nlaMcLpq+pQ+0JoFzlaNRxbY= 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ícolas 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). > > 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...'). > > Signed-off-by: Nícolas F. R. A. Prado Acked-by: SeongJae Park Thanks, SJ [...]