linux/poky.git/documentation/tools, branch walnascar-next

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

docs: use literalinclude for system requirements

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

The YAML variables for the host dependencies are updated by hand and actually only used inside code blocks. Let's migrate all instructions into separate shell scripts that are then literalinclude'd into the Sphinx documentation. This allows a few things: - ability to run shellcheck on the scripts if we ever want to - manually calling the appropriate script from a supported distro to build stuff (distro or bitbake/yocto stuff) - use this script to create containers to do CI of documentation on different distros, to make sure our instructions are all up to date, (From yocto-docs rev: 8d993022c2aefc0fde9baa949d39d7a3613f9f46) Signed-off-by: Quentin Schulz Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

sphinx: remove DocBook files

2020-10-06T12:56:17+00:00

The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

yocto-docs: Add SPDX headers in scripts and Makefile

2020-06-04T12:29:02+00:00

[Yocto #13873] (From yocto-docs rev: b87c540a1a6c0dce4c6010b89d9831442e0e7f70) Signed-off-by: Armin Kuster Signed-off-by: Richard Purdie

YP Documentation: Set up for YP 3.1 release

2019-12-09T12:02:54+00:00

* Updates to poky.ent * Updates to mega-manual.sed * Updates to all .xml files for date (From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

documenation: Changed "2.8" to "3.0".

2019-10-23T16:15:53+00:00

I was using "2.8" throughout the manual set instead of "3.0". Updated all aspects to "3.0". (From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

documentation: Prepared for 2.8 release

2019-05-07T09:23:41+00:00

poky.ent - variables all set up for 2.8 mega-manual.sed - "2.7" replaced with "2.8" .xml - manual revision history tables updated. (From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

mega-manual: Updates to support BitBake User Manual

2018-12-27T22:53:11+00:00

Fixes [YOCTO #12399] Fixes made to have the BitBake User Manual included in the build of the mega-manual. I placed this manual at the end of the mega-manual. Following changes made: * Makefile - Modified to include two PNG files. All PNG files in a given manual are listed in the area that makes the mega-manual so that the tarfile is complete. * mega-manual.xml - Updated the front wording to tell the user that the BitBake User Manual is included in the Mega-Manual. Also, added a last section to actually include the bitbake-title.png file and the *.xml files. Note that I could not add the title figure from the same figures folder of the local "bitbake" folder. Would not include in the build. So, I pulled the file from the figures folder of the mega-manual, which is what I do for all the other book titles used in the mega-manual. * mega-manual.sed - Modified to clean out the old stuff that had been carried along for older books not supported for the release. Modified to include link processing for the newly included BitBake User Manual. * New Figures - Moved copies of the "bb_multiconfig_files.png" and "bitbake-title.png" figures into the figures folder of the mega-manual. (From yocto-docs rev: 78a1ae0ca92bb7f8a9d3a32a320299371d0ed361) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

documentation: Preparing for 2.7 release.

2018-12-15T11:48:59+00:00

Updated poky.ent to have variables for 2.7. Updated mega-manual.sed file to use "2.7" string. Updated all .xml Manual History Tables to use "TBD" (From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

documentation: Set up the 2.6 version of the docs

2018-05-24T16:16:36+00:00

poky.ent - Edited for new variables. .xml - Manual revision tables updated mega-manual.sed - swapped out 2.5 for 2.6 (From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie