Anastasia Klimchuk has submitted this change. ( https://review.coreboot.org/c/flashrom/+/82196?usp=email )
Change subject: doc: Fix index files in Supported HW section ......................................................................
doc: Fix index files in Supported HW section
By default toctree in the index file displays full tree of docs with all the nested levels, and it's too much detail. Besides, left side menu displays the tree anyway, so duplication is not needed. Supported hardware section has the deepest nesting out of all other docs.
This patch changes high-level index files to only display flat list of next level subtree. On deeper level, full index is displayed.
Change-Id: Ia15e9766cce6f19be1e69fbb1236a327ae3d57b3 Signed-off-by: Anastasia Klimchuk aklm@flashrom.org Reviewed-on: https://review.coreboot.org/c/flashrom/+/82196 Reviewed-by: Sydney git@funkeleinhorn.com Reviewed-by: Peter Marheine pmarheine@chromium.org Tested-by: build bot (Jenkins) no-reply@coreboot.org --- M doc/supported_hw/index.rst M doc/supported_hw/supported_prog/index.rst 2 files changed, 11 insertions(+), 2 deletions(-)
Approvals: build bot (Jenkins): Verified Peter Marheine: Looks good to me, approved Sydney: Looks good to me, but someone else must approve
diff --git a/doc/supported_hw/index.rst b/doc/supported_hw/index.rst index 5552326..058e7f2 100644 --- a/doc/supported_hw/index.rst +++ b/doc/supported_hw/index.rst @@ -3,6 +3,6 @@ ==================
.. toctree:: - :maxdepth: 3 + :maxdepth: 1
supported_prog/index diff --git a/doc/supported_hw/supported_prog/index.rst b/doc/supported_hw/supported_prog/index.rst index 9d71578..d8131a6 100644 --- a/doc/supported_hw/supported_prog/index.rst +++ b/doc/supported_hw/supported_prog/index.rst @@ -1,7 +1,16 @@ Supported programmers =====================
+flashrom supports many different programmers, for the full list you can look into `programmer_table.c https://github.com/flashrom/flashrom/blob/main/programmer_table.c`_ +in the source tree. Some of the programmers have their own documentation pages, see below. + +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. + +Patches to add/update documentation, or migrate docs from `old wiki website https://wiki.flashrom.org/Supported_programmers`_ are very much appreciated. + .. toctree:: - :maxdepth: 2 + :maxdepth: 1
serprog/index