From patchwork Fri May 1 15:37:55 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11522801 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id CA78192A for ; Fri, 1 May 2020 15:38:06 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 8699424957 for ; Fri, 1 May 2020 15:38:06 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="etq06kbG" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 8699424957 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id BDDB18E0005; Fri, 1 May 2020 11:38:05 -0400 (EDT) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id B8C5B8E0001; Fri, 1 May 2020 11:38:05 -0400 (EDT) X-Original-To: int-list-linux-mm@kvack.org X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id A7AEF8E0005; Fri, 1 May 2020 11:38:05 -0400 (EDT) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0054.hostedemail.com [216.40.44.54]) by kanga.kvack.org (Postfix) with ESMTP id 8D9468E0001 for ; Fri, 1 May 2020 11:38:05 -0400 (EDT) Received: from smtpin30.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay04.hostedemail.com (Postfix) with ESMTP id 487C83AA3 for ; Fri, 1 May 2020 15:38:05 +0000 (UTC) X-FDA: 76768556130.30.crowd06_468ae02095e21 X-Spam-Summary: 2,0,0,4ec8bbe6220addb6,d41d8cd98f00b204,mchehab@kernel.org,,RULES_HIT:2:41:69:355:379:541:800:960:973:988:989:1260:1311:1314:1345:1359:1437:1515:1535:1605:1606:1730:1747:1777:1792:1801:1981:2194:2198:2199:2200:2393:2538:2559:2562:2892:2901:3138:3139:3140:3141:3142:3865:3866:3867:3870:3871:3872:3874:4120:4321:4605:5007:6119:6261:6653:6742:6743:7903:7904:7974:8784:8957:9149:10004:11026:11232:11473:11658:11914:12043:12291:12296:12297:12438:12517:12519:12555:12679:12895:12986:13161:13229:13894:14096:14394:21080:21325:21451:21627:21984:21990:30012:30034:30054:30060:30067:30070:30075,0,RBL:198.145.29.99:@kernel.org:.lbl8.mailshell.net-62.14.0.100 64.201.201.201,CacheIP:none,Bayesian:0.5,0.5,0.5,Netcheck:none,DomainCache:0,MSF:not bulk,SPF:fp,MSBL:0,DNSBL:neutral,Custom_rules:0:0:0,LFtime:33,LUA_SUMMARY:none X-HE-Tag: crowd06_468ae02095e21 X-Filterd-Recvd-Size: 9020 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by imf12.hostedemail.com (Postfix) with ESMTP for ; Fri, 1 May 2020 15:38:04 +0000 (UTC) Received: from mail.kernel.org (ip5f5ad5c5.dynamic.kabel-deutschland.de [95.90.213.197]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 37C702496C; Fri, 1 May 2020 15:38:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588347483; bh=X9IwW9Dgu1ZI2pQWkGwOoQW72Fqs/UdpS+9EuBxTAMQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=etq06kbGpfocH4wTcLTCj5CUBNhx2E/wFL1e+ua6SGhKezE5HsiwpYvhwXnQ4SgvV J3u04HIdzbDjrs9SmxDE8PV9whI77H2Agr6IHtE6R/o19qvwVdZu+svjo4+0biyrfQ ZAwxiVZkBiKcWs6jSwfiVZgv+n93c3NVjMPF0bI0= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jUXjl-00FE59-7w; Fri, 01 May 2020 17:38:01 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , David Airlie , Daniel Vetter , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , Andrew Morton , Andy Shevchenko , Sebastian Andrzej Siewior , Mike Rapoport , Peter Xu , Masahiro Yamada , Daniel Jordan , Peter Zijlstra , "Aneesh Kumar K.V" , Catalin Marinas , Ingo Molnar , Alexandre Ghiti , Arnd Bergmann , Thomas Gleixner , Peter Collingbourne , Frederic Weisbecker , Krzysztof Kozlowski , Will Deacon , "Steven Rostedt (VMware)" , Masami Hiramatsu , Tejun Heo , Patrick Bellasi , Dan Williams , "Eric W. Biederman" , "Joel Fernandes (Google)" , dri-devel@lists.freedesktop.org, linux-mm@kvack.org Subject: [PATCH 11/14] docs: move other kAPI documents to core-api Date: Fri, 1 May 2020 17:37:55 +0200 Message-Id: <70cca102282ccd36b107487c60346f414011c684.1588345503.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 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 a number of random documents that seem to be describing some aspects of the core-api. Move them to such directory, adding them at the core-api/index.rst file. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/sysctl/vm.rst | 2 +- Documentation/core-api/index.rst | 6 ++++++ Documentation/{mailbox.txt => core-api/mailbox.rst} | 0 Documentation/{nommu-mmap.txt => core-api/nommu-mmap.rst} | 0 .../{this_cpu_ops.txt => core-api/this_cpu_ops.rst} | 0 .../unaligned-memory-access.rst} | 0 Documentation/gpu/drm-mm.rst | 2 +- arch/Kconfig | 2 +- init/Kconfig | 2 +- mm/Kconfig | 2 +- mm/nommu.c | 2 +- 11 files changed, 12 insertions(+), 6 deletions(-) rename Documentation/{mailbox.txt => core-api/mailbox.rst} (100%) rename Documentation/{nommu-mmap.txt => core-api/nommu-mmap.rst} (100%) rename Documentation/{this_cpu_ops.txt => core-api/this_cpu_ops.rst} (100%) rename Documentation/{unaligned-memory-access.txt => core-api/unaligned-memory-access.rst} (100%) diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst index 0329a4d3fa9e..0bf2f2a84a9f 100644 --- a/Documentation/admin-guide/sysctl/vm.rst +++ b/Documentation/admin-guide/sysctl/vm.rst @@ -583,7 +583,7 @@ trimming of allocations is initiated. The default value is 1. -See Documentation/nommu-mmap.txt for more information. +See Documentation/core-api/nommu-mmap.rst for more information. numa_zonelist_order diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index eeac63ba17c3..fe03a639a91a 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -38,10 +38,14 @@ Library functionality that is used throughout the kernel. circular-buffers rbtree generic-radix-tree + mailbox packing + rbtree + this_cpu_ops timekeeping errseq + Concurrency primitives ====================== @@ -82,11 +86,13 @@ more memory-management documentation in :doc:`/vm/index`. :maxdepth: 1 memory-allocation + unaligned-memory-access dma-api dma-api-howto dma-attributes dma-isa-lpc bus-virt-phys-mapping + nommu-mmap mm-api genalloc pin_user_pages diff --git a/Documentation/mailbox.txt b/Documentation/core-api/mailbox.rst similarity index 100% rename from Documentation/mailbox.txt rename to Documentation/core-api/mailbox.rst diff --git a/Documentation/nommu-mmap.txt b/Documentation/core-api/nommu-mmap.rst similarity index 100% rename from Documentation/nommu-mmap.txt rename to Documentation/core-api/nommu-mmap.rst diff --git a/Documentation/this_cpu_ops.txt b/Documentation/core-api/this_cpu_ops.rst similarity index 100% rename from Documentation/this_cpu_ops.txt rename to Documentation/core-api/this_cpu_ops.rst diff --git a/Documentation/unaligned-memory-access.txt b/Documentation/core-api/unaligned-memory-access.rst similarity index 100% rename from Documentation/unaligned-memory-access.txt rename to Documentation/core-api/unaligned-memory-access.rst diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst index 1839762044be..e0bbcbb6f512 100644 --- a/Documentation/gpu/drm-mm.rst +++ b/Documentation/gpu/drm-mm.rst @@ -314,7 +314,7 @@ To use drm_gem_cma_get_unmapped_area(), drivers must fill the struct a pointer on drm_gem_cma_get_unmapped_area(). More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.txt +Documentation/core-api/nommu-mmap.rst Memory Coherency ---------------- diff --git a/arch/Kconfig b/arch/Kconfig index 786a85d4ad40..b0b4046c9d13 100644 --- a/arch/Kconfig +++ b/arch/Kconfig @@ -147,7 +147,7 @@ config HAVE_EFFICIENT_UNALIGNED_ACCESS problems with received packets if doing so would not help much. - See Documentation/unaligned-memory-access.txt for more + See Documentation/core-api/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config ARCH_USE_BUILTIN_BSWAP diff --git a/init/Kconfig b/init/Kconfig index 492bb7000aa4..61ccfd9243e3 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -1950,7 +1950,7 @@ config MMAP_ALLOW_UNINITIALIZED userspace. Since that isn't generally a problem on no-MMU systems, it is normally safe to say Y here. - See Documentation/nommu-mmap.txt for more information. + See Documentation/core-api/nommu-mmap.rst for more information. config SYSTEM_DATA_VERIFICATION def_bool n diff --git a/mm/Kconfig b/mm/Kconfig index db626b8d4fdb..2a133c40a4b7 100644 --- a/mm/Kconfig +++ b/mm/Kconfig @@ -382,7 +382,7 @@ config NOMMU_INITIAL_TRIM_EXCESS This option specifies the initial value of this option. The default of 1 says that all excess pages should be trimmed. - See Documentation/nommu-mmap.txt for more information. + See Documentation/core-api/nommu-mmap.rst for more information. config TRANSPARENT_HUGEPAGE bool "Transparent Hugepage Support" diff --git a/mm/nommu.c b/mm/nommu.c index 371697bf372d..e3e707d6f124 100644 --- a/mm/nommu.c +++ b/mm/nommu.c @@ -5,7 +5,7 @@ * Replacement code for mm functions to support CPU's that don't * have any form of memory management unit (thus no virtual memory). * - * See Documentation/nommu-mmap.txt + * See Documentation/core-api/nommu-mmap.rst * * Copyright (c) 2004-2008 David Howells * Copyright (c) 2000-2003 David McCullough