mbox series

[v2,0/6] Start switching the documentation to bitbake-setup

Message ID 20251103-bitbake-setup-v2-0-89fbb14cfbbd@bootlin.com
Headers show
Series Start switching the documentation to bitbake-setup | expand

Message

Antonin Godard Nov. 3, 2025, 4:33 p.m. UTC 
This series is a start for transitioning the documentation on instructing how
to build the reference poky distro with bitbake-setup instead of the
poky repository.

What this series does:

- Refreshing the local.conf and bblayers.conf documentation.
- Adding documentation for site.conf.
- Migrating the Quick Start Guide to bitbake-setup (thank you Tim Orling
  for the first iteration of this).
- Adding a new document to instruct how to set things up manually, using
  the different repositories that used to be part of the Poky
  repository.

There are still references to the poky repository in places in the
documentation. I will send updates to this series (or another one) as I
make progress on this. First, let's have some documentation on how to
use bitbake-setup, as a starting point.

Depends on: https://lists.openembedded.org/g/bitbake-devel/message/18241.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Changes in v2:
- Apply suggestions from Alex's reviews on v1 (thanks!):
  - change local.conf description
  - configure root login in local.conf
- Update references to use new bitbake documentation on bitbake-setup.
- Link to v1: https://lore.kernel.org/r/20251030-bitbake-setup-v1-0-f44a8a2b7c0b@bootlin.com

---
Antonin Godard (6):
      ref-manual/structure.rst: update the description of local.conf and bblayers.conf
      ref-manual/structure.rst: document the site.conf file
      brief-yoctoprojectqs: delete unused figures
      brief-yoctoprojectqs: switch to bitbake-setup
      dev-manual: add a document to setup poky manually
      ref-manual/terms.rst: update Poky description

 .../brief-yoctoprojectqs/figures/bypqs-title.png   | Bin 14312 -> 0 bytes
 .../figures/yocto-project-transp.png               | Bin 8626 -> 0 bytes
 documentation/brief-yoctoprojectqs/index.rst       | 399 +++++++++++----------
 documentation/dev-manual/index.rst                 |   1 +
 documentation/dev-manual/poky-manual-setup.rst     | 125 +++++++
 documentation/ref-manual/structure.rst             |  70 ++--
 documentation/ref-manual/terms.rst                 |  19 +-
 7 files changed, 395 insertions(+), 219 deletions(-)
---
base-commit: 6ee2a9a04a4c8201a96a1173cf00aa7d206170df
change-id: 20251027-bitbake-setup-d8f38b266b4d

Best regards,
--  
Antonin Godard <antonin.godard@bootlin.com>