Received: by 2002:a25:1985:0:0:0:0:0 with SMTP id 127csp795559ybz; Fri, 1 May 2020 08:41:12 -0700 (PDT) X-Google-Smtp-Source: APiQypJJYaT4pOb6cbx87BenNoMca9QRGxX6lBPfqt3gCdoyfAM0eRZLKTpKt983eRpcEK1tZ8QW X-Received: by 2002:a17:906:74c:: with SMTP id z12mr3824266ejb.87.1588347672159; Fri, 01 May 2020 08:41:12 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1588347672; cv=none; d=google.com; s=arc-20160816; b=EbtAz9C037eh90wtFPdopQT2DrsXqvY3eKjyAsNzVK23C4t6eWOOykm0AojwQrfMMY scw+j5ZVq5i3eudPWhSZ4xaynHzlAXRJV69vCgOasBIQwNyotxYYKcTIoydYdzi3RXoN p6aENaoq+Y1qS6Q4Nh3wPkSfbVUH0ttV+zfuYknN/8UqfXJHopngdwPtsb7P8aV5j+Z9 U6GRMfsA+ALw6IAIZ/P5k3nWB0eukIqc/qKLedgZ3nmF81rSrk2sycGSPW2bXaZTDoKh OT9TqDJoytQ/Q6Lg3F5r6eCAMXVShY5+EBxG1A0pLQK/o3mt9dHcSdLR2yBkGzH2Eo9V Iu5g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=NnZnExBQoG76TeAdlpxRgdCBzri4EDJFbyQEmdhp7KI=; b=GKYQ2eRVCSs3uWGB0S5QSryvGEb+Gqfa2AG+PXLplBUX49jmQZm/Fzx4joeAS6v6ur 2cJXnRd88lVsgH1j9NqFfddvsp6rmQneCni0itGz87fJYW7eB0wmMyBt4gESWi9N1obL T1NNv1UuVU7VH1nEthcdknDtdNyhp1WrbP+wOeaQGgmtEhWbi5Glo3OjIgg5OrisoUCv Lpb2up6TrnZp/YbEKc8vzSWjR4JC1Lr8IdqwO/iYnMVcNuA/RotAUIXPYvxS5y/0SOxe ViAYtXd1vjcKlR7fZiZQ4XzDmKA0wL2mLT/8ZnqVph9gaUUC/R3MNGEjk+mUMmwam5TD D+7Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=etq06kbG; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id t7si1964111edi.315.2020.05.01.08.40.49; Fri, 01 May 2020 08:41:12 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=etq06kbG; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730012AbgEAPic (ORCPT + 99 others); Fri, 1 May 2020 11:38:32 -0400 Received: from mail.kernel.org ([198.145.29.99]:52542 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729853AbgEAPiF (ORCPT ); Fri, 1 May 2020 11:38:05 -0400 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 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 -- 2.25.4