This patchseries splits the 'target-arm.rst' file in the System
manual into one file per board or family of boards. It's not
sensible for us to document all 50-odd boards in a single enormous
page, and the split will encourage more detailed and useful per-board
information.
The impetus for doing this split is that it gives somewhere for the
documentation for the upcoming Orangepi board model to live. It also
means we can move arm-cpu-features.rst out of being an orphan unused
file in the docs/ directory.
I've also added some of the text I originally wrote for the wiki as a
general introduction to the Arm system emulation and to how to choose
a board model, plus some apologetic text about how most of our boards
are undocumented.
The last patch in this series smooths out an inconsistency in how we
spell 'Arm' (there was a corporate rebranding back in 2017, so we
have a mix of old-style 'ARM' and new-style 'Arm'); I don't feel very
strongly about this but the inconsistency did look a bit odd in some
of the docs that this series moves around, and it was 5 minutes work
to make docs/ consistent on one style.
Side notes:
(1) I still think it would be nice to be able to generate some of
this from doc comments and/or the board declaration macros; that
would be definitely not 5.0 material, though
(2) Anybody want to tackle the target-x86 part? There's a
docs/microvm.rst which would naturally live in
docs/system/x86/microvm.rst if target-x86.rst was restructured along
the same lines as this series, but it would need something
writing for the other x86 machine types...
thanks
-- PMM
Peter Maydell (5):
Makefile: Allow for subdirectories in Sphinx manual dependencies
docs/system: Split target-arm.rst into sub-documents
docs/system/target-arm.rst: Add some introductory text
docs: Move arm-cpu-features.rst into the system manual
docs: Be consistent about capitalization of 'Arm'
docs/can.txt | 2 +-
docs/devel/atomics.txt | 2 +-
docs/devel/multi-thread-tcg.txt | 8 +-
docs/replay.txt | 2 +-
docs/specs/fw_cfg.txt | 2 +-
Makefile | 2 +-
MAINTAINERS | 9 +
docs/devel/kconfig.rst | 2 +-
docs/devel/loads-stores.rst | 2 +-
docs/devel/tcg.rst | 2 +-
docs/specs/tpm.rst | 6 +-
.../arm/cpu-features.rst} | 12 +-
docs/system/arm/integratorcp.rst | 16 +
docs/system/arm/musicpal.rst | 19 ++
docs/system/arm/nseries.rst | 33 ++
docs/system/arm/palm.rst | 23 ++
docs/system/arm/realview.rst | 34 ++
docs/system/arm/stellaris.rst | 26 ++
docs/system/arm/sx1.rst | 18 ++
docs/system/arm/versatile.rst | 29 ++
docs/system/arm/xscale.rst | 29 ++
docs/system/target-arm.rst | 295 +++++-------------
docs/user/main.rst | 8 +-
23 files changed, 340 insertions(+), 241 deletions(-)
rename docs/{arm-cpu-features.rst => system/arm/cpu-features.rst} (98%)
create mode 100644 docs/system/arm/integratorcp.rst
create mode 100644 docs/system/arm/musicpal.rst
create mode 100644 docs/system/arm/nseries.rst
create mode 100644 docs/system/arm/palm.rst
create mode 100644 docs/system/arm/realview.rst
create mode 100644 docs/system/arm/stellaris.rst
create mode 100644 docs/system/arm/sx1.rst
create mode 100644 docs/system/arm/versatile.rst
create mode 100644 docs/system/arm/xscale.rst
--
2.20.1
