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 03BCBC36010 for ; Sat, 5 Apr 2025 01:17:30 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 201D06B0007; Fri, 4 Apr 2025 21:17:29 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 188486B0008; Fri, 4 Apr 2025 21:17:29 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 0018B6B000A; Fri, 4 Apr 2025 21:17:28 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id D3B806B0007 for ; Fri, 4 Apr 2025 21:17:28 -0400 (EDT) Received: from smtpin30.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id 432D780B6B for ; Sat, 5 Apr 2025 01:17:29 +0000 (UTC) X-FDA: 83298227418.30.5172D6D Received: from mail-pl1-f170.google.com (mail-pl1-f170.google.com [209.85.214.170]) by imf21.hostedemail.com (Postfix) with ESMTP id 4CAC61C0008 for ; Sat, 5 Apr 2025 01:17:27 +0000 (UTC) Authentication-Results: imf21.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=I1mxFjrz; spf=pass (imf21.hostedemail.com: domain of akiyks@gmail.com designates 209.85.214.170 as permitted sender) smtp.mailfrom=akiyks@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1743815847; 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=NRiuL4Sy1s+c/lXgB3vFyCUJTB29r4cpXB4vQmrcmqI=; b=vvui3tkxOAmbThE46oq5w/YZpAc1haqbQVeMlUjB0csTicMjjTZ2PFzHPKieOqR8ahj1KU WwOCZWIwZmWKQD8rH6rIW0NeM1eSfH4aXoydaRXHNbWnjPfyfs07ij0uREpU3XLfqlMqr0 kKQCADfZhFJQ9894UZ3yFkFLuAcU/9E= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1743815847; a=rsa-sha256; cv=none; b=jzNxefTPiT683ljxvRJ94JEV6LeMtM2wRXx/9fyxL78WhyAJoXVTqiVlg/sI2N/r5DQAps r2MgnZokiGQpsVh7CTRqaEQZ5xHKvbCfMZ8aM9BCQDjxU3tYBoawAajBLmXCZmVab5E8+N JqQSycYX9g1vJ8qt3IIAo5YobrhXYp4= ARC-Authentication-Results: i=1; imf21.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=I1mxFjrz; spf=pass (imf21.hostedemail.com: domain of akiyks@gmail.com designates 209.85.214.170 as permitted sender) smtp.mailfrom=akiyks@gmail.com; dmarc=pass (policy=none) header.from=gmail.com Received: by mail-pl1-f170.google.com with SMTP id d9443c01a7336-22622ddcc35so34701575ad.2 for ; Fri, 04 Apr 2025 18:17:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1743815846; x=1744420646; darn=kvack.org; h=content-transfer-encoding:in-reply-to:from:content-language:subject :references:cc:to:user-agent:mime-version:date:message-id:from:to:cc :subject:date:message-id:reply-to; bh=NRiuL4Sy1s+c/lXgB3vFyCUJTB29r4cpXB4vQmrcmqI=; b=I1mxFjrzVM0+ju4jJm2w2JyTEdwlZdni9OF+pWaBVQT/UnmMy9mtVIpvaCv7aTEcwR vkpmRszViD3d2fRhHn7MKsOGU5Jn6iwHnhi++7974KkVtJhGpOkoZvk1uqJ7VJ/h0z0H b9zJeo6hgW7mWY1HUPgkAsGVe/orZE3eO9ZzXDHJAycN2TzoGTBDF2G4jz7vJGiLHcQh mdAKN+c2YPgGpzdXMznfT2jYuMn4GbiCaNIfqX6G1DjMEC8VGCqj3yJ7bPA/NfMm3Pgm vimeDX8XXm+Ls+DNln7br2ybFMkVE89UcMQjziVCybLa+pgk/4EiiowDaNijJx0nesSz g6cw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1743815846; x=1744420646; h=content-transfer-encoding:in-reply-to:from:content-language:subject :references:cc:to:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=NRiuL4Sy1s+c/lXgB3vFyCUJTB29r4cpXB4vQmrcmqI=; b=Z0eQn7e0T/OzPbinVI/I3DBxY7FpKkdCF6Z63iDgq3JRBoNzOKeNua4gD3pSFkWKAC FAzwzL7goMl9aHUFvWgau2ZIRnaAKv5vIq1UAlPnI7jmrfJKfvmsI37mmEOsmRkAkqOU eWvzh4jI2upVel7A+sI7GDBogKqCFcRE7RL+scWxCFo1/Jhrczr3GpU8fldagPPmjP4e qf7ulqDzCmii6JZfJxN1wcu2TiY+d5kbom+IYfH6efl6cjqAaUHgGGUPW4L7FZjdLvJ8 KWjeQd9I1BtFFuDuC3S7qgiXwrpYtBT9bauGwhrRjrMMBKdtUP0TmPrm3rCb5Cc9F4pu akMg== X-Forwarded-Encrypted: i=1; AJvYcCVkc4Ou/j8nobXTq+OwuaQkU1T6Sg8nRQdBEaWBElT9wKjn0KPzR9bocDobrQyKGZc4Mqxxhbwjtw==@kvack.org X-Gm-Message-State: AOJu0Yw4MH40p5hbOwT6k65MA0XwTgPTeP32rR4oIiFUfIZWpZjSTOZR CaKXGG/ynhhZ/J6m5+fZYJIYzE25Mb040HGexL2S75Zy+rbgY/0v X-Gm-Gg: ASbGnctFn68NW0oU3mO81FDq3PkJIkzHaXSca637ZYyYyFYs/WqayN0wVgoTmuPyKHh sMYPdquzLWOONv7A0XW/NA0mbPsDfJudmy4dNmcJo1OEOXI4te0A+uU3ItMdwBPmSPkZ/AYhfzc l36RHvJ+uK+aHzhxCA+PA6hvrT3jhL++KTnE1aSPp8L6ekeSqIDGOsYQvdipj+a0pZ7DwN9Hv6r 1yQFMkQ4p8m2paIuqK8NOXNEwWKJlb53BoiEcWUMH7lSsEF9h6E4AI7fuNFh62L2/GqY2QJDw3X bGUme4lk7vQQpuypBf7J81WFLe1U6zbokFWFFr1N3V2BF6XjVKcdgOPdNK9mKwvB4yBgtJwFyz7 TZ9cnvhfsLFVH3hg= X-Google-Smtp-Source: AGHT+IGrKFiapGLIEGHnSEZIAujUvj6ZJLSj064m/nFeE0wcOjOeNVFt0u8EmZ8qnV5tFeQau4dR7A== X-Received: by 2002:a17:903:3c6b:b0:224:24d3:6103 with SMTP id d9443c01a7336-22a955734f5mr25800795ad.35.1743815846125; Fri, 04 Apr 2025 18:17:26 -0700 (PDT) Received: from [10.0.2.15] (KD106167137155.ppp-bb.dion.ne.jp. [106.167.137.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-229785b352esm39374225ad.18.2025.04.04.18.17.18 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 04 Apr 2025 18:17:25 -0700 (PDT) Message-ID: <811c4103-08b1-4288-9a15-bd9795bc59f4@gmail.com> Date: Sat, 5 Apr 2025 10:17:16 +0900 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird To: nfraprado@collabora.com Cc: James.Bottomley@HansenPartnership.com, akpm@linux-foundation.org, anton.ivanov@cambridgegreys.com, corbet@lwn.net, davem@davemloft.net, dmaengine@vger.kernel.org, ebiggers@kernel.org, edumazet@google.com, horms@kernel.org, jaegeuk@kernel.org, jarkko@kernel.org, jic23@kernel.org, johannes@sipsolutions.net, kernel@collabora.com, keyrings@vger.kernel.org, kuba@kernel.org, lars@metafoo.de, linux-doc@vger.kernel.org, linux-fscrypt@vger.kernel.org, linux-iio@vger.kernel.org, linux-integrity@vger.kernel.org, linux-kernel@vger.kernel.org, linux-media@vger.kernel.org, linux-mm@kvack.org, linux-sound@vger.kernel.org, linux-um@lists.infradead.org, maxime.chevallier@bootlin.com, mchehab@kernel.org, netdev@vger.kernel.org, pabeni@redhat.com, perex@perex.cz, richard@nod.at, tiwai@suse.com, tytso@mit.edu, vkoul@kernel.org, workflows@vger.kernel.org, zohar@linux.ibm.com, Akira Yokosawa References: <20250404-doc-paths-unliteral-v1-1-74718785444e@collabora.com> Subject: Re: [PATCH] docs: Remove literal markup from Documentation/ paths Content-Language: en-US From: Akira Yokosawa In-Reply-To: <20250404-doc-paths-unliteral-v1-1-74718785444e@collabora.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Stat-Signature: tyadcqdmzquxs3jofqs3gowdy6z4cfz5 X-Rspam-User: X-Rspamd-Queue-Id: 4CAC61C0008 X-Rspamd-Server: rspam08 X-HE-Tag: 1743815847-619131 X-HE-Meta: U2FsdGVkX19RycayhsZHRULW86vDjpfPTRScqu3+9aSIBG8IhPfdvNJD6uql9DZ3A90is6W+nUWUf6JUzJDiiY1dsWVp6Njp+meBzvPvbWqha1Jvm0Uk2pSqSKz3166W6E6qDCJpQaCUhmBqkp13J/HS/LZCD1lZhEcjHH3FQ/xzBCMI0umBKKWAs4gz/qV/uV63JoON4A0tsyVQD9efokB3UxZoUwncelhdxcWx0JnmubXwpXNMsErwD0kvhvz1ETZ44a4Q4tnvDFXkj+Kt5aL536AtICNSG7qVqdBOMmQ87wC2jtAtH2Uz9w4dywmTj/+VQ6UjRUqFah053rN1JnWXhxuGosPKuOf3T/RVVchy4keMiWDjG2q5e1FNpeWkWM26RG6V+oZNIEIMrXsRdkYWNwR1cDOqgjmtwFRpKVdUl6DdBI5d1pmaiVQo+HWSSsPpIKsSN7r2tBZosbpHNHTOYKHERPReNv6QdajXNCBBEk1vBJyI22YnWTyodrDpmcHD83HMmrz8f8SWgaRe+twZAP04Z1M4qrVdjn33xM7AWQDsCVeXcL3kUU4bk6CC/5ab7EeBjbFkC4ScbSHkFhpqwvKJX4LYpgSwKZjjrgzxX6TK3X0BgWPy40aq2VCFZMukWXdSUhThepNkPYFUHgHmwdE/HLqiL27EEbOjxaHqKX42vXURGciSjq8k/PYbXYFDt/mnfThmv9/lvyufhlKTIp0s8hKGkyE8O7r0AwYBbCFGCMbx9r+CdRVDUILwmmzvADCkDdkVZr2kKNKuj7xSjL0faAMuJBDUqSF5O7GGvK4SRPrLB/zEsMzpgbuzh1vs8TAqO+GnOi/BpdZHZ98r4/3ozWKs848bZ+1Uf1sTX5Ig9zJw8OlrANxPYfZGcCflNv2eKeVYDXxMW+02l4i1UB2WkdX5iX0pnagEiMcQPSmj2iJT2BtoQzlizqk7pPO/ck7GNzs8iBsp+Fb mbUQ9Ro5 eMf1WgIgSnsGDf4ewoB0j88mJddYUBQhBAUroIUq+J+B/RG+r/9jse4a6p+Zhqi7JdezrBojiJHiqcDQm8YPDIabf3AIY8XqI7zf9XMCftBeI+sgvD1lO2baKTd9n3i3t391sYvJB5weQtNBOQpcdXFZ6MD1BnNpv6ojWPlx3PD6XSADQ2q5gwKXX884p/x2tZpZ9ZMwU62PW+H7iIU0mD4EnbXKg03itwCTVXgVuwnw0gJ0s5vA9TSd1LkYbmrcifSbbg2+MKwLKzLQLtAC6idHf5/25RUlZ8S5fwQBmVQzC6oIvBJjXMrRpXtnLMtyFr93nAxkN16jc9N4/deZ2IFUDOtfXK8nhjD8cggUmwddVRm3zxeA/DjwjQ71weJYQJ+yTe/Txj5fFP/TYLOs6iQ9H+Zq7n4gMHwG/t0dSMNhDSMZmsUD66y5geYgRohTWOFwFZkAhViZQbHHCA+YrtUcR9gV37oVmCzbQzGvcAwbkeU6TCmGW7+oWXyxaam13xBrf X-Bogosity: Ham, tests=bogofilter, spamicity=0.000037, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: Hi, 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 > --- [...] > Documentation/process/submit-checklist.rst | 7 ++++--- I have updated ja_JP translation of this recently. > diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst > index beb7f94279fdb6a1d9b4aa86b2bea031f140732b..3ae31c5af2cb5c374658c1fb7125e70bf36e911c 100644 > --- a/Documentation/process/submit-checklist.rst > +++ b/Documentation/process/submit-checklist.rst > @@ -30,7 +30,8 @@ Review Kconfig changes > > 1) Any new or modified ``CONFIG`` options do not muck up the config menu and > default to off unless they meet the exception criteria documented in > - ``Documentation/kbuild/kconfig-language.rst`` Menu attributes: default value. > + Documentation/kbuild/kconfig-language.rst, under "Menu attributes", "default > + value". I have made the same change in the translation, but failed to submit a patch... > > 2) All new ``Kconfig`` options have help text. > > @@ -47,7 +48,7 @@ Provide documentation > 2) All new ``/proc`` entries are documented under ``Documentation/`` > > 3) All new kernel boot parameters are documented in > - ``Documentation/admin-guide/kernel-parameters.rst``. > + Documentation/admin-guide/kernel-parameters.rst. Hmm, this item is asking "Have you documented the new params in that particular file?", so I don't think this change should be made. > > 4) All new module parameters are documented with ``MODULE_PARM_DESC()`` > > @@ -58,7 +59,7 @@ Provide documentation > linux-api@vger.kernel.org. > > 6) If any ioctl's are added by the patch, then also update > - ``Documentation/userspace-api/ioctl/ioctl-number.rst``. > + Documentation/userspace-api/ioctl/ioctl-number.rst. Ditto. Thanks, Akira > > Check your code with tools > ==========================