On Tue, Aug 25, 2020 at 4:14 PM Nathan Chancellor <natechancellor@xxxxxxxxx> wrote: > > 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@xxxxxxxxx> Ah, yeah, I saw that. Thanks for the fix! Reviewed-by: Nick Desaulniers <ndesaulniers@xxxxxxxxxx> > --- > Documentation/kbuild/llvm.rst | 26 +++++++++++++------------- > 1 file changed, 13 insertions(+), 13 deletions(-) > > diff --git a/Documentation/kbuild/llvm.rst b/Documentation/kbuild/llvm.rst > index 2aac50b97921..334df758dce3 100644 > --- a/Documentation/kbuild/llvm.rst > +++ b/Documentation/kbuild/llvm.rst > @@ -23,8 +23,8 @@ supports C and the GNU C extensions required by the kernel, and is pronounced > Clang > ----- > > -The compiler used can be swapped out via `CC=` command line argument to `make`. > -`CC=` should be set when selecting a config and during a build. > +The compiler used can be swapped out via ``CC=`` command line argument to ``make``. > +``CC=`` should be set when selecting a config and during a build. :: > > make CC=clang defconfig > > @@ -34,33 +34,33 @@ Cross Compiling > --------------- > > A single Clang compiler binary will typically contain all supported backends, > -which can help simplify cross compiling. > +which can help simplify cross compiling. :: > > ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make CC=clang > > -`CROSS_COMPILE` is not used to prefix the Clang compiler binary, instead > -`CROSS_COMPILE` is used to set a command line flag: `--target <triple>`. For > -example: > +``CROSS_COMPILE`` is not used to prefix the Clang compiler binary, instead > +``CROSS_COMPILE`` is used to set a command line flag: ``--target <triple>``. For > +example: :: > > clang --target aarch64-linux-gnu foo.c > > LLVM Utilities > -------------- > > -LLVM has substitutes for GNU binutils utilities. Kbuild supports `LLVM=1` > -to enable them. > +LLVM has substitutes for GNU binutils utilities. Kbuild supports ``LLVM=1`` > +to enable them. :: > > make LLVM=1 > > -They can be enabled individually. The full list of the parameters: > +They can be enabled individually. The full list of the parameters: :: > > - make CC=clang LD=ld.lld AR=llvm-ar NM=llvm-nm STRIP=llvm-strip \\ > - OBJCOPY=llvm-objcopy OBJDUMP=llvm-objdump OBJSIZE=llvm-size \\ > - READELF=llvm-readelf HOSTCC=clang HOSTCXX=clang++ HOSTAR=llvm-ar \\ > + make CC=clang LD=ld.lld AR=llvm-ar NM=llvm-nm STRIP=llvm-strip \ > + OBJCOPY=llvm-objcopy OBJDUMP=llvm-objdump OBJSIZE=llvm-size \ > + READELF=llvm-readelf HOSTCC=clang HOSTCXX=clang++ HOSTAR=llvm-ar \ > HOSTLD=ld.lld > > Currently, the integrated assembler is disabled by default. You can pass > -`LLVM_IAS=1` to enable it. > +``LLVM_IAS=1`` to enable it. > > Getting Help > ------------ > > base-commit: abb3438d69fb6dd5baa4ae23eafbf5b87945eff1 > -- > 2.28.0 > > -- > You received this message because you are subscribed to the Google Groups "Clang Built Linux" group. > To unsubscribe from this group and stop receiving emails from it, send an email to clang-built-linux+unsubscribe@xxxxxxxxxxxxxxxx. > To view this discussion on the web visit https://groups.google.com/d/msgid/clang-built-linux/20200825231438.15682-1-natechancellor%40gmail.com. -- Thanks, ~Nick Desaulniers
