linux/poky.git/documentation/Makefile, branch scarthgap

Makefile: pass -silent to latexmk

2026-02-27T17:45:07+00:00

This should drastically decrease the number of lines in the docs build logs, which currently can go up to 1700000 lines on the Autobuilder[1]. [1]: https://autobuilder.yoctoproject.org/valkyrie/#/builders/34/builds/400/steps/6/logs/stdio (From yocto-docs rev: ac3766beaff14ea62552f811b2ffcc43f77d8dd5) Signed-off-by: Antonin Godard (cherry picked from commit 6e9362923d4ab5599730da2074ab9f5a36e8ba14) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Makefile: fix rsvg-convert --format capitalization

2026-01-26T09:41:30+00:00

On some versions of rsvg-convert, capitalized formats are unknown. For example on CentOS Stream 9: $ rsvg-convert --format=Png --output=ref-manual/svg/releases.png ref-manual/svg/releases.svg Unknown output format. While the same command with "png" runs fine. On Ubuntu 22.04, both are accepted. Switch to the un-capitalized options, compatible with all versions. Reviewed-by: Quentin Schulz (From yocto-docs rev: 8e3e562179d47553268970f49a98817abfb32df6) Signed-off-by: Antonin Godard (cherry picked from commit cb60df269ef6329372f2676ab705134bbf2490eb) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

doc: Makefile: publish pdf and epub versions too

2024-11-18T14:59:35+00:00

Copy the generated files in the special _static directory. Fixes [YOCTO #14357] (From yocto-docs rev: 1ee04ff4798be042e9404fca08bbfb7058c79053) Signed-off-by: Michael Opdenacker Signed-off-by: Antonin Godard (cherry picked from commit b6974695993599959c0d5b7436aa290ee5d0dfca) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

doc: Makefile: add support for xelatex

2024-11-18T14:59:35+00:00

This patch makes the "latexpdf" target compile the documentation with xelatex instead of the default pdflatex engine. The reason behind this is stated in [YOCTO #14357]: pdflatex does not support compiling foreign characters, so we need to resort to another engine, here xelatex. It also increases the texmf config buf_size to 10000000 to avoid a compilation error. (From yocto-docs rev: 22f2365417ea5a9a7970e2475925f4f8eb983acf) Signed-off-by: Antonin Godard (cherry picked from commit 93848842b3ad8aa6b9c9f46d60f2c2ad396c6971) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

doc: Makefile: remove inkscape, replace by rsvg-convert

2024-11-18T14:59:35+00:00

Remove inkscape as it is not part of meta/, and use librsvg so we can ship it in a buildtools tarball for the autobuilder workers. (From yocto-docs rev: c45b401d8a1794dec2c5bd42633b9b7fac44ed82) Signed-off-by: Antonin Godard (cherry picked from commit 0caa432b888209bd80443df230143761e1faf415) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

documentation: Makefile: add SPHINXLINTDOCS to specify subset to sphinx-lint

2024-11-09T13:53:57+00:00

make sphinx-lint runs sphinx-lint on the whole documentation which can be long and reports a lot or errors/warnings. Let's add a new SHPINXLINTDOCS variable to allow specifying a subset, just as VALEDOCS does. Keep variable assignment aligned and also use $(SOURCEDIR) by default for SPHINXLINTDOCS and VALEDOCS variables. Also update the README file and fix a typo in Link checking section title. (From yocto-docs rev: c478ef829433c431456835bca240df44ffe8fcca) Signed-off-by: Julien Stephan Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit 3dfe7b5c746af31de74f67cf88214e5d52bdb65d) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

manuals: add initial sphinx-lint support

2024-04-08T13:36:38+00:00

Makes it possible to catch errors not reported by sphinx, such as idle spaces. After customization, this should be used to enforce our syntax conventions, such as two spaces after a "-" character to introduce a list item. Just run "make sphinx-lint". (From yocto-docs rev: 9e1aeeddca06cb7d65631010ba0eebdcd8ecf9ee) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: fix duplicate "stylecheck" target

2024-04-08T13:36:38+00:00

(From yocto-docs rev: f19e4231b1982f97ffd210b76978404fe1f2893b) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

manuals: add initial stylechecks with Vale

2024-03-19T15:22:27+00:00

Use the "Vale" (https://vale.sh) tool to perform text style checks Run "make stylecheck" to run the checks. This just checks the text, not the Sphinx syntax style choices. (From yocto-docs rev: 51b1f9a4d5aa02d337b105633de38e18b923a13a) Signed-off-by: Michael Opdenacker Suggested-by: Thomas Petazzoni Signed-off-by: Richard Purdie

documentation: Makefile: remove releases.rst in "make clean"

2024-03-19T15:22:27+00:00

releases.rst is generated by the set_versions.py script (From yocto-docs rev: 4b7773f59bab2d653d07b7e06cd21745b646b604) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie