linux/poky.git/documentation/ref-manual/faq.rst, branch scarthgap-5.0.1

manuals: suppress excess use of "following" word

2024-02-24T16:13:28+00:00

To simplify the style, replace "Following is" and "Following are" by "here is" and "here are", sounding more natural. In some cases, also go further by simplifying "Here are/is xxx" by "xxx are/is" when the "are" or "is" are not two far at the end of the sentence. In some cases too, completely remove the sentence, when it's redundant with the preceding title. (From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5) Signed-off-by: Michael Opdenacker CC: Daniel Ammann Signed-off-by: Richard Purdie

manual: improve documentation about using external toolchains

2022-12-18T10:41:21+00:00

- Remove the redundant FAQ entry about this topic, already covered in a specific section of the Development Tasks manual - Document the TOOLCHAIN_LOCATION variable - Expand both the Development Tasks manual and the TCMODE variable description using details from the FAQ entry. - Mention the "meta-arm-toolchain" layer too. (From yocto-docs rev: 53faa54a8e6311b4d3d41d96cb1a497d0f6502fb) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: split dev-manual/common-tasks.rst

2022-12-01T19:20:29+00:00

A 500 KB source file is always harder to manage, and can have section title conflicts. So, the "Common Tasks" document is gone and all its constituents are moved up one level. You now have 40 chapters in the Development Tasks Manual. (From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: use references to the "Build Directory" term

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

Replace instances of "Build Directory" and "build directory" (when applicable) by :term:`Build Directory` as already done in most places. Doing this, fix the indentation of the paragraphs with this term. (From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: faq.rst: reorganize into subsections, contents at top

2022-10-19T16:32:57+00:00

Reorganize the FAQ into sections and subsections, which allows to have a table of contents at the top. This makes it easier to find relevant questions without having to scroll down the entire page. Reduce the size of questions so that they fit in a subsection title. Merged two redundant questions about fetching sources and working through proxies. Minor updates to other sections. (From yocto-docs rev: 3e24f94e9c2186a6e1d65d82a87323ef2fc6f87d) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

Update documentation for classes split

2022-10-19T16:32:57+00:00

* Make reference to meta/classes* instead of just meta/classes * Update each reference to the path where the class has moved * Add a brief explanation to the classes reference explaining the split * Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES variable glossary entries mentioning where the specified classes must be located. I contemplated adding the same note to PACKAGE_CLASSES but decided against it, as it has a very specific usage and such a note might distract from the narrative of that entry. * Also trim the IMAGE_CLASSES entry which was quite outdated. * INHERIT += no longer works with testimage so drop the note about that (From yocto-docs rev: e76bed00b452d3049f6c22afbfb980b557a141bd) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

ref-manual/faq.rst: update references to products built with OE / Yocto Project

2022-10-07T09:54:26+00:00

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

manuals: add reference to the "do_install" task

2022-10-07T09:54:25+00:00

[YOCTO #14508] (From yocto-docs rev: 933ad27b81dfc4a28e7c48ca7bb2d1363e8c037f) Signed-off-by: Michael Opdenacker Reported-by: Quentin Schulz Signed-off-by: Richard Purdie

manuals: fix paths to default templates & clean up whitespaces

2022-09-12T07:35:17+00:00

The templates have recently been moved by meta-yocto's commit [1]. Clean up some whitespace issues along the way. [1] 29608bd03e1b ("meta-poky/conf: move default templates to conf/templates/default/") (From yocto-docs rev: 661c554224dd79e79afd22b84608e248d3336aac) Signed-off-by: Ulrich Ölmann Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: replace hyphens with em dashes

2022-06-27T13:55:08+00:00

Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie