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 B8CC8C433F5 for ; Tue, 1 Feb 2022 19:03:28 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 1F7FF8D007E; Tue, 1 Feb 2022 14:03:28 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 1A6D18D006D; Tue, 1 Feb 2022 14:03:28 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 095978D007E; Tue, 1 Feb 2022 14:03:28 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0196.hostedemail.com [216.40.44.196]) by kanga.kvack.org (Postfix) with ESMTP id EE39D8D006D for ; Tue, 1 Feb 2022 14:03:27 -0500 (EST) Received: from smtpin09.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay03.hostedemail.com (Postfix) with ESMTP id A164D82F7DBC for ; Tue, 1 Feb 2022 19:03:27 +0000 (UTC) X-FDA: 79095134454.09.D4FA32E Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf10.hostedemail.com (Postfix) with ESMTP id 27302C000E for ; Tue, 1 Feb 2022 19:03:27 +0000 (UTC) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 0EC5761620; Tue, 1 Feb 2022 19:03:26 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id D7AD2C340EB; Tue, 1 Feb 2022 19:03:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1643742205; bh=+PxX8wJllTy15VLbd1bPOFfoGzfDzb99XQzT/EoVziI=; h=Date:From:To:Subject:From; b=RCyNmYQTQJWhDXav7q6YT4jZ64nER5PqqLxuaI8Uf65ykoVypwV62GjfNAQnY6Lbj JZte28UqUTahXMTm6uqTxrqTjPxpEoxsH81PagDoDp4+LdOZyqDIPVgNMdTIb3AVGy QEWwWvDAS67fERNbTMcqYxqy0Jc/Li+WTtntFfz3IM6lY9ZIo5fN9Xc0/rvG46MRJT lwBs9AMGbSZ0ICdTz+i2BtS2BnKU+VeC4Q7pTe+EYLad5Y0atKE/RNozSGOsFJzT53 fBXevl7bXT0U6829GfEtqElc89Ea7NQtv/V7CsgMtzz056HtAwpwsjKossktK5WGGu cmxwjWAEyVAuQ== Date: Tue, 1 Feb 2022 21:03:16 +0200 From: Mike Rapoport To: lsf-pc@lists.linux-foundation.org, linux-mm@kvack.org Subject: [LSF/MM/BPF TOPIC] mm documentation Message-ID: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline X-Rspamd-Queue-Id: 27302C000E X-Rspam-User: nil Authentication-Results: imf10.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=RCyNmYQT; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf10.hostedemail.com: domain of rppt@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=rppt@kernel.org X-Stat-Signature: sgqsop4fihn76axowe31h7mbypmcq8sp X-Rspamd-Server: rspam08 X-HE-Tag: 1643742207-265406 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000023, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Hi all, I'm suggesting this topic for a while now, maybe if we finally get to talk about it in person something will improve :) The mm documentation is, well, not entirely up to date. We can opt for dropping the outdated parts, which would generate a nice negative diffstat, but identifying the outdated documentation requires nearly as much effort as updating it, so I think that making and keeping the docs up to date would be a better option. I'd like to discuss what can be done process-wise to improve the situation. Some points I had in mind: * Pay more attention to docs during review * Set an expectation level for docs accompanying a changeset * Spend some cycles to review and update the existing docs * Spend some more cycles to add new documentation * Participate in programs like Google Season of Docs I'd appreciate a discussion about how we can improve the existing memory management documentation so that a reader can get a coherent view of it, what are the gaps (although they are too many), and what would be the best way to close these gaps. -- Sincerely yours, Mike.