linux-amlogic.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 00/33] doc: board: amlogic: spring clean-up of Amlogic docs
@ 2023-03-20 11:45 Christian Hewitt
  2023-03-20 11:45 ` [PATCH 01/33] doc: boards: amlogic: update documentation for index page Christian Hewitt
                   ` (33 more replies)
  0 siblings, 34 replies; 42+ messages in thread
From: Christian Hewitt @ 2023-03-20 11:45 UTC (permalink / raw)
  To: u-boot, u-boot-amlogic, linux-amlogic

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

-- 
2.34.1


_______________________________________________
linux-amlogic mailing list
linux-amlogic@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-amlogic

^ permalink raw reply	[flat|nested] 42+ messages in thread

end of thread, other threads:[~2024-04-05  8:03 UTC | newest]

Thread overview: 42+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-03-20 11:45 [PATCH 00/33] doc: board: amlogic: spring clean-up of Amlogic docs Christian Hewitt
2023-03-20 11:45 ` [PATCH 01/33] doc: boards: amlogic: update documentation for index page Christian Hewitt
2023-03-20 11:45 ` [PATCH 02/33] doc: boards: amlogic: update documentation for boot-flow Christian Hewitt
2023-03-20 11:45 ` [PATCH 03/33] doc: boards: amlogic: update documentation for pre-generated-fip's Christian Hewitt
2023-03-20 11:45 ` [PATCH 04/33] doc: boards: amlogic: update documentation for Beelink GT-King Christian Hewitt
2023-03-20 11:45 ` [PATCH 05/33] doc: boards: amlogic: update documentation for Beelink GT-King Pro Christian Hewitt
2023-03-20 11:45 ` [PATCH 06/33] doc: boards: amlogic: update documentation for JetHub J100 Christian Hewitt
2023-03-20 11:45 ` [PATCH 07/33] doc: boards: amlogic: update documentation for JetHub J80 Christian Hewitt
2023-03-20 11:45 ` [PATCH 08/33] doc: boards: amlogic: update documentation for Khadas VIM Christian Hewitt
2023-03-20 11:45 ` [PATCH 09/33] doc: boards: amlogic: update documentation for Khadas VIM2 Christian Hewitt
2023-03-20 11:45 ` [PATCH 10/33] doc: boards: amlogic: update documentation for Khadas VIM3 Christian Hewitt
2023-03-20 11:45 ` [PATCH 11/33] doc: boards: amlogic: update documentation for Khadas VIM3L Christian Hewitt
2023-03-20 11:45 ` [PATCH 12/33] doc: boards: amlogic: update documentation for LaFrite Christian Hewitt
2023-03-20 11:45 ` [PATCH 13/33] doc: boards: amlogic: update documentation for LePotato Christian Hewitt
2023-03-20 11:45 ` [PATCH 14/33] doc: boards: amlogic: update documentation for NanoPi-K2 Christian Hewitt
2023-03-20 11:45 ` [PATCH 15/33] doc: boards: amlogic: update documentation for ODROID-C2 Christian Hewitt
2023-03-20 11:45 ` [PATCH 16/33] doc: boards: amlogic: update documentation for ODROID-C4 Christian Hewitt
2023-03-20 11:45 ` [PATCH 17/33] doc: boards: amlogic: update documentation for ODROID GO ULTRA Christian Hewitt
2023-03-20 11:45 ` [PATCH 18/33] doc: boards: amlogic: update documentation for ODROID-N2/N2+ Christian Hewitt
2023-03-20 11:45 ` [PATCH 19/33] doc: boards: amlogic: update documentation for ODROID-N2L Christian Hewitt
2023-03-20 11:45 ` [PATCH 20/33] doc: boards: amlogic: update documentation for P200 Christian Hewitt
2023-03-20 11:45 ` [PATCH 21/33] doc: boards: amlogic: update documentation for P201 Christian Hewitt
2023-03-20 11:45 ` [PATCH 22/33] doc: boards: amlogic: update documentation for Q200 Christian Hewitt
2023-03-20 11:45 ` [PATCH 23/33] doc: boards: amlogic: update documentation for Radxa Zero Christian Hewitt
2023-03-20 11:46 ` [PATCH 24/33] doc: boards: amlogic: update documentation for S400 Christian Hewitt
2023-03-20 11:46 ` [PATCH 25/33] doc: boards: amlogic: update documentation for SEI510 Christian Hewitt
2023-03-20 11:46 ` [PATCH 26/33] doc: boards: amlogic: update documentation for SEI610 Christian Hewitt
2023-03-20 11:46 ` [PATCH 27/33] doc: boards: amlogic: update documentation for U200 Christian Hewitt
2023-03-20 11:46 ` [PATCH 28/33] doc: boards: amlogic: update documentation for W400 Christian Hewitt
2023-03-20 11:46 ` [PATCH 29/33] doc: boards: amlogic: update documentation for WeTek Core2 Christian Hewitt
2023-03-20 18:40   ` Simon Glass
2023-03-21  5:10     ` Christian Hewitt
2023-04-01  6:33       ` Simon Glass
2023-03-20 11:46 ` [PATCH 30/33] doc: boards: amlogic: add documentation for BananaPi CM4IO Christian Hewitt
2023-03-20 12:13   ` Neil Armstrong
2023-03-20 12:23     ` Christian Hewitt
2023-03-20 12:25       ` neil.armstrong
2023-03-20 11:46 ` [PATCH 31/33] doc: boards: amlogic: add documentation for BananaPi M5 Christian Hewitt
2023-03-20 11:46 ` [PATCH 32/33] doc: boards: amlogic: add documentation for GS-King-X Christian Hewitt
2023-03-20 11:46 ` [PATCH 33/33] doc: boards: amlogic: add documentation for ODROID-HC4 Christian Hewitt
2024-04-05  8:03   ` Heinrich Schuchardt
2023-03-22 14:26 ` [PATCH 00/33] doc: board: amlogic: spring clean-up of Amlogic docs Neil Armstrong

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).