Re: [PATCH v4 10/11] doc: board: ti: correct path to tcl scripts

Hi Bryan,

On 2026-08-04T21:55:02, Bryan Brattlof <[email protected]> wrote:
> doc: board: ti: correct path to tcl scripts
>
> OpenOCD has moved where it has placed the tcl scripts for TI's reference
> boards. Update their paths to the new locations.

Minor: 'has moved where it has placed' reads awkwardly. Something like
'OpenOCD has reorganised the tcl scripts for TI's reference boards
into a ti/ subdirectory' would be clearer, and it would be worth
naming the OpenOCD release/commit that made the move so readers know
which version they need.

>
> Acked-by: Andrew Davis <[email protected]>
> Reviewed-by: Anshul Dalal <[email protected]>
> Tested-by: Anshul Dalal <[email protected]>
> Signed-off-by: Bryan Brattlof <[email protected]>
>
> doc/board/ti/am6254atl_sk.rst |  2 +-
>  doc/board/ti/am62ax_sk.rst    |  2 +-
>  doc/board/ti/am62dx_evm.rst   | 11 ++++++-----
>  doc/board/ti/am62px_sk.rst    | 12 +++++-------
>  doc/board/ti/am62x_sk.rst     |  2 +-
>  doc/board/ti/am64x_evm.rst    | 24 ++++++++++++++++++++++++
>  doc/board/ti/am65x_evm.rst    |  2 +-
>  doc/board/ti/j7200_evm.rst    |  2 +-
>  doc/board/ti/j721e_evm.rst    |  2 +-
>  doc/board/ti/j722s_evm.rst    |  2 +-
>  doc/board/ti/j784s4_evm.rst   |  2 +-
>  11 files changed, 43 insertions(+), 20 deletions(-)

> diff --git a/doc/board/ti/am62px_sk.rst b/doc/board/ti/am62px_sk.rst
> @@ -331,13 +331,11 @@ detailed setup information.
> +   Until the next stable release of OpenOCD is available in your development
> +   environment's distribution, it might be necessary to build OpenOCD `from the
> +   source <https://github.com/openocd-org/open ocd>`_.

The URL has a stray space - 'openocd-org/open ocd' should be
'openocd-org/openocd'. This will render as a broken link.

> diff --git a/doc/board/ti/am64x_evm.rst b/doc/board/ti/am64x_evm.rst
> @@ -227,3 +227,27 @@ https://www.ti.com/lit/pdf/spruim2 under the `Boot Mode Pins` section.
> +   Until the next stable release of OpenOCD is available in your development
> +   environment's distribution, it might be necissary to build OpenOCD `from the
> +   source <https://github.com/openocd-org/open ocd>`_.

Two issues on these lines: 'necissary' should be 'necessary' (the v4
changelog claims this was fixed, but it is still here), and the URL
again has a stray space.

> diff --git a/doc/board/ti/am64x_evm.rst b/doc/board/ti/am64x_evm.rst
> @@ -227,3 +227,27 @@ https://www.ti.com/lit/pdf/spruim2 under the `Boot Mode Pins` section.
> +Debugging U-Boot
> +----------------

This whole new section is adding OpenOCD debugging documentation for
AM64x, not correcting a tcl path. Please split it into a separate
patch so the subject matches the change.

> diff --git a/doc/board/ti/j721e_evm.rst b/doc/board/ti/j721e_evm.rst
> @@ -261,4 +261,4 @@ To start OpenOCD and connect to the board
> -  openocd -f board/ti_j721eevm.cfg
> +   openocd -f board/ti/j721evm.cfg

Just to check - every other file in this patch keeps the trailing name
identical (e.g. ti_am625evm.cfg -> ti/am625evm.cfg), but here the
second 'e' is dropped (j721eevm -> j721evm). Is that really what
OpenOCD ships, or is this a typo?

Regards,
Simon