mbox series

[v3,0/6] Improve multiconfig documentation

Message ID 20250217-multiconfig-doc-v3-0-027a9fb282c3@bootlin.com
Headers show
Series Improve multiconfig documentation | expand

Message

Antonin Godard Feb. 17, 2025, 2:50 p.m. UTC 
This series moves the multiconfig doc to its own document in the dev
manual, and adds 2 sections to improve it.

It also adds BB_CURRENT_MC to variables.rst, and fixes previous
references of that variable in the doc.

This series depends on the following series that adds the BB_CURRENT_MC
doc in bitbake: https://lists.openembedded.org/g/bitbake-devel/message/17185.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Changes in v3:
- Various typos and suggestions by Quentin (thanks!)
- Link to v2: https://lore.kernel.org/r/20250213-multiconfig-doc-v2-0-f2bd35115cb7@bootlin.com

Changes in v2:
- reviews from Quentin (thanks!)
  - add dependency on bitbake series
  - fix first commit's bad reference, replace with a :doc:
  - fix some typos
  - add example install and deploy tasks in the suggested best practices
  - mention that the baremetal scenario could also apply to a main Soc
    with companion microcontroller + add a note on overriding MACHINE or
    not
- Link to v1: https://lore.kernel.org/r/20250207-multiconfig-doc-v1-0-f63cdab1fad9@bootlin.com

---
Antonin Godard (6):
      dev-manual: move multiconfig documentation to its own document
      variables.rst: add a reference to BB_CURRENT_MC from bbdocs
      migration-5.2: fix references to BB_CURRENT_MC
      dev-manual/multiconfig: rename to use Multiconfig term
      dev-manual/multiconfig: improve the current doc
      dev-manual/multiconfig: add suggested best practices and baremetal sections

 documentation/dev-manual/building.rst            | 156 +-----------
 documentation/dev-manual/index.rst               |   1 +
 documentation/dev-manual/multiconfig.rst         | 312 +++++++++++++++++++++++
 documentation/migration-guides/migration-5.2.rst |   4 +-
 documentation/ref-manual/variables.rst           |   3 +
 5 files changed, 320 insertions(+), 156 deletions(-)
---
base-commit: 6eda443c7fcfeecebd6b44b96a1587c4bb093a34
change-id: 20250129-multiconfig-doc-c37342a6ab91

Best regards,