From patchwork Fri Aug 18 20:06:30 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matthew Wilcox X-Patchwork-Id: 13358303 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 EDC49EE498F for ; Fri, 18 Aug 2023 20:06:40 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 54C24940074; Fri, 18 Aug 2023 16:06:40 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 4FD2E940012; Fri, 18 Aug 2023 16:06:40 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3C536940074; Fri, 18 Aug 2023 16:06:40 -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 E6E69940012 for ; Fri, 18 Aug 2023 16:06:39 -0400 (EDT) Received: from smtpin13.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id B49771CA310 for ; Fri, 18 Aug 2023 20:06:39 +0000 (UTC) X-FDA: 81138308118.13.68B74E5 Received: from casper.infradead.org (casper.infradead.org [90.155.50.34]) by imf15.hostedemail.com (Postfix) with ESMTP id 97784A0023 for ; Fri, 18 Aug 2023 20:06:35 +0000 (UTC) Authentication-Results: imf15.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=fOFUrOiJ; dmarc=none; spf=none (imf15.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=1692389197; 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:in-reply-to:references:references:dkim-signature; bh=HEUqudgPIORhVtUepujoEAHkjLRlCh4kIh4ylDVS334=; b=NRn+lo3L5DO0XRl8qumxccTizg9GvwNcQeUvTe3+7+RiZ1fzkKbI8ZE/BaskvaG8CBo+2V hdOQLKxyYcdF4+28+v033KCaOrAqfXffkz0hTgvk92N8wot4CuN4Kb9NxxhRVjMeztPncL BpSm6AeuBIgzhKP/VwJB2QYJugQXXao= ARC-Authentication-Results: i=1; imf15.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=fOFUrOiJ; dmarc=none; spf=none (imf15.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=1692389197; a=rsa-sha256; cv=none; b=kg1JiZhIVnm+NVzfROL4b4SS2wJwZP8DbKzvNge2FowH322cxiN+L9nssCkJ+dM68APzEG frammFNCCtbSNHUpOf/Es78zBW31Iqgb4Z/IJfSVVUOPtPAnLruup0ZQCoopmouhDqNR6j 1xR2+nJFAYBAB+zsaLUr5FWx028viH8= 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: References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To: Content-Type:Content-ID:Content-Description; bh=HEUqudgPIORhVtUepujoEAHkjLRlCh4kIh4ylDVS334=; b=fOFUrOiJoU+PYtWXIoWPp0biHN 1Iq2DbevP7Pj0Xo/lF1SpR5VllaM/JQGPznG3Hqk5Xwy0HQgNVBF0kqx56qtEkZ9YveSgLQD5ltey HeNAHPvW1If7K5JSc3kmmXIjsUGO4iKiKBZQUwC3r8p9h2WDYgK3axUogZZCbsRn9hyNh1W20nr5P jSNtiUDZRYo/5plPR1Q6xFGlrqFsptza3FrnkXM1My+Io2Fq3aTUTxMGlURxE9wEeOvYOOEmk1ZYz VuC0LdL2kbXOmnQwLGUSJJ+Ewit+QsdinLFP3OXV0FInJsbi4m5MR5SvQm02k8nwnErrrcqgx38am qKtG6Lqw==; Received: from willy by casper.infradead.org with local (Exim 4.94.2 #2 (Red Hat Linux)) id 1qX5js-00BPVE-PK; 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 4/4] mm: Add orphaned kernel-doc to the rst files. Date: Fri, 18 Aug 2023 21:06:30 +0100 Message-Id: <20230818200630.2719595-5-willy@infradead.org> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20230818200630.2719595-1-willy@infradead.org> References: <20230818200630.2719595-1-willy@infradead.org> MIME-Version: 1.0 X-Rspamd-Server: rspam09 X-Rspamd-Queue-Id: 97784A0023 X-Stat-Signature: 9urd4f64j4rpbkrcoqjoc1tytkcwtgoa X-Rspam-User: X-HE-Tag: 1692389195-852095 X-HE-Meta: U2FsdGVkX1+Da0DFP7GH43EFmQgfmih7Xn8dpLyzIEbs4Z/nwVqHZX/+Zam8a8HuNgTpqGGlETH8MuhCGea9IHTEPILJNKp7fLWXq4PyHQezaZzj12qMrxh63SuBp1Mn0uOWwx13+/CzXxR3h3kP55jOG4Rh6/P9aBPFM/LYSWvbh0x8kw0MCW6jV33zk69cnnErF465SC0ipp3pfjHa/MgJ7M5oT2fngNMeWuFdrfc/AXXEh7od5Et/fFGYzGCap4PLEEDDouMeqhf/QIZH41cBDg2hSWqXYLAqc4e/6V5YKr4+atbksN9YgEpA4wotHUDe5sk0hK5N/IRk3XTAAwSTe7tMFraKRSLyltZjHSH1DfFMCMXd09PfvYjUznirWmy9g2K8e6afN/WT9UHBj23ce3tZSpI+PH8jk+C2jJeeGI4tHTOFwD025Uei/j3DjR9Aay705F4rjJKIJkqro3q74PV8tukq0UG0tgxzJRliyTAsSfig+Aup7PiAcKPtAXp8nlUvSw4+zz2Hv3yQHV4lfkpx/lfcGHujFiwoJ+2KJjjZEAbD4DF+Q7eKlYNm1bpX5azJlYNnWMM4uLlqgzxbTUloQ3vZhWH9nvIMpCSK/DHUva6/A6SRYo+/wx6OsiF8WcJGJRgcVs+OTKcNu8IQaGM3RYw3otHjKBhzgd6vJ9hEnmE9tLMbWNVF7jz+xIWYltsEQ51MEy7jj9ZBOnAGDR3VdOz3xLJbkTjZOh7im/vnNDEYNPngRJsRi0nob7LGBSDflM3fiPMtNgyvys3SZLeLIZByqqzpvSM+DWj4mW50eetz/pvNtbgIIBI+3+1L2EawALPDt83cKPv7WaIUb6tpwUu/rAR9VVvOkSul3HR7RyPAyfcmx5ad8lkTiYuen+NVvFp3skaSnzxp3U57lOBV5RiIyrmhKdyZkR5tjsMi1z2pNxrNLet2g2ZDBkJPjHR2Zi91gj6DIui UUwqx40L OneICyP+Ce7a+2Edig23jfLp6COvBOi4KFlkFA8hTiWmtc0EgKDKWLR54JTILr+ua8tJHyOdFZlrGJ1IvT67LZSsmUwXLbFf65u26mYxY2HB/zj9p0IS6slDkRK7c3myAaG04/FoZFCixXqX6+pA7zIXsQbYnZw/uaJhukHLTWXQf45oAjcdVfgOF3GxF4QYi6jAda7dkjXzoBQU6Y+OF5dx39OTxfSd1kXJLcv/Nbv4tZRg= 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: There are many files in mm/ that contain kernel-doc which is not currently published on kernel.org. Some of it is easily categorisable, but most of it is going into the miscellaneous documentation section to be organised later. Some files aren't ready to be included; they contain documentation with build errors. Or they're nommu.c which duplicates documentation from "real" MMU systems. Those files are noted with a # mark (although really anything which isn't a recognised directive would do to prevent inclusion) Signed-off-by: Matthew Wilcox (Oracle) Acked-by: Mike Rapoport (IBM) --- Documentation/core-api/mm-api.rst | 25 +++++++++++++++++++++++++ Documentation/mm/highmem.rst | 1 + Documentation/mm/zsmalloc.rst | 5 +++++ 3 files changed, 31 insertions(+) diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst index f5dde5bceaea..2d091c873d1e 100644 --- a/Documentation/core-api/mm-api.rst +++ b/Documentation/core-api/mm-api.rst @@ -115,3 +115,28 @@ More Memory Management Functions .. kernel-doc:: include/linux/mmzone.h .. kernel-doc:: mm/util.c :functions: folio_mapping + +.. kernel-doc:: mm/rmap.c +.. kernel-doc:: mm/migrate.c +.. kernel-doc:: mm/mmap.c +.. kernel-doc:: mm/kmemleak.c +.. #kernel-doc:: mm/hmm.c (build warnings) +.. kernel-doc:: mm/memremap.c +.. kernel-doc:: mm/hugetlb.c +.. kernel-doc:: mm/swap.c +.. kernel-doc:: mm/zpool.c +.. kernel-doc:: mm/memcontrol.c +.. #kernel-doc:: mm/memory-tiers.c (build warnings) +.. kernel-doc:: mm/shmem.c +.. kernel-doc:: mm/migrate_device.c +.. #kernel-doc:: mm/nommu.c (duplicates kernel-doc from other files) +.. kernel-doc:: mm/mapping_dirty_helpers.c +.. #kernel-doc:: mm/memory-failure.c (build warnings) +.. kernel-doc:: mm/percpu.c +.. kernel-doc:: mm/maccess.c +.. kernel-doc:: mm/vmscan.c +.. kernel-doc:: mm/memory_hotplug.c +.. kernel-doc:: mm/mmu_notifier.c +.. kernel-doc:: mm/balloon_compaction.c +.. kernel-doc:: mm/huge_memory.c +.. kernel-doc:: mm/io-mapping.c diff --git a/Documentation/mm/highmem.rst b/Documentation/mm/highmem.rst index fe68e02fc8ff..9d92e3f2b3d6 100644 --- a/Documentation/mm/highmem.rst +++ b/Documentation/mm/highmem.rst @@ -209,4 +209,5 @@ Functions ========= .. kernel-doc:: include/linux/highmem.h +.. kernel-doc:: mm/highmem.c .. kernel-doc:: include/linux/highmem-internal.h diff --git a/Documentation/mm/zsmalloc.rst b/Documentation/mm/zsmalloc.rst index a3c26d587752..76902835e68e 100644 --- a/Documentation/mm/zsmalloc.rst +++ b/Documentation/mm/zsmalloc.rst @@ -263,3 +263,8 @@ is heavy internal fragmentation and zspool compaction is unable to relocate objects and release zspages. In these cases, it is recommended to decrease the limit on the size of the zspage chains (as specified by the CONFIG_ZSMALLOC_CHAIN_SIZE option). + +Functions +========= + +.. kernel-doc:: mm/zsmalloc.c