From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>, David Airlie <airlied@linux.ie>, Daniel Vetter <daniel@ffwll.ch>, Maarten Lankhorst <maarten.lankhorst@linux.intel.com>, Maxime Ripard <mripard@kernel.org>, Thomas Zimmermann <tzimmermann@suse.de>, Andrew Morton <akpm@linux-foundation.org>, dri-devel@lists.freedesktop.org, linux-mm@kvack.org Subject: [PATCH 19/22] docs: move other kAPI documents to core-api Date: Mon, 15 Jun 2020 08:50:24 +0200 [thread overview] Message-ID: <633998e4e7c3c3bb340f69d4a02f0ee9e7f9306f.1592203650.git.mchehab+huawei@kernel.org> (raw) In-Reply-To: <cover.1592203650.git.mchehab+huawei@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 <mchehab+huawei@kernel.org> --- 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 .../{process => core-api}/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/{process => core-api}/unaligned-memory-access.rst (100%) diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst index d46d5b7013c6..9f7fa2d37fa7 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 721e40a8c65b..2a364dd533de 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -38,11 +38,15 @@ Library functionality that is used throughout the kernel. circular-buffers rbtree generic-radix-tree + mailbox packing + rbtree + this_cpu_ops timekeeping watch_queue errseq + Concurrency primitives ====================== @@ -83,11 +87,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/process/unaligned-memory-access.rst b/Documentation/core-api/unaligned-memory-access.rst similarity index 100% rename from Documentation/process/unaligned-memory-access.rst 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 8cc35dc556c7..2a439fb8069e 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 3327f0eca1a3..4218a60f5f79 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -1957,7 +1957,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 f2104cc0d35c..6c6189724b75 100644 --- a/mm/Kconfig +++ b/mm/Kconfig @@ -387,7 +387,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 cdcad5d61dd1..8f2e502ad8a3 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 <dhowells@redhat.com> * Copyright (c) 2000-2003 David McCullough <davidm@snapgear.com> -- 2.26.2
WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org> Cc: Thomas Zimmermann <tzimmermann@suse.de>, Jonathan Corbet <corbet@lwn.net>, Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, linux-kernel@vger.kernel.org, linux-mm@kvack.org, David Airlie <airlied@linux.ie>, dri-devel@lists.freedesktop.org, Andrew Morton <akpm@linux-foundation.org> Subject: [PATCH 19/22] docs: move other kAPI documents to core-api Date: Mon, 15 Jun 2020 08:50:24 +0200 [thread overview] Message-ID: <633998e4e7c3c3bb340f69d4a02f0ee9e7f9306f.1592203650.git.mchehab+huawei@kernel.org> (raw) In-Reply-To: <cover.1592203650.git.mchehab+huawei@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 <mchehab+huawei@kernel.org> --- 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 .../{process => core-api}/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/{process => core-api}/unaligned-memory-access.rst (100%) diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst index d46d5b7013c6..9f7fa2d37fa7 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 721e40a8c65b..2a364dd533de 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -38,11 +38,15 @@ Library functionality that is used throughout the kernel. circular-buffers rbtree generic-radix-tree + mailbox packing + rbtree + this_cpu_ops timekeeping watch_queue errseq + Concurrency primitives ====================== @@ -83,11 +87,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/process/unaligned-memory-access.rst b/Documentation/core-api/unaligned-memory-access.rst similarity index 100% rename from Documentation/process/unaligned-memory-access.rst 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 8cc35dc556c7..2a439fb8069e 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 3327f0eca1a3..4218a60f5f79 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -1957,7 +1957,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 f2104cc0d35c..6c6189724b75 100644 --- a/mm/Kconfig +++ b/mm/Kconfig @@ -387,7 +387,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 cdcad5d61dd1..8f2e502ad8a3 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 <dhowells@redhat.com> * Copyright (c) 2000-2003 David McCullough <davidm@snapgear.com> -- 2.26.2 _______________________________________________ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
next prev parent reply other threads:[~2020-06-15 6:51 UTC|newest] Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-06-15 6:50 [PATCH 00/22] ReST conversion patches (final?) Mauro Carvalho Chehab 2020-06-15 6:50 ` Mauro Carvalho Chehab 2020-06-15 6:50 ` Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 01/22] docs: dt: convert booting-without-of.txt to ReST format Mauro Carvalho Chehab 2020-06-19 20:00 ` Jonathan Corbet 2020-06-15 6:50 ` [PATCH 02/22] docs: thermal: convert cpu-idle-cooling.rst to ReST Mauro Carvalho Chehab 2020-06-19 20:02 ` Jonathan Corbet 2020-06-15 6:50 ` [PATCH 03/22] docs: crypto: convert asymmetric-keys.txt " Mauro Carvalho Chehab 2020-06-15 6:50 ` Mauro Carvalho Chehab 2020-06-19 20:03 ` Jonathan Corbet 2020-06-19 20:03 ` Jonathan Corbet 2020-06-15 6:50 ` [PATCH 04/22] docs: crypto: convert api-intro.txt to ReST format Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 05/22] docs: crypto: convert async-tx-api.txt " Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 06/22] docs: crypto: descore-readme.txt: convert " Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 07/22] docs: misc-devices/spear-pcie-gadget.txt: convert to ReST Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 08/22] docs: misc-devices/pci-endpoint-test.txt: " Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 09/22] " Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 10/22] docs: misc-devices/c2port.txt: convert to ReST format Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 11/22] docs: misc-devices/bh1770glc.txt: convert to ReST Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 12/22] docs: misc-devices/apds990x.txt: convert to ReST format Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 13/22] docs: pci: endpoint/function/binding/pci-test.txt convert to ReST Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 14/22] docs: arm64: convert perf.txt to ReST format Mauro Carvalho Chehab 2020-06-15 6:50 ` Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 15/22] docs: powerpc: convert vcpudispatch_stats.txt to ReST Mauro Carvalho Chehab 2020-06-15 6:50 ` Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 16/22] docs: sh: convert new-machine.txt " Mauro Carvalho Chehab 2020-06-15 6:50 ` Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 17/22] docs: sh: convert register-banks.txt " Mauro Carvalho Chehab 2020-06-15 6:50 ` Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 18/22] docs: trace: ring-buffer-design.txt: convert to ReST format Mauro Carvalho Chehab 2020-06-15 17:48 ` Joe Perches 2020-06-16 7:19 ` Mauro Carvalho Chehab 2020-06-19 20:13 ` Jonathan Corbet 2020-06-19 20:41 ` Steven Rostedt 2020-06-23 8:24 ` Mauro Carvalho Chehab 2020-06-15 6:50 ` Mauro Carvalho Chehab [this message] 2020-06-15 6:50 ` [PATCH 19/22] docs: move other kAPI documents to core-api Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 20/22] docs: move remaining stuff under Documentation/*.txt to Documentation/staging Mauro Carvalho Chehab 2020-06-15 14:03 ` Masami Hiramatsu 2020-06-15 16:18 ` Mathieu Poirier 2020-06-15 6:50 ` [PATCH 21/22] docs: staging: don't use literalinclude Mauro Carvalho Chehab 2020-06-15 6:50 ` [PATCH 22/22] docs: staging: use small font for literal includes Mauro Carvalho Chehab 2020-06-19 20:18 ` Jonathan Corbet 2020-06-19 20:20 ` [PATCH 00/22] ReST conversion patches (final?) Jonathan Corbet 2020-06-19 20:20 ` Jonathan Corbet 2020-06-19 20:20 ` Jonathan Corbet
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=633998e4e7c3c3bb340f69d4a02f0ee9e7f9306f.1592203650.git.mchehab+huawei@kernel.org \ --to=mchehab+huawei@kernel.org \ --cc=airlied@linux.ie \ --cc=akpm@linux-foundation.org \ --cc=corbet@lwn.net \ --cc=daniel@ffwll.ch \ --cc=dri-devel@lists.freedesktop.org \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-mm@kvack.org \ --cc=maarten.lankhorst@linux.intel.com \ --cc=mripard@kernel.org \ --cc=tzimmermann@suse.de \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.