openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-26 22:52:34 +02:00
Code Issues Releases Wiki Activity

doc: Fix index files in Supported HW section

Browse Source 
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>
This commit is contained in:
Anastasia Klimchuk 2024-05-04 18:35:03 +10:00 committed by Anastasia Klimchuk
parent e177e77f9f
commit 0f2128d748
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/supported_hw/index.rst
View File

@ -3,6 +3,6 @@ Supported hardware
==================
.. toctree::
:maxdepth: 3
:maxdepth: 1
supported_prog/index

11
doc/supported_hw/supported_prog/index.rst
View File

@ -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