[PATCH] Fix references to trace doc

Heinrich Schuchardt xypron.glpk at gmx.de
Sat Apr 13 11:13:59 CEST 2024


On 4/11/24 18:44, Vincent Stehlé wrote:
> The README.trace has been moved and converted to rst in commit dce26c7d56ed
> ("doc: move README.trace to HTML documentation"); fix all the remaining
> references to this file.
>
> Signed-off-by: Vincent Stehlé <vincent.stehle at arm.com>
> Cc: Tom Rini <trini at konsulko.com>
> Cc: Simon Glass <sjg at chromium.org>
> Cc: Heinrich Schuchardt <xypron.glpk at gmx.de>
> ---
>   cmd/Kconfig                   | 4 ++--
>   doc/develop/tests_sandbox.rst | 2 +-
>   lib/Kconfig                   | 2 +-
>   3 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/cmd/Kconfig b/cmd/Kconfig
> index 38305197602..f9f271616d3 100644
> --- a/cmd/Kconfig
> +++ b/cmd/Kconfig
> @@ -2832,8 +2832,8 @@ config CMD_TRACE
>   	  Enables a command to control using of function tracing within
>   	  U-Boot. This allows recording of call traces including timing
>   	  information. The command can write data to memory for exporting
> -	  for analysis (e.g. using bootchart). See doc/README.trace for full
> -	  details.
> +	  for analysis (e.g. using bootchart). See doc/develop/trace.rst
> +	  for full details.
>
>   config CMD_AVB
>   	bool "avb - Android Verified Boot 2.0 operations"
> diff --git a/doc/develop/tests_sandbox.rst b/doc/develop/tests_sandbox.rst
> index bfd3bdb9270..c2824834d07 100644
> --- a/doc/develop/tests_sandbox.rst
> +++ b/doc/develop/tests_sandbox.rst
> @@ -29,7 +29,7 @@ Some of the available tests are:
>        - test/image/test-imagetools.sh - multi-file images
>        - test/py/tests/test-fit.py     - FIT images
>     - tracing: test/trace/test-trace.sh tests the tracing system (see
> -      README.trace)
> +      doc/develop/trace.rst)

Thank you Vincent for the documentation fixes.

Here we should use

   (see :doc:`trace`)

to create a cross reference in the generated HTML.

I will fix this when merging.

Best regards

Heinrich

>     - verified boot: test/py/tests/test_vboot.py
>
>   If you change or enhance any U-Boot subsystem, you should write or expand a
> diff --git a/lib/Kconfig b/lib/Kconfig
> index 37ac14f7bab..efb77978a65 100644
> --- a/lib/Kconfig
> +++ b/lib/Kconfig
> @@ -348,7 +348,7 @@ config TRACE
>   	  Enables function tracing within U-Boot. This allows recording of call
>   	  traces including timing information. The command can write data to
>   	  memory for exporting for analysis (e.g. using bootchart).
> -	  See doc/README.trace for full details.
> +	  See doc/develop/trace.rst for full details.
>
>   config TRACE_BUFFER_SIZE
>   	hex "Size of trace buffer in U-Boot"



More information about the U-Boot mailing list