linux/poky.git/documentation/README, branch honister-3.4

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

documentation/README: improve BitBake manual referencing guidelines

2021-07-30T21:49:15+00:00

Removing the ":ref:`-D Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

README: Tweak as the website isn't really new now

2021-06-16T15:33:18+00:00

(From yocto-docs rev: 78c50ffffb6f4dd38b5097a64c2e284a6177750a) Signed-off-by: Richard Purdie

manuals: simplify style

2021-05-22T11:16:41+00:00

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

manuals: reduce verbosity related to "the following" expression

2021-05-13T10:28:34+00:00

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

docs: replace anchor links

2021-04-09T14:24:46+00:00

Anchor links are treated by Sphinx as external links and are not checked during build, meaning it is impossible to know if a link becomes broken or not. As a matter of fact, most of the anchor links replaced in this commit were actually broken. The README now states that anchor links are forbidden so that there's no need to go through such a change later on. (From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: Fix typos and spacing

2021-04-06T21:29:49+00:00

Fix double words, punctuation spacing issues, spacing issues, "its" instead of "it's", and other trivial issues. (From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

documentation/README minor improvements

2021-03-23T22:54:55+00:00

- Minor style and spelling fixes - Add some extra details; add missing external link macros and explain where they are defined - Correct where documentation can be found on the Yocto Project website: the "Documentation" tab has been replaced by "Docs" (and it's later shown as uppercase ("DOCS") by the current CSS, but this may change one day. (From yocto-docs rev: ed7b4f318c9ba6cf501f1e551c7a8eb4aaee1396) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

Do not assume working from $HOME

2021-03-23T22:54:55+00:00

In the "Yocto Project Quick Build" instructions (https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#) there is an inconsistency that impacts several documents... People are first instructed to clone the poky git repository, but not mentioning from which directory. Then, it's consistent to instruct people to run "cd poky/". However, later in the instructions, readers are instructed to run "cd ~/poky", which assumes that cloning poky was done from the home directory. Many other places in the documentation make such an assumption. This change fixes this, and makes no assumption on where people have chosen to store their data, in particular where they cloned the "poky" repository. This also fixes a few whitespace issues. (From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie