[PATCH] doc: build: fix gen_compile_commands section level

Heinrich Schuchardt xypron.glpk at gmx.de
Fri Apr 5 09:50:05 CEST 2024


On 4/5/24 08:18, Mattijs Korpershoek wrote:
> The 2 subsections of this page ("Compatible IDEs" and "Usage") are using
> the same header level as the title (with "===").
> Because of this, they always appear in the HTML rendered ToC.
>
> Drop the subsections one level lower by replacing "=" by "-".
> This fixes the HTML rendering.
>
> Signed-off-by: Mattijs Korpershoek <mkorpershoek at baylibre.com>

Reviewed-by: Heinrich Schuchardt <xypron.glpk at gmx.de>

> ---
>   doc/build/gen_compile_commands.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/doc/build/gen_compile_commands.rst b/doc/build/gen_compile_commands.rst
> index 50305cec4a83..d503764f9e3f 100644
> --- a/doc/build/gen_compile_commands.rst
> +++ b/doc/build/gen_compile_commands.rst
> @@ -42,7 +42,7 @@ needed for it to be usable by the LSP, unless you set a name for the database
>   other than it's default one (compile_commands.json).
>
>   Compatible IDEs
> -===============
> +---------------
>
>   Several popular integrated development environments (IDEs) support the use
>   of JSON compilation databases for C/C++ development, making it easier to
> @@ -73,7 +73,7 @@ compile_commands.json in the root of the repository should suffice to enable
>   code navigation.
>
>   Usage
> -=====
> +-----
>
>   For further details on the script's options, please refer to its help message,
>   as in the example below.
>
> ---
> base-commit: cdfcc37428e06f4730ab9a17cc084eeb7676ea1a
> change-id: 20240405-doc-fix-headings-6109365355a3
>
> Best regards,



More information about the U-Boot mailing list