Skip to contentSkip to conversation

documentation-highmem-use-literal-block-for-code-example-in-highmemh-comment.patch removed from -mm tree

merged mm-hotfixes-stable Andrew Morton 1 participant 1 message Jul 3, 2022

lore
Share & tools
lore

Andrew Morton

author tree notice Applied
#0 lore raw

The quilt patch titled
Subject: Documentation: highmem: use literal block for code example in highmem.h comment
has been removed from the -mm tree. Its filename was
documentation-highmem-use-literal-block-for-code-example-in-highmemh-comment.patch

This patch was dropped because it was merged into the mm-hotfixes-stable branch of git://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm

------------------------------------------------------
From: Bagas Sanjaya <[email protected]>
Subject: Documentation: highmem: use literal block for code example in highmem.h comment
Date: Wed, 22 Jun 2022 15:45:46 +0700

When building htmldocs on Linus's tree, there are inline emphasis warnings on include/linux/highmem.h:

Documentation/vm/highmem:166: ./include/linux/highmem.h:154: WARNING: Inline emphasis start-string without end-string. Documentation/vm/highmem:166: ./include/linux/highmem.h:157: WARNING: Inline emphasis start-string without end-string.

These warnings above are due to comments in code example at the mentioned lines above are enclosed by double dash (--), which confuses Sphinx as inline markup delimiters instead.

Fix these warnings by indenting the code example with literal block indentation and making the comments C comments.

Fixes 85a85e7601263f ("Documentation/vm: move "Using kmap-atomic" to highmem.h")
Cc "Matthew Wilcox (Oracle)" <[email protected]>
Cc "Fabio M. De Francesco" <[email protected]>
Cc Sebastian Andrzej Siewior <[email protected]>

---

 include/linux/highmem.h |   18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
include/linux/highmem.h renamed from include/linux/highmem.h~documentation-highmem-use-literal-block-for-code-example-in-highmemh-comment +9 -9
@@ -149,19 +149,19 @@ static inline void *kmap_local_folio(str
  * It is used in atomic context when code wants to access the contents of a
  * page that might be allocated from high memory (see __GFP_HIGHMEM), for
  * example a page in the pagecache.  The API has two functions, and they
- * can be used in a manner similar to the following:
+ * can be used in a manner similar to the following::
  *
- * -- Find the page of interest. --
- * struct page *page = find_get_page(mapping, offset);
+ *   // Find the page of interest.
+ *   struct page *page = find_get_page(mapping, offset);
  *
- * -- Gain access to the contents of that page. --
- * void *vaddr = kmap_atomic(page);
+ *   // Gain access to the contents of that page.
+ *   void *vaddr = kmap_atomic(page);
  *
- * -- Do something to the contents of that page. --
- * memset(vaddr, 0, PAGE_SIZE);
+ *   // Do something to the contents of that page.
+ *   memset(vaddr, 0, PAGE_SIZE);
  *
- * -- Unmap that page. --
- * kunmap_atomic(vaddr);
+ *   // Unmap that page.
+ *   kunmap_atomic(vaddr);
  *
  * Note that the kunmap_atomic() call takes the result of the kmap_atomic()
  * call, not the argument.

_

Patches currently in -mm which might be from [email protected] are