]> git.baikalelectronics.ru Git - kernel.git/commit
Documentation/llvm: Improve formatting of commands, variables, and arguments
authorNathan Chancellor <natechancellor@gmail.com>
Tue, 25 Aug 2020 23:14:38 +0000 (16:14 -0700)
committerMasahiro Yamada <masahiroy@kernel.org>
Mon, 31 Aug 2020 10:48:20 +0000 (19:48 +0900)
commit118e09fe05fff492c6c8b1e7cb58bb8d3e6eed9e
tree62813271955082f5713d65b08ce662e927664ca1
parent307d1b3e26310db573de01ed3dc4a02b4fb13ada
Documentation/llvm: Improve formatting of commands, variables, and arguments

While reviewing a separate patch, I noticed that the formatting of the
commands, variables, and arguments was not in a monospaced font like the
rest of the Kbuild documentation (see kbuild/kconfig.rst for an
example). This is due to a lack of "::" before indented command blocks
and single backticks instead of double backticks for inline formatting.

Add those so that the document looks nicer in an HTML format, while not
ruining the look in plain text.

As a result of this, we can remove the escaped backslashes in the last
code block and move them to single backslashes.

Signed-off-by: Nathan Chancellor <natechancellor@gmail.com>
Reviewed-by: Nick Desaulniers <ndesaulniers@google.com>
Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Documentation/kbuild/llvm.rst