| Message ID | 20240812-ccache-literal-code-block-v1-1-4f09de978667@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Documentation/llvm: turn make command for ccache into code block | expand |
On Mon, Aug 12, 2024 at 02:17:21PM +0200, Javier Carrasco wrote: > The command provided to use ccache with clang is not a literal code > block. Once built, the documentation displays the '' symbols as a " > character, which is wrong, and the command can not be applied as > provided. > > Turn the command into a literal code block. > > Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com> Looks good to me. Reviewed-by: Nathan Chancellor <nathan@kernel.org> > --- > Documentation/kbuild/llvm.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/kbuild/llvm.rst b/Documentation/kbuild/llvm.rst > index bb5c44f8bd1c..6dc66b4f31a7 100644 > --- a/Documentation/kbuild/llvm.rst > +++ b/Documentation/kbuild/llvm.rst > @@ -126,7 +126,7 @@ Ccache > > ``ccache`` can be used with ``clang`` to improve subsequent builds, (though > KBUILD_BUILD_TIMESTAMP_ should be set to a deterministic value between builds > -in order to avoid 100% cache misses, see Reproducible_builds_ for more info): > +in order to avoid 100% cache misses, see Reproducible_builds_ for more info):: > > KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang" > > > --- > base-commit: 9e6869691724b12e1f43655eeedc35fade38120c > change-id: 20240812-ccache-literal-code-block-8462614e91e9 > > Best regards, > -- > Javier Carrasco <javier.carrasco.cruz@gmail.com> >
On Mon, Aug 12, 2024 at 9:17 PM Javier Carrasco <javier.carrasco.cruz@gmail.com> wrote: > > The command provided to use ccache with clang is not a literal code > block. Once built, the documentation displays the '' symbols as a " > character, which is wrong, and the command can not be applied as > provided. > > Turn the command into a literal code block. > > Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com> Applied to linux-kbuild/fixes. Thanks! > --- > Documentation/kbuild/llvm.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/kbuild/llvm.rst b/Documentation/kbuild/llvm.rst > index bb5c44f8bd1c..6dc66b4f31a7 100644 > --- a/Documentation/kbuild/llvm.rst > +++ b/Documentation/kbuild/llvm.rst > @@ -126,7 +126,7 @@ Ccache > > ``ccache`` can be used with ``clang`` to improve subsequent builds, (though > KBUILD_BUILD_TIMESTAMP_ should be set to a deterministic value between builds > -in order to avoid 100% cache misses, see Reproducible_builds_ for more info): > +in order to avoid 100% cache misses, see Reproducible_builds_ for more info):: > > KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang" > > > --- > base-commit: 9e6869691724b12e1f43655eeedc35fade38120c > change-id: 20240812-ccache-literal-code-block-8462614e91e9 > > Best regards, > -- > Javier Carrasco <javier.carrasco.cruz@gmail.com> >
diff --git a/Documentation/kbuild/llvm.rst b/Documentation/kbuild/llvm.rst index bb5c44f8bd1c..6dc66b4f31a7 100644 --- a/Documentation/kbuild/llvm.rst +++ b/Documentation/kbuild/llvm.rst @@ -126,7 +126,7 @@ Ccache ``ccache`` can be used with ``clang`` to improve subsequent builds, (though KBUILD_BUILD_TIMESTAMP_ should be set to a deterministic value between builds -in order to avoid 100% cache misses, see Reproducible_builds_ for more info): +in order to avoid 100% cache misses, see Reproducible_builds_ for more info):: KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang"
The command provided to use ccache with clang is not a literal code block. Once built, the documentation displays the '' symbols as a " character, which is wrong, and the command can not be applied as provided. Turn the command into a literal code block. Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com> --- Documentation/kbuild/llvm.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) --- base-commit: 9e6869691724b12e1f43655eeedc35fade38120c change-id: 20240812-ccache-literal-code-block-8462614e91e9 Best regards,