From patchwork Fri Aug 18 20:06:26 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matthew Wilcox X-Patchwork-Id: 13358306 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 C4D2EEE4992 for ; Fri, 18 Aug 2023 20:06:46 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id A2FBA940077; Fri, 18 Aug 2023 16:06:45 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 9DED1940012; Fri, 18 Aug 2023 16:06:45 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 8A660940077; Fri, 18 Aug 2023 16:06:45 -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 796A7940012 for ; Fri, 18 Aug 2023 16:06:45 -0400 (EDT) Received: from smtpin15.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 50C861A11CE for ; Fri, 18 Aug 2023 20:06:45 +0000 (UTC) X-FDA: 81138308370.15.6972324 Received: from casper.infradead.org (casper.infradead.org [90.155.50.34]) by imf20.hostedemail.com (Postfix) with ESMTP id B2CC91C0005 for ; Fri, 18 Aug 2023 20:06:43 +0000 (UTC) Authentication-Results: imf20.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=Odxo8Ikq; dmarc=none; spf=none (imf20.hostedemail.com: domain of willy@infradead.org has no SPF policy when checking 90.155.50.34) smtp.mailfrom=willy@infradead.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1692389203; a=rsa-sha256; cv=none; b=ywqOP03wTe65BX1QzHk344ZG4YcENWPe7yzIAbaW4mz8V7WpUpOahzomIcXNYiRDOIARwC i2HZFbgUObTClKsOgcZ7xG90djE6b+ILfCcpX1rMZSJYXqdqUkVo5kMvqokxDVbpHEXV1d Oj4Z3YLFddesH9yKbywIx/JMOaJmC5Q= ARC-Authentication-Results: i=1; imf20.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=Odxo8Ikq; dmarc=none; spf=none (imf20.hostedemail.com: domain of willy@infradead.org has no SPF policy when checking 90.155.50.34) smtp.mailfrom=willy@infradead.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1692389203; 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-transfer-encoding:content-transfer-encoding: in-reply-to:references:dkim-signature; bh=sS4yQXJ2Ya3KF8lqJJez/ry2mxKfhg1PxX5ngqnXF1w=; b=Uq4Eq3+FNB/RlMD+OmHG028CbyIV3D7hFzsXD+2glc2A7kUgDoNPV3maCSCH/0vUaRogi+ vxog9x7U6IwRtA/2flgtMQSUFdAolngHfoYOk0PTAQEexZHhB0llCoGodXwPv/c9BykiQA Xu45cCO2lHuAZoZAIK7F1bU8vzfK4x8= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:MIME-Version: Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:In-Reply-To:References; bh=sS4yQXJ2Ya3KF8lqJJez/ry2mxKfhg1PxX5ngqnXF1w=; b=Odxo8IkqUnJLxGrSY+DvFGfooH vN+ao/DDJPwfKbeLt8qj9IuL1ZDN1NGpEL/LvlZ5ixQyLt1dNz8c7rJJYraWBJvqWa2QYDyuhRmJS /dNWPMrBKeMQm2eUN3tqTYt2wNsE/q7NMsavULQgQgN6F5EbX1PZ5d2ZVaF+UnchLCSDpNzK3yDCU 0VUy5K31ZVPWwGxjaEARqeh07lVygSoTG+RJAZKVIXjEQRj+lgJ5FLX/XHVYxYkguU1POn5V0lBCr F0ha0kOAx8ywFl/XMawCQYsXk7yqhZuQDWglk8fnQpw8bvNEbjOeXDdeJYTaOZ+IzSjejRcFp58Qt 1kr/K7Xw==; Received: from willy by casper.infradead.org with local (Exim 4.94.2 #2 (Red Hat Linux)) id 1qX5js-00BPV6-Du; Fri, 18 Aug 2023 20:06:32 +0000 From: "Matthew Wilcox (Oracle)" To: Andrew Morton Cc: "Matthew Wilcox (Oracle)" , linux-mm@kvack.org, Mike Rapoport , linux-doc@vger.kernel.org, cgroups@vger.kernel.org Subject: [PATCH 0/4] Improve mm documentation Date: Fri, 18 Aug 2023 21:06:26 +0100 Message-Id: <20230818200630.2719595-1-willy@infradead.org> X-Mailer: git-send-email 2.37.1 MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Server: rspam06 X-Rspamd-Queue-Id: B2CC91C0005 X-Stat-Signature: 3zphoz6noff83hsfpmu5ywghzfpnqd8w X-HE-Tag: 1692389203-162926 X-HE-Meta: U2FsdGVkX1+L8zOT4Be3XwPHp2w/JkSJiwCv2KH9OvmwwYE/mG3NM7Tc0WvidjTyBarAePZWRoPLrOt0NLuBPK6ZpgiAQBndNVUF8Lxz9QzYFkcRZsnVtRbT3S+a7UQaKXDgb9tEar+LiZAstxqKVSLRuRgesV4aj15BI1Ki15Ks1oBpcWM8UzzdQUrsQRSeiOIpgWLj+l47bqcsvjdn5pAS9Im8aWlUj3VabYBNFgWIrc1nj16uXYpZpUaeAofeGlAFHs4lxDexvrLZm4HAXIp09ZPyhzfBSeXmSAQZjUiw6r1BSP/Bh6msUmoMVNkLK5YoiDkrhA6UARHm7xQRK/TxuUEfoBDDNym0hdhzahAVsoS+cRJzOV4IvghxhCb1XKBESC2SIl/2Huj1x+arg/sQof/uRKS5B4kJf3oYSiAwwB8k2wuUAN9+yZAEMUbRYlsbGSD6wGiBwtuuKXiC84BA7SQL6hMebJom0OwskhroQ2WvZm1dxoeSSlPyZJJO626UAvHd9zROJbLkOjwV020EubiAFQQX52XjX0YSoxYAeLF7GPgoOewH8LZ5Mdl+N3Lnbx9C45jBKozeZjSh22j3Hkx6CQZGt6CYSB7WimxhzE3/Dmspj6AkyNkztHbnAd9UdeCZi/CLo7eRzYMtOek5ltPFGWsGv3iA0VwvZIps/HvAG8hgSBDaZSXKRm5uOotU2UpmImNN1uPSW6zLf8MLrBT1t1sjqp9j8RwX6rkQegR2YsjnLcgZ9pSGsYOxe1jLAkjDtlkn3Xbn3AUKrbCfLGgRre5lqrANz9dprGG/g/2wJC7x2pk5gkX17+tWY7C/SUldU34lSBtfYaPMDIs8KsoH/jB1GKLah0bGTT6sps/HeWjFCgl6qnBv7zQ8hu1P3v5mC6Yse46uUMB4EAfe9ZQEYcg3tph9W9pGE2F+IHZfFFNTFs7zZiBhgie2cnMlHPm5pkiTGGJNyX8 vCkrQyiz GLGvPrUrroJxkpQwek7PAWatjDJNzqvNpLnjTFDlk5StlX34+SgLLabPOnWloz+r8a1Z5/UivzXlb3vEcsd0xjv0ClNA/g0/vpLQTiAxSpMxrPWwgJsylo2tslQ== 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: If you build with W=1, kernel-doc complains about tlb_flush_rmaps(). Then I ran scripts/find-unused-docs.sh against mm/ and found a large number of files which weren't included in the ReST documentation. I fixed up a couple of them, and added all those without erros to the rst files. There's a lot more work to do to organise all of this, but at least now if we have documentation that refers to these functions, we'll get a nice link to them. Matthew Wilcox (Oracle) (4): mm: Fix kernel-doc warning from tlb_flush_rmaps() mm: Fix get_mctgt_type() kernel-doc mm: Fix clean_record_shared_mapping_range kernel-doc mm: Add orphaned kernel-doc to the rst files. Documentation/core-api/mm-api.rst | 25 +++++++++++++++++++++++++ Documentation/mm/highmem.rst | 1 + Documentation/mm/zsmalloc.rst | 5 +++++ mm/mapping_dirty_helpers.c | 11 ++++++----- mm/memcontrol.c | 31 +++++++++++++------------------ mm/mmu_gather.c | 1 + 6 files changed, 51 insertions(+), 23 deletions(-)