linux/poky.git/documentation/README, branch genericarm64

manuals: README: update list of manuals

2023-08-30T14:54:59+00:00

(From yocto-docs rev: 30166df4a85a2bbd1da98440e701de72e56fa9f3) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: simplify references to the BitBake User Manual

2023-03-20T13:16:52+00:00

- Replacing :ref:`bitbake:bitbake-user-manual/...` by :ref:`bitbake-user-manual/...` Adding "bitbake:" as a prefix is not necessary as there is no naming conflict between the YP and the BitBake manuals (all documents are in "bitbake-user-manual/") - Explaining the rules in the README file - When necessary, fixing line length in the modified paragraphs. (From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

Documentation/README: formalize guidelines for external link syntax

2022-10-28T14:48:03+00:00

(From yocto-docs rev: f5d10ceed943270d7bcfa31b5936f37a60669c7f) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: README: add TeX font package required for building PDF

2022-08-12T22:11:28+00:00

The fncychap.sty font needs to be installed on the host in order to be able to build the PDF version of the docs, so let's mention it in the README. Cc: Quentin Schulz (From yocto-docs rev: 97fb41801fb7ac1439f8af03d2da2fb2f171a7e6) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

documentation/README: correct heading styles actually used in the YP manuals

2022-03-16T14:25:01+00:00

Sphinx seems to offer flexibility in heading styles definitions, but the new text matches the way subsubsections and subsubsubsections are defined in the current manuals. Note that it's not possible to mix different definitions, for example by using "~~~~" and "^^^^" for subsubsections in different places. (From yocto-docs rev: 89a9af58adaa4cf4708d0383655b992f8c7239e2) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

documentation/README: how to upgrade Sphinx packages

2022-03-04T09:39:37+00:00

(From yocto-docs rev: 199c6ef4b64d6c7f672ac183d3bf73c8ff3bb2c7) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

documentation/README: trivial typo fix

2022-01-07T11:12:06+00:00

(From yocto-docs rev: f3f252c08a8ae9b492d766fd8a7168baf7467a07) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: start of documentation standards document

2021-11-07T10:44:52+00:00

This first version specifies how to create consistent SGV graphics (From yocto-docs rev: 370b9e34e9092c9eed22df2e8b2d0bb979487e5c) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

Makefile: allow epub and latexpdf outputs to use diagrams from SVG sources

2021-10-08T21:01:24+00:00

html output is great when directly using SVG epub output has to use exported PNG because of issues using SVG directly latexpdf output cannot use SVG, it needs exported PDF instead This adds rules to generate PNG and PDF formats from new SVG sources. Newly added diagrams have be stored in svg/ subdirectories so that PNG and PDF files generated from SVG can be "gitignored" without ignoring the original PNG diagrams that have no SVG source. Note: had to remove the dependency to "Makefile" in the final "catch-all" target, otherwise it was also catching the SVG to PNG and SVG to PDF targets. (From yocto-docs rev: cd9bbd41d323bc124057396f142010509c65bbaf) Signed-off-by: Michael Opdenacker Reviewed-by: Nicolas Dechesne Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

README: update manual list and names, online docs URL

2021-09-04T07:46:35+00:00

Minor tweaks to top-level README: - add missing line for overview manual - correct manual names to match their *actual* names - point reader at docs.yoctoproject.org for online docs (From yocto-docs rev: 0ce9097728dbdca926fdf7065490207d09a34cb0) Signed-off-by: Robert P. J. Day Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie