diff options
| author | Bagas Sanjaya <bagasdotme@gmail.com> | 2022-06-22 15:45:46 +0700 |
|---|---|---|
| committer | akpm <akpm@linux-foundation.org> | 2022-07-03 15:42:32 -0700 |
| commit | cffe57bee62b155c08d71218fc0e9e84a0a90bbb (patch) | |
| tree | 81485d324936740c4402829eb56bbed5b82c13b4 /arch/riscv/Kconfig | |
| parent | 39d35edee4537487e5178f258e23518272a66413 (diff) | |
| download | linux-cffe57bee62b155c08d71218fc0e9e84a0a90bbb.tar.bz2 | |
Documentation: highmem: use literal block for code example in highmem.h comment
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.
Link: https://lkml.kernel.org/r/20220622084546.17745-1-bagasdotme@gmail.com
Fixes: 85a85e7601263f ("Documentation/vm: move "Using kmap-atomic" to highmem.h")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Ira Weiny <ira.weiny@intel.com>
Tested-by: Ira Weiny <ira.weiny@intel.com>
Cc: "Matthew Wilcox (Oracle)" <willy@infradead.org>
Cc: "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Diffstat (limited to 'arch/riscv/Kconfig')
0 files changed, 0 insertions, 0 deletions