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 F3147C5AD49 for ; Tue, 3 Jun 2025 15:05:37 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 6DC426B049C; Tue, 3 Jun 2025 11:05:37 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 68C216B049E; Tue, 3 Jun 2025 11:05:37 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 5A2E36B049F; Tue, 3 Jun 2025 11:05:37 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id 425676B049C for ; Tue, 3 Jun 2025 11:05:37 -0400 (EDT) Received: from smtpin05.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id B969F140CF3 for ; Tue, 3 Jun 2025 15:05:36 +0000 (UTC) X-FDA: 83514413472.05.A045DC7 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by imf25.hostedemail.com (Postfix) with ESMTP id F254EA000F for ; Tue, 3 Jun 2025 15:05:34 +0000 (UTC) Authentication-Results: imf25.hostedemail.com; dkim=pass header.d=lwn.net header.s=20201203 header.b=Lu7WMOiH; dmarc=pass (policy=none) header.from=lwn.net; spf=pass (imf25.hostedemail.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1748963135; a=rsa-sha256; cv=none; b=ySqE+iJrmlhjrxRzvCTMSHj5tPwJha7QODyf7hLN2X3mt5KAOWrjyFegM0PyofnCfD+XD1 gLovGR73pIQEsYAqoBr7dgLmME2l6Gk6x2wsSz4qkDckKq5u9GkIWFh8pf7wMXnOBaN0XL WF1tpbSWMdI+6tREll930wfvm0aBBSY= ARC-Authentication-Results: i=1; imf25.hostedemail.com; dkim=pass header.d=lwn.net header.s=20201203 header.b=Lu7WMOiH; dmarc=pass (policy=none) header.from=lwn.net; spf=pass (imf25.hostedemail.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1748963135; 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: in-reply-to:in-reply-to:references:references:dkim-signature; bh=u75W7CrJry5PSsWILVQUlbbLDjglIU1VsldGoh1HdL0=; b=NGT+kXrxl0cioF3JoEEwhTdydBSQDhwhqMyrMFnQfm6t9euvU8XPc38rTtEvc8s6DuVwau 06Ud+rMRrjHJRimvJAfGItOc0Y0hBpeKEOnNCpcDpWbdHhlCAhHQmBq7OY1Ls2q8yGC6Eb vtG6QUJz1mDTkKMXvJYDiJavT51f03k= DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 722A641ED0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1748963133; bh=u75W7CrJry5PSsWILVQUlbbLDjglIU1VsldGoh1HdL0=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=Lu7WMOiHQ70LdZl5nv3BhlYL1rAbVKibnwb/foSODhZW3F2E5RHWrPy/VfE2mYyXh IGAd9y5ZMnwUjIysaIgE3YpLlJY87aagUYrBYC9U3UjcpKsYxUIysV06lKORiKXzLg fBCU1IvBKX2CScnaFejNKg5YPRjZvilgYM4e1+Nnp1zcaz1+wq6Y0UnZoxhZnUNdEV i4wxN0fJ/gjEqugyryjhusx6MiwVQsSSez2nZcqCf5RjfxDM2aFXhrKKggUYo00saJ 1P/BvUuYOOz+Ccs0VjOzH9+rmJdFHkKMttTdFA5R6FniC0p0inKL8C0ItnDGRTggfL aRchLLoGELZaw== 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 722A641ED0; Tue, 3 Jun 2025 15:05:33 +0000 (UTC) From: Jonathan Corbet To: Lorenzo Stoakes Cc: Andrew Morton , Suren Baghdasaryan , "Liam R . Howlett" , Vlastimil Babka , Shakeel Butt , Jann Horn , Qi Zheng , linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH] docs/mm: expand vma doc to highlight pte freeing, non-vma traversal In-Reply-To: <1b340b71-6664-48ff-b783-aa89fa5b0b16@lucifer.local> References: <20250602210710.106159-1-lorenzo.stoakes@oracle.com> <87bjr59634.fsf@trenco.lwn.net> <9fc9ac50-abce-48bd-979f-2e00b26917b5@lucifer.local> <8734cg9auh.fsf@trenco.lwn.net> <87tt4w7uxo.fsf@trenco.lwn.net> <1b340b71-6664-48ff-b783-aa89fa5b0b16@lucifer.local> Date: Tue, 03 Jun 2025 09:05:32 -0600 Message-ID: <87ldq87tmr.fsf@trenco.lwn.net> MIME-Version: 1.0 Content-Type: text/plain X-Rspamd-Server: rspam08 X-Rspamd-Queue-Id: F254EA000F X-Stat-Signature: fxebe4jpmpnfp375ux7zqx8itchkffih X-Rspam-User: X-HE-Tag: 1748963134-55 X-HE-Meta: U2FsdGVkX1+b9qcjxdfBGgduQyM6hwlKO2aFfbHn8fIjvJfFz/wIPM25m36dGviznetA35TgnxhdFD975dLzwIqDIh+HcWiQtjxwyeXu9N/7FALceVOzm7bmdUU7tyct0JoszZiRwhFeb4ElXDsQz3BKUFm6Nv1DXzDNlB4sWFUmgWvbSNeGpEeYb8rxwvCEMknxAw1u3PNqbAxbIMW4ze+c2Tyy/ApF0f7q6CVaR3wJ6gzhggs3gBw99HAyQxEFFQFbY5SHSrEWevd4GCCSDQ2JwmD8fTCynZ/wHYnjciv4SK/+QSlQwRAAenuap+OpImL1iJxx0LNAh4phIkS5UZ0R/C5vaR1oUbAsfsg8sv+Er7u0eX7Ny4kVfxKDiBQ5TdGN4GZFzCOxNhvDtf6P2J24WF9uYgFRvQOFxy3Br13SzRwKt4Xx+ncqATYBjChhRjJrLpS/fYS1buj8+58ouZCgyXzCW9FVdUvgmh+UmXXtJL2i8/jlYQ4gxkhvOKgKqcP/6GSpAVPW1pAlxg+ccFCY2NpPOi3oMs+8T7u6i2qZpwXAGnXH7AyzSW+/sSbnkuVg7e9AK4z/UWePc7w13nNQXfJspSlLgmk0XE291zApPVMy45JlpAFxhyJkNH/it8edrdll5tytGn9Y6frTbkxwcGEJafT38/u9nGIYdGLDctaYkbtfYhW092kFqPBIpztN9XzRyr3mmUtt9aObxy6nDfi8qM2lCYJf0IgJWJuFBgBL9IoaSCX2n3m4XyrZzWs8ATBnLbFaML0VMkrgvU249s7wWhwjuLcMJQD2jfFYwJGN9p/N8b82Ea8Za3UTOapLATqXiu75wMs/9jOpjvqKSPjNR8mB/xQtWZoka0BWpVx9wqPSAv8rw2aekj1eakl+MTBstd6spqt1LZ/INkxOkLM88yGEkBJGMLiL9C35J7s2QaS8SYUawjNoPaex431cTgDr9cxedvH3bZp 4AW8ZDF5 EuetUKe1/8wPHYzqLdSzwm6wGctaraajwuWVfBw9I+j4Bw3QridJnr/QFZgemHYlmbS/9XGDe8Dzhe9uqF0wbaii2JyzG4tufE8zCHV2ngCsKsfK/Jt6pyeNIWOin7U0on5rJrFsxoSkAWBSfCauhjofdrUD5wj8La4CE+QwX9ZAWf6q1yLSSREz30684P8K+s9N2CUA0urxCcuRf7uzKCyTmJx3y6WPzXYsBePdH76vs4qc167iUcGiPkvqR1rIz0bu/onHcl/Br+yNRQ1N6oM58KYSoluJuFzbCgKmo7ED3h68oLzZpFse14Q== 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: Lorenzo Stoakes writes: > Thanks, I appreciate that. So I want to address your concerns as well as I > can. I think I have misunderstood you a little bit here too (text is a poor > medium, yada yada) so let me try to nail down what I feel is the sensible > way forward: > > 1. Once I am confident I have correctly addressed Jann's feedback I'll > respin a v2 with the various 'sins' in place for the time being. > > 2. I will also drop the 'since v6.14' stuff you rightly raised in this > respin. So far so good > 3. I will create a follow-up series to address these issues in this file > -in general-: > > - Drop '!' from every reference so we get automated cross-referencing - I > think now I understand the point (hopefully!) that Sphinx with > automagically link every unique reference to a function/struct/etc. to > one another. If you just drop the "!" you'll run into the "struct" problem you mentioned before. You'll need to take out "struct" as well if you go this route... > - Perhaps hack in a **struct ** prefix so we get the 'best of both worlds' > on this for types...? ...so yes you'd need to do that. > I think my misapprehension about defining functions was not realising that > by doing :c:func:etc without the ! would automatically provide that > definition upon first reference to that function/struct/etc.? > > Is that correct/sensible? > > Would you want me to only use the :c:func: stuff in the _first_ mention of > a function and then to not use it from then on? > > I wonder if the _appropriate_ use of :c:func:...: is in the actual > definition, but since it's not really practical to do that right now* is > simply doing it upon first mention a sensible 'least worst' approach here? Here, I think, we've gone a bit off track again. The goal of the automarkup code was to *never* need to use the :c:func: markup. Let's just say that ... certain members of our community ... found that markup entirely intolerable - and, in truth, it is ugly. So I wrote the initial automarkup extension; now, any time that the docs build sees function(), it looks for documentation for that function and creates a cross-reference if that documentation is found. The goal is that you should never need the :c:gunk: ever. Thanks, jon