Extend and rework the "Temporary Virtual Mappings" section of the highmem.rst
documentation.
Do a partial rework of the paragraph related to kmap() and add a new paragraph
in order to document the set of kmap_local_*() functions. Re-order paragraphs
in decreasing order of preference of usage.
Include kerneldoc comments from include/linux/highmem.h and remove
redundant and obsolete section about kmap_atomic().
v1-v2:
1/2 - According to comments on v1 by Matthew Wilcox and Ira Weiny,
correct a mistake in text, format paragraphs to stay within
the 75 characters limit, re-order the flow of the same
paragraphs in decreasing order of preference of usage.
2/2 - No patch.
v2->v3:
1/2 - No changes.
2/2 - Added patch to include kernel-doc to highmem.rst and
remove the now redundant section about kmap_atomic().
Fabio M. De Francesco (2):
Documentation/vm: Extend "Temporary Virtual Mappings" section in
highmem.rst
Documentation/vm: Include kernel-doc to highmem.rst
Documentation/vm/highmem.rst | 96 +++++++++++++++++++++---------------
1 file changed, 56 insertions(+), 40 deletions(-)
--
2.34.1
On sabato 16 aprile 2022 01:19:15 CEST Fabio M. De Francesco wrote:
> Extend and rework the "Temporary Virtual Mappings" section of the
highmem.rst
> documentation.
>
> Do a partial rework of the paragraph related to kmap() and add a new
paragraph
> in order to document the set of kmap_local_*() functions. Re-order
paragraphs
> in decreasing order of preference of usage.
>
> Include kerneldoc comments from include/linux/highmem.h and remove
> redundant and obsolete section about kmap_atomic().
>
> v1-v2:
> 1/2 - According to comments on v1 by Matthew Wilcox and Ira
Weiny,
> correct a mistake in text, format paragraphs to stay within
> the 75 characters limit, re-order the flow of the same
> paragraphs in decreasing order of preference of usage.
> 2/2 - No patch.
>
> v2->v3:
> 1/2 - No changes.
> 2/2 - Added patch to include kernel-doc to highmem.rst and
> remove the now redundant section about kmap_atomic().
>
> Fabio M. De Francesco (2):
> Documentation/vm: Extend "Temporary Virtual Mappings" section in
> highmem.rst
> Documentation/vm: Include kernel-doc to highmem.rst
>
> Documentation/vm/highmem.rst | 96 +++++++++++++++++++++---------------
> 1 file changed, 56 insertions(+), 40 deletions(-)
>
> --
> 2.34.1
>
Dear Maintainers,
Please drop this patch because it has been reworked and inserted as part of
a new series whose subject is "Extend and reorganize Highmem's
documentation" and which is about to be submitted.
Thanks,
Fabio M. De Francesco