summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/new-recipe.rst
Commit message (Collapse)AuthorAgeFilesLines
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-06-021-1/+1
| | | | | | | | | | | | | | | | | | Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to a heading which contain literals enclosed in double-back-tics; especially in the cases where a heading either contains multiple literals or when the literal is not at the end of the heading. Not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 73f4a3e3efce8c4e43939e5053f128faae5b41b1) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Move devtool doc from extensible to dev manualAntonin Godard2025-02-071-1/+1
| | | | | | | | | | | | | | | | | | | | [YOCTO #13417] devtool is not directly tied to the Extensible SDK anymore, and instructions in there can be split and added to the development manual. This patch is a simple bulk move, except for the following: - Intro added to the devtool.rst document (mostly copy-pasted from the devtool quick reference in the ref-manual). - Figures renamed to remove "sdk-" from filenames. - References to sdk-manual/extensible replaced by dev-manual/devtool. Reported-By: Paul Eggleton <bluelightning@bluelightning.org> (From yocto-docs rev: 044d3185b858fce1febcfe3a6834b883f9a598fa) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Update the documentation for SRCPVAntonin Godard2024-12-201-5/+5
| | | | | | | | | | | | | | | | | | | | | | The variable SRCPV is deprecated since 4.3. Instead of including SRCPV in PV, including the sign "+" is enough for bitbake to add the source control information to PKGV during the packaging phase. Update the documentation for SRCPV and the places where it was used. When instructions previously referred to SRCPV, replace by mentioning to include "+" in the assignment. In most examples, "+git" is added to PV as it is the most popular SCM. Simply adding "+" is also possible, although it is better practice to include the SCM name, so give that example. Update the gcompat example with l3afpad as it didn't include "+git" in its PV definition anymore. (From yocto-docs rev: ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: suppress excess use of "following" wordMichael Opdenacker2024-02-241-4/+4
| | | | | | | | | | | | | | | | | | 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 <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Discourage the use of SRC_URI[md5sum]Peter Kjellerstedt2023-12-181-11/+16
| | | | | | | | | | | | | | | SRC_URI[md5sum] has been deprecated for a long time. Discourage its use by removing it from examples and note that it should be replaced by SRC_URI[sha256sum] when updating recipes. Also mention that bitbake supports other checksums, though they are not commonly used. (From yocto-docs rev: 806c6cb0b457248ac7401487ba2cdd17a1eba320) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: new-recipe.rst: add missing parenthesis to "Patching Code" sectionRobert P. J. Day2023-10-201-2/+2
| | | | | | | | | | Add missing parenthesis, and another example of a compressed patch filename. (From yocto-docs rev: d44ccb5ed4292b0371651f38b9a0e3083f60ae87) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: new-recipe.rst: replace reference to wikiMichael Opdenacker2023-09-251-3/+3
| | | | | | | (From yocto-docs rev: 22c445e9803f5e1ac97d1efaf7ac2ea6fc2f7594) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: new-recipe.rst fix inconsistency with contributor guideMichael Opdenacker2023-09-191-6/+7
| | | | | | | | | | | This document was suggesting a way to version pre-releases which doesn't match the latest recommendations from the contributor guide. (From yocto-docs rev: b51c21e59bd624153f6f9b8bf3cf33329bd25e56) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: add recipe style guideMichael Opdenacker2023-08-301-50/+4
| | | | | | | (From yocto-docs rev: a61a7677adb9bf22dc0d28e72a8fedf2df27e80a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document CVE_STATUS and CVE_CHECK_STATUSMAPAndrej Valek2023-08-031-2/+1
| | | | | | | | | | | Deprecate CVE_CHECK_IGNORE with CVE_STATUS (From yocto-docs rev: 8b8054977f31e2d6090521a0102f066b6d563733) Signed-off-by: Andrej Valek <andrej.valek@siemens.com> Signed-off-by: Peter Marko <peter.marko@siemens.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix unnecessary double white spaceQuentin Schulz2023-06-241-1/+1
| | | | | | | | | | | There's no need for double white spaces here so let's just remove them. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: e41f6689157359777c3d86d9a7afed6f9e43782b) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: release-notes-4.2: add doc improvement highlightsMichael Opdenacker2023-05-261-0/+2
| | | | | | | (From yocto-docs rev: 66b5f10bf0747b6ae0a8fbb05103e2f1070b6474) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to the BitBake User ManualMichael Opdenacker2023-03-201-15/+11
| | | | | | | | | | | | | | | | | | | | - 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 <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: new-recipe.rst: add references to subsections in Examples sectionMichael Opdenacker2023-02-241-9/+9
| | | | | | | | | | | | | | | Making it possible to jump right away to the desired example Rename a section title to make it more suitable for a link title. Using short references (`Section Name`_) instead of :ref:`dev-manual/new-recipe:Section Name`) as we are in the same document. (From yocto-docs rev: 4058998dbeba4262ccced8999be338c04c324b48) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: new-recipe.rst: add Meson example recipeMichael Opdenacker2023-02-241-0/+31
| | | | | | | | (From yocto-docs rev: 30cded4e59020a98205877970c530de35da46a60) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: new-recipe.rst: restructure examplesMichael Opdenacker2023-02-241-58/+52
| | | | | | | | | | | | | | | | To make it possible to add more examples (CMake, Meson, Go, Rust...) - Change section title names - Adjust paragraph line length - Have the Autotools example after the one with a custom Makefile, corresponding to an increasing level of complexity. - Clarify that GNU make and the Autotools are used to build the applications, not by these applications. (From yocto-docs rev: 6f313e673fe4d2878c8166619c27c4958af73615) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to classesMichael Opdenacker2023-01-061-48/+37
| | | | | | | | | | | | | | | Now that .bbclass is removed from class section titles. We can now have, for example, :ref:`ref-classes-insane` instead of :ref:`insane <ref-classes-insane>`. Then, when necessary, rework paragraphs so that they have lines of even length, not exceeding 80 characters. (From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix double colonsMichael Opdenacker2022-12-181-11/+5
| | | | | | | | | | | | | | | Fixing double colons appearing alone on a line, while they could be put at the end of the previous line. Sometimes placing a note after the quoted text to avoid such a situation. It's more natural too not to have a note between the introduction text and the quoted section. (From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-011-0/+1674
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 <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>