Skip to contentSkip to conversation

Documentation: highmem: Use literal block for code example in highmem.h comment

PATCH Applied Bagas Sanjaya 2 participants 2 messages Jun 22, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 Documentation: highmem: Use literal block for code example in highmem.h comment

When building htmldocs on Linus' 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 Andrew Morton <[email protected]>
Cc Ira Weiny <[email protected]>
Cc "Matthew Wilcox (Oracle)" <[email protected]>
Cc "Fabio M. De Francesco" <[email protected]>
Cc Sebastian Andrzej Siewior <[email protected]>

---
Changes since v3 [1]:
- Say "C comments" rephrase (suggested by Ira)

[1]: https://lore.kernel.org/linux-doc/[email protected]/

 include/linux/highmem.h | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
include/linux/highmem.h +9 -9
index 3af34de54330cb..56d6a019653489 100644
@@ -149,19 +149,19 @@ static inline void *kmap_local_folio(struct folio *folio, size_t offset);
  * 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.

base-commit: a111daf0c53ae91e71fd2bfe7497862d14132e3e

Signature · 1 line
An old man doll... just what I always wanted! - Clara
Reviewed-by Tested-by on v4 1/1
#1 lore raw
Quoted 10 lines · Bagas Sanjaya

When building htmldocs on Linus' 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.

Quoted 6 lines

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 Andrew Morton <[email protected]>
Cc Ira Weiny <[email protected]>

Thanks!

Quoted 53 lines
Cc "Matthew Wilcox (Oracle)" <[email protected]>
Cc "Fabio M. De Francesco" <[email protected]>
Cc Sebastian Andrzej Siewior <[email protected]>

---
Changes since v3 [1]:
- Say "C comments" rephrase (suggested by Ira)

[1]: https://lore.kernel.org/linux-doc/[email protected]/

 include/linux/highmem.h | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
include/linux/highmem.h +9 -9
index 3af34de54330cb..56d6a019653489 100644
@@ -149,19 +149,19 @@ static inline void *kmap_local_folio(struct folio *folio, size_t offset);
  * 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.

base-commit: a111daf0c53ae91e71fd2bfe7497862d14132e3e

Signature · 1 line
An old man doll... just what I always wanted! - Clara