From 9a9ccdb6e66b8a5d3c52b3156e257ed72fc5b114 Mon Sep 17 00:00:00 2001 From: Anastasia Klimchuk Date: Sat, 25 May 2024 19:54:43 +1000 Subject: [PATCH] doc: Link useful section of manpage into Supported programmers index Change-Id: I0c8a761626784f31a71a47c2cebff2579ebbe416 Signed-off-by: Anastasia Klimchuk Reviewed-on: https://review.coreboot.org/c/flashrom/+/82646 Reviewed-by: Sergii Dmytruk Tested-by: build bot (Jenkins) --- doc/classic_cli_manpage.rst | 1 + doc/supported_hw/supported_prog/index.rst | 2 ++ 2 files changed, 3 insertions(+) diff --git a/doc/classic_cli_manpage.rst b/doc/classic_cli_manpage.rst index beafd82b4..19c804a91 100644 --- a/doc/classic_cli_manpage.rst +++ b/doc/classic_cli_manpage.rst @@ -329,6 +329,7 @@ All operations involving any chip access (probe/read/write/...) require the ``-p **-R, --version** Show version information and exit. +.. _programmer-specific information: PROGRAMMER-SPECIFIC INFORMATION ------------------------------- diff --git a/doc/supported_hw/supported_prog/index.rst b/doc/supported_hw/supported_prog/index.rst index 3f05c25d6..130ac201d 100644 --- a/doc/supported_hw/supported_prog/index.rst +++ b/doc/supported_hw/supported_prog/index.rst @@ -4,6 +4,8 @@ Supported programmers flashrom supports many different programmers, for the full list you can look into `programmer_table.c `_ in the source tree. Some of the programmers have their own documentation pages, see below. +Please check the :ref:`programmer-specific information` section of the :doc:`/classic_cli_manpage` for more details about programmers and their usage. + If you can run flashrom locally, the command ``flashrom -L`` prints all devices supported per programmer (see :doc:`/classic_cli_manpage` for more details on command line options). The output of this command is long, so you might want to save it to file or grep.