linux/poky.git/documentation/README, branch 3.4_M1

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

documentation: Use https links where possible

2020-12-24T08:23:33+00:00

(From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

documentation/README: Refer to top-level README for contributions

2020-11-20T14:32:25+00:00

This may help anyone looking for patch contribution guidelines in the documentation directory itself. (From yocto-docs rev: 276740dd3780b0bdf04996efeed3c237fd26da1f) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

documentation: Add Pipenv support

2020-11-12T13:04:10+00:00

Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation (From yocto-docs rev: 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Joshua Watt Signed-off-by: Richard Purdie

README: "yocto-project-qs" -> "brief-yoctoprojectqs"

2020-10-30T12:09:22+00:00

Directory has been renamed, so fix README and add a bit more white space to keep everything lined up. (From yocto-docs rev: cdd4c705f7271e31e44a94c79b050eda1fba5945) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie