* Re: [PATCH 11/14] docs: move other kAPI documents to core-api
2020-05-01 15:37 ` [PATCH 11/14] docs: move other kAPI documents to core-api Mauro Carvalho Chehab
@ 2020-05-02 7:43 ` Mike Rapoport
2020-05-15 18:10 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Mike Rapoport @ 2020-05-02 7:43 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, linux-kernel, Jonathan Corbet,
David Airlie, Daniel Vetter, Maarten Lankhorst, Maxime Ripard,
Thomas Zimmermann, Andrew Morton, Andy Shevchenko,
Sebastian Andrzej Siewior, 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, linux-mm
Hello Mauro,
On Fri, May 01, 2020 at 05:37:55PM +0200, Mauro Carvalho Chehab wrote:
> 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
The nommu-mmap mostly provides description of user visible behaviuour. I
think it's bettter to have it in admin-guide/mm/.
> .../{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 <dhowells@redhat.com>
> * Copyright (c) 2000-2003 David McCullough <davidm@snapgear.com>
> --
> 2.25.4
>
--
Sincerely yours,
Mike.
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH 11/14] docs: move other kAPI documents to core-api
2020-05-01 15:37 ` [PATCH 11/14] docs: move other kAPI documents to core-api Mauro Carvalho Chehab
2020-05-02 7:43 ` Mike Rapoport
@ 2020-05-15 18:10 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2020-05-15 18:10 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, linux-kernel, 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, linux-mm
On Fri, 1 May 2020 17:37:55 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> 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
> .../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%)
This one doesn't apply for me. Beyond that, I'm not entirely convinced
about a couple of the moves...
- mailbox.txt seems like driver-api stuff to me?
- nommu-mmap.txt is mostly (though not completely) about the semantic of
mmap() options as seen by user space, so perhaps belongs in that
manual...?
Thanks,
jon
^ permalink raw reply [flat|nested] 3+ messages in thread