Skip to content

doc: board: amlogic: spring clean-up of Amlogic docs

Christian Hewitt linux-amlogic u-boot u-boot-amlogic 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest33 patches 8 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/33doc: boards: amlogic: update documentation for index pagedoc/board/amlogic/index.rst+64 -730 replies
2/33doc: boards: amlogic: update documentation for boot-flowdoc/board/amlogic/boot-flow.rst+90 -880 replies
3/33doc: boards: amlogic: update documentation for pre-generated-fip'sdoc/board/amlogic/pre-generated-fip.rst+88 -500 replies
4/33doc: boards: amlogic: update documentation for Beelink GT-Kingdoc/board/amlogic/beelink-gtking.rst+60 -600 replies
5/33doc: boards: amlogic: update documentation for Beelink GT-King Prodoc/board/amlogic/beelink-gtkingpro.rst+60 -600 replies
6/33doc: boards: amlogic: update documentation for JetHub J100doc/board/amlogic/jethub-j100.rst+35 -310 replies
7/33doc: boards: amlogic: update documentation for JetHub J80doc/board/amlogic/jethub-j80.rst+26 -200 replies
8/33doc: boards: amlogic: update documentation for Khadas VIMdoc/board/amlogic/khadas-vim.rst+41 -350 replies
9/33doc: boards: amlogic: update documentation for Khadas VIM2doc/board/amlogic/khadas-vim2.rst+41 -350 replies
10/33doc: boards: amlogic: update documentation for Khadas VIM3doc/board/amlogic/khadas-vim3.rst+68 -690 replies
11/33doc: boards: amlogic: update documentation for Khadas VIM3Ldoc/board/amlogic/khadas-vim3l.rst+68 -690 replies
12/33doc: boards: amlogic: update documentation for LaFritedoc/board/amlogic/libretech-ac.rst+42 -350 replies
13/33doc: boards: amlogic: update documentation for LePotatodoc/board/amlogic/libretech-cc.rst+40 -690 replies
14/33doc: boards: amlogic: update documentation for NanoPi-K2doc/board/amlogic/nanopi-k2.rst+54 -390 replies
15/33doc: boards: amlogic: update documentation for ODROID-C2doc/board/amlogic/odroid-c2.rst+30 -240 replies
16/33doc: boards: amlogic: update documentation for ODROID-C4doc/board/amlogic/odroid-c4.rst+60 -570 replies
17/33doc: boards: amlogic: update documentation for ODROID GO ULTRAdoc/board/amlogic/odroid-go-ultra.rst+18 -70 replies
18/33doc: boards: amlogic: update documentation for ODROID-N2/N2+doc/board/amlogic/odroid-n2.rst+65 -570 replies
19/33doc: boards: amlogic: update documentation for ODROID-N2Ldoc/board/amlogic/odroid-n2l.rst+23 -100 replies
20/33doc: boards: amlogic: update documentation for P200doc/board/amlogic/p200.rst+53 -340 replies
21/33doc: boards: amlogic: update documentation for P201doc/board/amlogic/p201.rst+53 -340 replies
22/33doc: boards: amlogic: update documentation for Q200doc/board/amlogic/q200.rst+42 -340 replies
23/33doc: boards: amlogic: update documentation for Radxa Zerodoc/board/amlogic/radxa-zero.rst+24 -210 replies
24/33doc: boards: amlogic: update documentation for S400doc/board/amlogic/s400.rst+47 -420 replies
25/33doc: boards: amlogic: update documentation for SEI510doc/board/amlogic/sei510.rst+59 -540 replies
26/33doc: boards: amlogic: update documentation for SEI610doc/board/amlogic/sei610.rst+61 -570 replies
27/33doc: boards: amlogic: update documentation for U200doc/board/amlogic/u200.rst+59 -540 replies
28/33doc: boards: amlogic: update documentation for W400doc/board/amlogic/w400.rst+61 -540 replies
29/33doc: boards: amlogic: update documentation for WeTek Core2doc/board/amlogic/wetek-core2.rst+47 -363 replies
30/33doc: boards: amlogic: add documentation for BananaPi CM4IOboard/amlogic/u200/MAINTAINERS board/amlogic/w400/MAINTAINERS doc/board/amlogic/bananapi-cm4io.rst +1 more+155 -13 replies
31/33doc: boards: amlogic: add documentation for BananaPi M5doc/board/amlogic/bananapi-m5.rst doc/board/amlogic/index.rst+142 -00 replies
32/33doc: boards: amlogic: add documentation for GS-King-Xboard/amlogic/beelink-s922x/MAINTAINERS doc/board/amlogic/beelink-gskingx.rst doc/board/amlogic/index.rst+124 -10 replies
33/33doc: boards: amlogic: add documentation for ODROID-HC4doc/board/amlogic/index.rst doc/board/amlogic/odroid-hc4.rst+142 -01 reply

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/33] doc: board: amlogic: spring clean-up of Amlogic docs

Amlogic documentation spans U-Boot support from 2015-current resulting in older content being harder to follow. And due to many international contributors the docs also contain grammar quirks.

This series reworks all board documents to be more consistent. There is deliberate emphasis on using the amlogic-boot-fip repo for signing tasks as this is easier for most users to follow. The original/longer signing process (described as Manual Signing) has been tidied up.

In the index.rst file I've dropped board names from the features table as this adds considerable width and makes adding new boards a fiddly process. I've appended the SoC type to the boader header so it shows in the TOC list to retain a reference between boards and the table.

I've added missing board docs for GS-King-X, BPI-M5, BPI-CM4IO, and we split ODROID-HC4 into its own document. It originally followed the same process as the ODROID0-C4, but now has a separate defconfig to enable SPI-NOR and PCIe SATA support. Users occasionally follow the current doc and build U-Boot for the C4 which omits this and then struggle to figure out why SATA boot doesn't work when wiki/forums say it does.

There are other minor cleanups and tweaks for clarity of simply more up-to-date information for a board or process.

Please review and flag any omissions or issues!

Christian Hewitt (33):
doc: boards: amlogic: update documentation for index page
doc: boards: amlogic: update documentation for boot-flow
doc: boards: amlogic: update documentation for pre-generated-fip's
doc: boards: amlogic: update documentation for Beelink GT-King
doc: boards: amlogic: update documentation for Beelink GT-King Pro
doc: boards: amlogic: update documentation for JetHub J100
doc: boards: amlogic: update documentation for JetHub J80
doc: boards: amlogic: update documentation for Khadas VIM
doc: boards: amlogic: update documentation for Khadas VIM2
doc: boards: amlogic: update documentation for Khadas VIM3
doc: boards: amlogic: update documentation for Khadas VIM3L
doc: boards: amlogic: update documentation for LaFrite
doc: boards: amlogic: update documentation for LePotato
doc: boards: amlogic: update documentation for NanoPi-K2
doc: boards: amlogic: update documentation for ODROID-C2
doc: boards: amlogic: update documentation for ODROID-C4
doc: boards: amlogic: update documentation for ODROID GO ULTRA
doc: boards: amlogic: update documentation for ODROID-N2/N2+
doc: boards: amlogic: update documentation for ODROID-N2L
doc: boards: amlogic: update documentation for P200
doc: boards: amlogic: update documentation for P201
doc: boards: amlogic: update documentation for Q200
doc: boards: amlogic: update documentation for Radxa Zero
doc: boards: amlogic: update documentation for S400
doc: boards: amlogic: update documentation for SEI510
doc: boards: amlogic: update documentation for SEI610
doc: boards: amlogic: update documentation for U200
doc: boards: amlogic: update documentation for W400
doc: boards: amlogic: update documentation for WeTek Core2
doc: boards: amlogic: add documentation for BananaPi CM4IO
doc: boards: amlogic: add documentation for BananaPi M5
doc: boards: amlogic: add documentation for GS-King-X
doc: boards: amlogic: add documentation for ODROID-HC4

 board/amlogic/beelink-s922x/MAINTAINERS |   3 +-
 board/amlogic/u200/MAINTAINERS          |   1 -
 board/amlogic/w400/MAINTAINERS          |   2 +
 doc/board/amlogic/bananapi-cm4io.rst    | 152 ++++++++++++++++++++
 doc/board/amlogic/bananapi-m5.rst       | 141 +++++++++++++++++++
 doc/board/amlogic/beelink-gskingx.rst   | 121 ++++++++++++++++
 doc/board/amlogic/beelink-gtking.rst    | 120 ++++++++--------
 doc/board/amlogic/beelink-gtkingpro.rst | 120 ++++++++--------
 doc/board/amlogic/boot-flow.rst         | 178 ++++++++++++------------
 doc/board/amlogic/index.rst             | 141 +++++++++----------
 doc/board/amlogic/jethub-j100.rst       |  66 ++++-----
 doc/board/amlogic/jethub-j80.rst        |  46 +++---
 doc/board/amlogic/khadas-vim.rst        |  76 +++++-----
 doc/board/amlogic/khadas-vim2.rst       |  76 +++++-----
 doc/board/amlogic/khadas-vim3.rst       | 137 +++++++++---------
 doc/board/amlogic/khadas-vim3l.rst      | 137 +++++++++---------
 doc/board/amlogic/libretech-ac.rst      |  77 +++++-----
 doc/board/amlogic/libretech-cc.rst      | 109 ++++++---------
 doc/board/amlogic/nanopi-k2.rst         |  93 +++++++------
 doc/board/amlogic/odroid-c2.rst         |  54 +++----
 doc/board/amlogic/odroid-c4.rst         | 117 ++++++++--------
 doc/board/amlogic/odroid-go-ultra.rst   |  25 +++-
 doc/board/amlogic/odroid-hc4.rst        | 141 +++++++++++++++++++
 doc/board/amlogic/odroid-n2.rst         | 122 ++++++++--------
 doc/board/amlogic/odroid-n2l.rst        |  33 +++--
 doc/board/amlogic/p200.rst              |  87 +++++++-----
 doc/board/amlogic/p201.rst              |  87 +++++++-----
 doc/board/amlogic/pre-generated-fip.rst | 138 +++++++++++-------
 doc/board/amlogic/q200.rst              |  76 +++++-----
 doc/board/amlogic/radxa-zero.rst        |  45 +++---
 doc/board/amlogic/s400.rst              |  89 ++++++------
 doc/board/amlogic/sei510.rst            | 113 ++++++++-------
 doc/board/amlogic/sei610.rst            | 118 ++++++++--------
 doc/board/amlogic/u200.rst              | 113 ++++++++-------
 doc/board/amlogic/w400.rst              | 115 ++++++++-------
 doc/board/amlogic/wetek-core2.rst       |  83 ++++++-----
 36 files changed, 2042 insertions(+), 1310 deletions(-)
 create mode 100644 doc/board/amlogic/bananapi-cm4io.rst
 create mode 100644 doc/board/amlogic/bananapi-m5.rst
 create mode 100644 doc/board/amlogic/beelink-gskingx.rst
 create mode 100644 doc/board/amlogic/odroid-hc4.rst
Signature · 1 line
2.34.1