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.
Unified · Split
| @@ -149,19 +149,19 @@ static inline void *kmap_local_folio(struct folio *folio, size_t offset); · 148 unmodified lines | ||
| 149 | 149 | * It is used in atomic context when code wants to access the contents of a |
| 150 | 150 | * page that might be allocated from high memory (see __GFP_HIGHMEM), for |
| 151 | 151 | * example a page in the pagecache. The API has two functions, and they |
| 152 | − * can be used in a manner similar to the following: | |
| 152 | + * can be used in a manner similar to the following:: | |
| 153 | 153 | * |
| 154 | − * -- Find the page of interest. -- | |
| 155 | − * struct page *page = find_get_page(mapping, offset); | |
| 154 | + * // Find the page of interest. | |
| 155 | + * struct page *page = find_get_page(mapping, offset); | |
| 156 | 156 | * |
| 157 | − * -- Gain access to the contents of that page. -- | |
| 158 | − * void *vaddr = kmap_atomic(page); | |
| 157 | + * // Gain access to the contents of that page. | |
| 158 | + * void *vaddr = kmap_atomic(page); | |
| 159 | 159 | * |
| 160 | − * -- Do something to the contents of that page. -- | |
| 161 | − * memset(vaddr, 0, PAGE_SIZE); | |
| 160 | + * // Do something to the contents of that page. | |
| 161 | + * memset(vaddr, 0, PAGE_SIZE); | |
| 162 | 162 | * |
| 163 | − * -- Unmap that page. -- | |
| 164 | − * kunmap_atomic(vaddr); | |
| 163 | + * // Unmap that page. | |
| 164 | + * kunmap_atomic(vaddr); | |
| 165 | 165 | * |
| 166 | 166 | * Note that the kunmap_atomic() call takes the result of the kmap_atomic() |
| 167 | 167 | * call, not the argument. |