diff options
| author | Bagas Sanjaya <[email protected]> | 2022-06-22 08:45:46 +0000 |
|---|---|---|
| committer | akpm <[email protected]> | 2022-07-03 22:42:32 +0000 |
| commit | cffe57bee62b155c08d71218fc0e9e84a0a90bbb (patch) | |
| tree | 81485d324936740c4402829eb56bbed5b82c13b4 /scripts/clang-tools/gen_compile_commands.py | |
| parent | mm: sparsemem: fix missing higher order allocation splitting (diff) | |
| download | kernel-cffe57bee62b155c08d71218fc0e9e84a0a90bbb.tar.gz kernel-cffe57bee62b155c08d71218fc0e9e84a0a90bbb.zip | |
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/[email protected]
Fixes: 85a85e7601263f ("Documentation/vm: move "Using kmap-atomic" to highmem.h")
Signed-off-by: Bagas Sanjaya <[email protected]>
Reviewed-by: Ira Weiny <[email protected]>
Tested-by: Ira Weiny <[email protected]>
Cc: "Matthew Wilcox (Oracle)" <[email protected]>
Cc: "Fabio M. De Francesco" <[email protected]>
Cc: Sebastian Andrzej Siewior <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
Diffstat (limited to 'scripts/clang-tools/gen_compile_commands.py')
0 files changed, 0 insertions, 0 deletions