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 1EFECC77B7C for ; Sun, 21 May 2023 23:51:04 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 6C901900003; Sun, 21 May 2023 19:51:03 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 679D5900002; Sun, 21 May 2023 19:51:03 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 540D7900003; Sun, 21 May 2023 19:51:03 -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 40532900002 for ; Sun, 21 May 2023 19:51:03 -0400 (EDT) Received: from smtpin24.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id EC54AADCB5 for ; Sun, 21 May 2023 23:51:02 +0000 (UTC) X-FDA: 80815910364.24.E452FE6 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) by imf02.hostedemail.com (Postfix) with ESMTP id 1B74D8000F for ; Sun, 21 May 2023 23:50:59 +0000 (UTC) Authentication-Results: imf02.hostedemail.com; dkim=pass header.d=google.com header.s=20221208 header.b=gfucSj6q; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf02.hostedemail.com: domain of rientjes@google.com designates 209.85.214.172 as permitted sender) smtp.mailfrom=rientjes@google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1684713060; 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=jvjqxPZp4zM42J7m6i96fEFOa0fFNA+qng6dxkik49g=; b=eyC3eHXJ+cOv/L3Z90sChdgheAUwd2ePGHZ+ybL/3cU6kNTbRjioarYOZTLPqVKk84W+Of 8YaTOAvYITT5RzwAC0aUGbKvF8QgdNWafog+bZ71Pr+2Q2GbWXTOyURNb8cDql7EADhlX9 zng/8mOZ1+GWoNq+B+ZLe5wX9pmJX+g= ARC-Authentication-Results: i=1; imf02.hostedemail.com; dkim=pass header.d=google.com header.s=20221208 header.b=gfucSj6q; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf02.hostedemail.com: domain of rientjes@google.com designates 209.85.214.172 as permitted sender) smtp.mailfrom=rientjes@google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1684713060; a=rsa-sha256; cv=none; b=oiKfc/u9BDdxTa++KxAPoWGXylQvSdwJP3pE+asqdrXKtuzQ156w1s2VuKQtjJzuZg8eHj SyIEL9vcXAzhhI2KKYUp2Wve/pbBlmxW/bCGW2swEW1EwMnJbOVoxenkouWLpJbYeIe+Kh LV73JLJzTYwC+n43L0ZI6zuzC2NMss4= Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-1ae3f74c98bso164555ad.1 for ; Sun, 21 May 2023 16:50:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20221208; t=1684713059; x=1687305059; h=mime-version:references:message-id:in-reply-to:subject:cc:to:from :date:from:to:cc:subject:date:message-id:reply-to; bh=jvjqxPZp4zM42J7m6i96fEFOa0fFNA+qng6dxkik49g=; b=gfucSj6qKz+rTuqDU25QnGc/+4qg41jZZ2U6FfyQzNJ6cu+EFjXdSBnwKqgMlWFI46 6AZSsawMSMf4kYpUYV+b4VhrSKHLlcYaLiXnc+4A2L2hGYUOthrEO8sahDnqHjyeCR88 HWGXuPbnQkMSUGy5zb6WYT/V8bMYdMoDSk0rc+DNe/IfKFkNm3pkd6f0r1f2RSkgi/Qx cL829xuK07K79+B4C7vVLkdPIhff2bIvlO551coWqI+cycEu7JtxV54bzQgLR8UBzyWl Ko7S/FXWUMtGcce9wC7hro1u68znkdhqUoW2v792plyqQd3do2kQsPrlncfPzdZ6NTPN ozfA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684713059; x=1687305059; h=mime-version:references:message-id:in-reply-to:subject:cc:to:from :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=jvjqxPZp4zM42J7m6i96fEFOa0fFNA+qng6dxkik49g=; b=JEq0vAjn7Ni7Nwzu/laeFst9JRChN6ZqZ+6BDRj03hTneRFA7FJN9Fa5HNGWQDAsQd RBC9cSy+xnC/hHYr6UHa8Q95fqykuSzynVDI21yoAKiwnQ5J/WPQeOPbRKFD4WmIthBO CbfGR3EZM/nIN2/FR5cc2n2AlBLQMxcHPiPCaZl62UglJ8Vz7IurkOjq+bwhBjj1kttf VFshLKLJjd32JyNlDqfEQ7oZSDRVNxrqc1MlxZR92IqDKxpbZO6QYzoSQPfq6ji/87Dv IhGuBnulXItGFiOLTPyCLfHnUaMglRvB9l1DfgixyttMA04hA8AiVlrIg+lLR6mwpwu3 jZvg== X-Gm-Message-State: AC+VfDyXsL4kOstbh9gm3p528BAzv+J0iAULMu46FnhKKhWzsZYBvus1 4XCm5A8FKUbHPI0ptFr7izG/4A== X-Google-Smtp-Source: ACHHUZ41f4GbJiWPWbmdaDhbhWMCaXvwYIjr/6D/IjC4wrf4V3NWEipc9CjIVjjSZAgG1kyS86HZxw== X-Received: by 2002:a17:903:230f:b0:1aa:ea22:8043 with SMTP id d15-20020a170903230f00b001aaea228043mr709023plh.7.1684713058857; Sun, 21 May 2023 16:50:58 -0700 (PDT) Received: from [2620:0:1008:11:c77c:12d8:c868:4106] ([2620:0:1008:11:c77c:12d8:c868:4106]) by smtp.gmail.com with ESMTPSA id i21-20020aa78b55000000b0064ced750dcfsm2961265pfd.164.2023.05.21.16.50.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 21 May 2023 16:50:58 -0700 (PDT) Date: Sun, 21 May 2023 16:50:57 -0700 (PDT) From: David Rientjes To: Jonathan Corbet cc: Mike Rapoport , Lorenzo Stoakes , linux-mm@kvack.org, Matthew Wilcox Subject: Re: [LSF/MM/BPF TOPIC] mm documentation In-Reply-To: <87lehocnxv.fsf@meer.lwn.net> Message-ID: References: <20230512173732.GI4135@kernel.org> <5aa1cb82-b39e-47c9-bb7a-c6145b2acbd3@lucifer.local> <87lehocnxv.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII X-Rspamd-Queue-Id: 1B74D8000F X-Rspam-User: X-Rspamd-Server: rspam02 X-Stat-Signature: wmqsq3fd3fd46d58f5q47kxcgort5gos X-HE-Tag: 1684713059-729368 X-HE-Meta: U2FsdGVkX1+lCFUWphIKtBUzSJh63AFoW0KdZJ2FYz7xMGRsuOX/1wJQgBu8zowAdPAsOZRtDU5UEfSFtxsu4riObDQ3DPfhzQQ8hf/uhLZkqFxDCrCxL5U5M2s+v3SZ5GU+9tvfdeTT7tE+1wdKzgC7n+FXgZ1fq8r3bZD2UH7RrikqgMMGfMpmZ5i0+Zl/pA1Yc4GIUAR6QmU8AiwPQ9VsX/Rym0UQkuqkCvdktDLlGEadBSAenUidkIE3Zc/ptRLOyLW5zHf5EHe3C/m9ZpeqPyIbJiiQK4xmBFPld5UjbDNvUmZzETsjEeHc29Obd4NE/JONDPlMk/0zWgCxp2c2+kdAVHcjGJ/bvjHpT7AVN5JBhIJ+gPrL7O8CXWm7PImfYodolfxEUrzxZe7E1KSyhRzaVey3T2MU3HyQhorbhtloULAVOVZgVb4jyEiyoFRFnMCklCi+PkbiEtCXKHuOsg+AjQLfaRbjDjuiDg85fpyVWVGKtzSEB2mZETURxIb9C0UnrdhAblemoc35a7BCxiP6g6w0aLlxEt+owIoyYLSpS3VhZbX+394WEhnckXSCU/b6920cyjE8Y2P3nqkSdjFsjzyaAM9mnFCR93EBmDQG1JRXIeakwejwRYIgHCRPRW+3xBad8HCnmRU0QfplI6Jzq6vzk5EUVc1y1cNyNYvnRpWy1FGReIs8Hwcb6LkZWziTd0181+Q3MXeWm1soInOoGsMOUaTRTtxfxLaH4/1WODnQ2aFuWpWryt6lulVsiErhO3aekzPB3N/vatRYI54arZUTpDDxK1l7OF0uSziQtHFSEN5h7bydf9GP45rB74S6d8tWB93sbUDVgEAimpHKcvs9NDa7dbrGf5IPf6Rn5zWyAtQ//PqkahjFHdoAbhySmqwgAg8yBryn/SJdRl4NIhohK5lCTHLEi8CTmX4MiLRiEG2KuTOY+/BFsRV2TJ1vQAPovHXIe76 MOqMMD9R i9V1wnWdZRwJs+RGB0aVrX0gjkr9TJHbv+V1nHd+xqJOOqhfAWDPZU+Zadt6gcIJOSTI4yHqiuvDJLGs21IbxstB4+OlKarhyiiVkPcRpfv+ogpIAunkdJc3tpbRjoUc0Tb63iKvm65p1rZ3YEOoLMZ+sWL1/Qyg/UDUkjWfmmWqi7DABXamKclcx1BxoJ2CeUyfH8ppzdGABbm/LU7nBSTFQG5M5Fr+jHvDGizorAagF4og/1MQ03AjK+B1bhQiDkV/qT6ZJAYkq+d9kXJtKpYnPkt04Zkcl8lQoqlDjl9O4PrI0RIjDFr+wi4vyxJhgJIW8LtPh3pDFzI1PEKg57Q7P86ZbFGjSfkPH4HGNvIgEHkxbJ4PX7xKhEQ== 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: On Tue, 16 May 2023, Jonathan Corbet wrote: > >> > And if we are going to participate in projects like Outreachy and Google > >> > Season of Docs, we can suggest a project "Convert Lorenzo's book to kernel > >> > documentation" alongside "Write more MM documentation" project. > >> > >> Yeah, this could be a good starting point actually, as rather than starting > >> from zero, people would have some material that they can cross-check. > > > > I'm going to suggest "MM docs" for the next Outreachy round and I'll ping > > you then about the "Convert Lorenzo's book to kernel documentation" > > project. > > > > As for participation in the Google Season of Docs, maybe this should be > > more broad than only mm docs. > > Jon, what do you think? > > Sorry, I'm still catching up from travel and have a lot of digging out > to do... > > Converting relevant bits of the book to RST seems like a great project. > In theory pandoc can do that, but I've never tried it and can imagine > that a fair amount of tweaking is required. > > Season of docs definitely seems worth looking into, but we've missed the > bus for this year. Something to keep in mind next January. > I think both of these programs are useful for importing mm documentation that is up-to-date at the time that it's imported. I'm concerned that the documentation will quickly become out of date, however. If mm documentation were imported before the introduction of folios or per-vma locking, for example, it would likely need large scale changes. Maybe the idea is that any documentation, no matter how outdated, is better than no documentation. This may not always be the case, however: how often have people become frustrated that the documentation that does exist doesn't actually reflect the current state of the kernel anymore? Mike, I think one of the goals you were trying to achieve at LSF/MM/BPF was how this documentation would not only get originally created/imported, but also how it would stay relatively up-to-date. To keep the documentation current, I think the burden would likely need to fall on the kernel hakcers who are actually developing the code?