mm-commits.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [failures] mm-doc-include-highmemh-in-kernel-doc.patch removed from -mm tree
@ 2021-07-23 20:32 akpm
  0 siblings, 0 replies; only message in thread
From: akpm @ 2021-07-23 20:32 UTC (permalink / raw)
  To: mm-commits, tglx, rdunlap, corbet, willy


The patch titled
     Subject: mm/doc: include highmem.h in kernel-doc
has been removed from the -mm tree.  Its filename was
     mm-doc-include-highmemh-in-kernel-doc.patch

This patch was dropped because it had testing failures

------------------------------------------------------
From: "Matthew Wilcox (Oracle)" <willy@infradead.org>
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@infradead.org
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: "Randy.Dunlap" <rdunlap@xenotime.net>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
---

 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@infradead.org 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


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2021-07-23 20:32 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-23 20:32 [failures] mm-doc-include-highmemh-in-kernel-doc.patch removed from -mm tree akpm

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).