summaryrefslogtreecommitdiffstats
path: root/documentation/tools/build-docs-container
Commit message (Collapse)AuthorAgeFilesLines
* The poky repository master branch is no longer being updated.Richard Purdie2025-11-071-175/+0
| | | | | | | | | | | | | | | | | | | | | 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 <richard.purdie@linuxfoundation.org>
* tools/build-docs-container: use the basename of OCI to append argsAntonin Godard2025-10-141-2/+2
| | | | | | | | | | | | 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 <quentin.schulz@cherry.de> (From yocto-docs rev: 41fc95a0e06fec29cdd8c47f75093f0a6a2df8c0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tools/build-docs-container: remove obsolete commentsAntonin Godard2025-10-141-20/+0
| | | | | | | | | | | | 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 <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 2e3d33f47dfba64a81767accb6a47cae842bd18e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tools/build-docs-container: add option to install essential packagesAntonin Godard2025-10-141-0/+17
| | | | | | | | | | | | | | | 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 <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tools/build-docs-container: update with newly supported distrosAntonin Godard2025-10-031-8/+14
| | | | | | | | | | | 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 <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tools: build-docs-container: remove comment for unsupported distrosQuentin Schulz2025-10-031-3/+0
| | | | | | | | | | | 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 <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tools: add script for building documentation inside containersQuentin Schulz2025-02-181-0/+175
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 <quentin.schulz@cherry.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>