The patch titled
Subject: mm/doc: include highmem.h in kernel-doc
has been added to the -mm tree. Its filename is
mm-doc-include-highmemh-in-kernel-doc.patch
This patch should soon appear at
https://ozlabs.org/~akpm/mmots/broken-out/mm-doc-include-highmemh-in-kernel-doc.patch
and later at
https://ozlabs.org/~akpm/mmotm/broken-out/mm-doc-include-highmemh-in-kernel-doc.patch
Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a
reply-to-all to that, adding suitable additional cc's
*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***
The -mm tree is included into linux-next and is updated
there every 3-4 working days
------------------------------------------------------
From: "Matthew Wilcox (Oracle)" <willy@xxxxxxxxxxxxx>
Subject: mm/doc: include highmem.h in kernel-doc
There is lots of good documentation in highmem.h that isn't being pulled
into the html documentation. Fix up a couple of minor glitches and
include it.
Link: https://lkml.kernel.org/r/20210722021843.2336117-1-willy@xxxxxxxxxxxxx
Signed-off-by: Matthew Wilcox (Oracle) <willy@xxxxxxxxxxxxx>
Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Cc: "Randy.Dunlap" <rdunlap@xxxxxxxxxxxx>
Cc: Jonathan Corbet <corbet@xxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
---
Documentation/core-api/mm-api.rst | 1 +
include/linux/highmem.h | 17 +++++++++--------
2 files changed, 10 insertions(+), 8 deletions(-)
--- a/Documentation/core-api/mm-api.rst~mm-doc-include-highmemh-in-kernel-doc
+++ a/Documentation/core-api/mm-api.rst
@@ -54,6 +54,7 @@ Virtually Contiguous Mappings
.. kernel-doc:: mm/vmalloc.c
:export:
+.. kernel-doc:: include/linux/highmem.h
File Mapping and Page Cache
===========================
--- a/include/linux/highmem.h~mm-doc-include-highmemh-in-kernel-doc
+++ a/include/linux/highmem.h
@@ -37,8 +37,8 @@
static inline void *kmap(struct page *page);
/**
- * kunmap - Unmap the virtual address mapped by kmap()
- * @addr: Virtual address to be unmapped
+ * kunmap - Unmap the page mapped by kmap()
+ * @page: Page to be unmapped
*
* Counterpart to kmap(). A NOOP for CONFIG_HIGHMEM=n and for mappings of
* pages in the low memory area.
@@ -69,13 +69,13 @@ static inline void kmap_flush_unused(voi
*
* Requires careful handling when nesting multiple mappings because the map
* management is stack based. The unmap has to be in the reverse order of
- * the map operation:
+ * the map operation::
*
- * addr1 = kmap_local_page(page1);
- * addr2 = kmap_local_page(page2);
- * ...
- * kunmap_local(addr2);
- * kunmap_local(addr1);
+ * addr1 = kmap_local_page(page1);
+ * addr2 = kmap_local_page(page2);
+ * ...
+ * kunmap_local(addr2);
+ * kunmap_local(addr1);
*
* Unmapping addr1 before addr2 is invalid and causes malfunction.
*
@@ -119,6 +119,7 @@ static inline void *kmap_atomic(struct p
* the side effects of kmap_atomic(), i.e. reenabling pagefaults and
* preemption.
*/
+static inline void kunmap_atomic(void *addr);
/* Highmem related interfaces for management code */
static inline unsigned int nr_free_highpages(void);
_
Patches currently in -mm which might be from willy@xxxxxxxxxxxxx are
mm-move-kvmalloc-related-functions-to-slabh.patch
mm-mark-idle-page-tracking-as-broken.patch
avoid-a-warning-in-sparse-memory-support.patch
mm-doc-include-highmemh-in-kernel-doc.patch
