linux/poky.git/documentation/tools, branch master

The poky repository master branch is no longer being updated.

2025-11-07T13:31:53+00:00

You can either: a) switch to individual clones of bitbake, openembedded-core, meta-yocto and yocto-docs b) use the new bitbake-setup You can find information about either approach in our documentation: https://docs.yoctoproject.org/ Note that "poky" the distro setting is still available in meta-yocto as before and we continue to use and maintain that. Long live Poky! Some further information on the background of this change can be found in: https://lists.openembedded.org/g/openembedded-architecture/message/2179 Signed-off-by: Richard Purdie

tools/build-docs-container: use the basename of OCI to append args

2025-10-14T10:36:58+00:00

What we have is OCI = $(which $CONTAINERCMD) = /usr/bin/{docker,podman}. So we never pass the current if conditions. Compare against the basename of OCI to pass the checks. Reviewed-by: Quentin Schulz (From yocto-docs rev: 41fc95a0e06fec29cdd8c47f75093f0a6a2df8c0) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

tools/build-docs-container: remove obsolete comments

2025-10-14T10:36:58+00:00

Leap 15.6 worked fine on my local builds, with Docker or Podman. Ubuntu 23.04 got removed from the list of distros we test. Tested-by: Quentin Schulz Reviewed-by: Quentin Schulz (From yocto-docs rev: 2e3d33f47dfba64a81767accb6a47cae842bd18e) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

tools/build-docs-container: add option to install essential packages

2025-10-14T10:36:58+00:00

The script currently only installs the files necessary to build the docs. Since we also have the essential packages listed it can be useful to include them in the containers, at least to validate that these successfully install. Add an env variable for including these packages in the container. The default is to not include these, so the current behavior is unchanged. (From yocto-docs rev: 723e531ea442df96fd592635a2fbfba73e737886) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

tools/build-docs-container: update with newly supported distros

2025-10-03T16:53:57+00:00

Update the build-docs-container file with newly supported distributions. These were all able to install packages and build the docs (including the pdf) properly. (From yocto-docs rev: 09c7800333b17b21e50d2a089a3ae1b123697243) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

docs: add util-linux-script package for Fedora 42+

2025-10-03T16:53:57+00:00

Fedora 42 split the script utility from util-linux into a separate util-linux-script package. This change adds conditional installation of util-linux-script for Fedora 42 and later versions. https://src.fedoraproject.org/rpms/util-linux/c/5a2471d6e5b0055cb607b30dc2e9613b312ffb74?branch=rawhide The package is added conditionally using rpm macro evaluation to maintain compatibility with older Fedora versions where script was included in the base util-linux package. Note that different distributions handle this differently - for example, Debian provides the script utility in a separate bsdutils package rather than in util-linux. (From yocto-docs rev: 22e28e817d2c9b49d9fedbb93b08874cec1fa3d3) Signed-off-by: Adrian Freihofer Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

tools: build-docs-container: remove comment for unsupported distros

2025-10-03T16:53:57+00:00

Ubuntu 18.04 and 20.04 are not supported distros, so let's remove the comment listing the reason we don't support them. (From yocto-docs rev: 9ff31ed417bc7cd80f8bde39372091e40e36b678) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Add a script to validate documentation glossaries

2025-08-08T22:41:11+00:00

Instead of tracking the glossary manually, add a small script that checks if it is properly sorted. Add two comments between the start and end of the glossary for the script to know where it's located. The script also checks if the variables are properly sorted. It uses difflib and returns the diff if there's a difference between the unsorted and sorted list. Messages beginning with "WARNING:" are reported by the Autobuilder, which is the reason for this format. (From yocto-docs rev: 416d50c0c322eb88bf13353a198db7211e4d665a) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

docs: remove lz4 from required packages

2025-06-06T21:22:43+00:00

Since commit b13654a4fc2f ("bitbake.conf: Drop lz4 from HOSTTOOLS") in OE-Core, lz4 isn't an expected host dependency anymore so let's drop it from the list of required packages. (From yocto-docs rev: 040556cc9bc998970eb6152f8748d359b15b4bf9) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

tools: add script for building documentation inside containers

2025-02-18T15:47:37+00:00

This adds a script for building a container and building the documentation within that new container image. The openSUSE instructions now require a --non-interactive flag otherwise they fail to run. Sadly there doesn't seem to be a way to have this in an environment variable à-la DEBIAN_FRONTEND=noninteractive, so we simply do a sed on the scripts to add --non-interactive to the zypper commands to avoid having those in the instructions provided to our users. Somehow tzdata package in Ubuntu doesn't respect DEBIAN_FRONTEND=noninteractive hence why the timezone needs to be set by hand. (From yocto-docs rev: cefced592f1302fcb65afa9e0b1f9f5ff1570e93) Signed-off-by: Quentin Schulz Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie