summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* docs-wide: fix space around equal assignmentsAntonin Godard4 days4-8/+8
| | | | | | | | | | | | | Since commit 24772dd2ae6c ("parse/ConfHandler: Add warning for deprecated whitespace usage") in BitBake, a warning is printed when there are no spaces around an `=` assignment. Adjust the documentation to show good examples only. (From yocto-docs rev: 77ce1544dd793036b1135817c02e090138fe6407) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs-wide: update wic source plugin namesAntonin Godard4 days1-8/+8
| | | | | | | | | | | WIC plugins were renamed after commit 2de444fc3ef4 ("wic: plugins source bootimage/isoimage rename to allow be imported") in OE-Core. They no longer contain dashes, but underscores. (From yocto-docs rev: 7224d7733e9e0f423475e1b9c5b48aff0de1f744) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: add a hash equivalence server setup documentAntonin Godard4 days3-0/+134
| | | | | | | | | | | | | | | | | | Add a small document to describe how to start a Hash Equivalence server with bitbake-hashserv, the reference server provided by BitBake. Update reference to hash equivalence in other places in the documentation to mention this document. Move the note from the concepts document to the new document, as a warning note. [YOCTO #15921] (From yocto-docs rev: 4ff998336efdc507de1311e43bf8f4a6258c610a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/start.rst: added missing command in Optimize your VHDX file using ↵Marco Cavallini11 days1-0/+1
| | | | | | | | | | | | | | | | | | | DiskPart After compact vsdisk you have to detach it before exiting otherwise the vdisk remains attached. DISKPART> select vdisk file="<path_to_VHDX_file>" DISKPART> attach vdisk readonly DISKPART> compact vdisk DISKPART> detach <------------ new missing command DISKPART> exit (From yocto-docs rev: 1cc65ddf1a074f61fe5a63d222f3079b7fcb4c1e) Signed-off-by: Marco Cavallini <m.cavallini@koansoftware.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/start.rst: remove basic setup for hash equivalenceAntonin Godard11 days1-6/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | Quoting Alexander Kanavin [1]: > 1. BB_HASHSERVE and BB_SIGNATURE_HANDLER do not set up or start a > server, they set up the hash equivalence client built into bitbake. > > 2. The above client configuration (used by poky) also starts a private > server that is specific to a particular build directory. So hash equiv > information would not be shared between multiple build directories, > and this will cause sstate mismatches (as reported in the bug), if > sstate is shared. This setup does not shed light on the potential of the hash equivalence feature. So for now, remove this basic setup, and later rework the concepts (or create a new) document that explains how to set up a hash equivalence server shared between builds. [1]: https://lore.kernel.org/r/CANNYZj_kvLsZG3sgH+nPu9B=pqWBU785w0SGHGdQqB4UW-DtmA@mail.gmail.com Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 231fc9e710ab34db60263f8ae01d4f5970579203) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/start.rst: remove shared PERSISTENT_DIR mentionsAntonin Godard2025-07-151-4/+10
| | | | | | | | | | | | | Remove the shared PERSISTENT_DIR mention introduced by 3954eda78f22 ("dev-manual/start.rst: mention that PERSISTENT_DIR should be shared too"), as it should _not_ be shared. Instead recommend setting up a hash equivalence server. (From yocto-docs rev: f9f1c87424d307d2df60024bc448bd6778605cf8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/start.rst: mention that PERSISTENT_DIR should be shared tooAntonin Godard2025-07-111-0/+5
| | | | | | | | | | | | | | | In the "Development environment summary", we mention that the shared state dir can be shared for developers, but PERSISTENT_DIR should be shared as well, otherwise bugs described in [1] can happen. [1]: https://bugzilla.yoctoproject.org/show_bug.cgi?id=15921 [YOCTO #15921] (From yocto-docs rev: 3954eda78f22f205cbd31857f5b0992900fe7b02) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add a document on limiting host resourcesAntonin Godard2025-07-112-0/+139
| | | | | | | | | | | | | | Add a "Limiting the Host Resources Usage" document to share the different techniques that can be used to limit the host resources usage. We do have a document to document how to speed up a build, so this document comes right after. [YOCTO #15111] (From yocto-docs rev: 584b8b30cd884ff6c62efcff9e9b566476a84589) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: update list of recipe files showing version numbersRobert P. J. Day2025-06-301-4/+5
| | | | | | | | | | | | Update the short list of recipe files showing examples of proper naming, and replace obsolete "irssi" example with example using "_git" as a version. (From yocto-docs rev: 95691fa4e7d30ee27cb1280df20751bf449538a4) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: simplify recipe names to use "oe_git" linksRobert P. J. Day2025-06-301-6/+6
| | | | | | | | | | | Shorten a small number of cumbersome recipe names by replacing them with :oe_git: markup to link to their repositories. (From yocto-docs rev: bdcc97d4d605c3de9682b9cb055c253547397f13) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: fix rendering of ${PN}Robert P. J. Day2025-06-301-1/+1
| | | | | | | | | | Current markup generates italic, not monospaced. (From yocto-docs rev: 859ba2ea1014c351a43a59c481c4498d79f30139) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: correct statements that source is always tarballsRobert P. J. Day2025-06-301-2/+2
| | | | | | | | | | | Correct two occurrences that imply source is always fetched as tarballs. (From yocto-docs rev: 57490852e6446672fd2cd0f3ee0befd9714c909f) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: show bin_package example wireless-regdb recipeRobert P. J. Day2025-06-301-0/+20
| | | | | | | | | | | Add a snippet from the wireless-regdb recipe to demonstrate a simple example of a bin_package recipe. (From yocto-docs rev: cbe3e272965cb706a73de36af01e1e0c65ea4efa) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: fix broken rendering of bullet pointRobert P. J. Day2025-06-301-1/+1
| | | | | | | | | | | Tweak the formatting of the bullet point title so that it renders both the term and the bolding properly. (From yocto-docs rev: 68068c5ab4f4c46c57bc055bd663f8e66096dd20) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: replace "on the contrary" with "by contrast"Robert P. J. Day2025-06-301-1/+1
| | | | | | | | | | | | | The qualifier "By contrast" is more appropriate here, since that phrase is used to introduce a point that is strikingly different from what was just discussed, that being the substantial systemd. (From yocto-docs rev: 3e73c7985dceb865e648f86ccd82aa0e7fc6668e) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: shorten bitbake.conf snippet related to static libsRobert P. J. Day2025-06-301-31/+1
| | | | | | | | | | | Much of the reproduced bitbake.conf has nothing to do with showing how the ${PN}-staticdev is defined, so delete most of it. (From yocto-docs rev: e235ae40db8f4e7088b2e99e678cdf31b5e216c8) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev manual, CH 3: update code snippets to be more currentRobert P. J. Day2025-06-301-5/+3
| | | | | | | | | | | Nothing major, just copy-and-paste from master branch to replace aging code examples, and a little grammmar cleanup. (From yocto-docs rev: 74057a1ffd682754e81f5f7fbde9f233e14a0d00) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: CH 2, small number of clarificationsRobert P. J. Day2025-06-301-8/+8
| | | | | | | | | | | | | | - drop reference to "opkg", just refer in general to packagers - correct what "QEMU" stands for (missing space) - correct version conditional - add a couple extra steps to typical workflow - drop implication that one can modify local poky checkout (From yocto-docs rev: 4fea81e42c41fc42548dd9e2b42f836daba5ac6b) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: correct misspelled reference to sstate-cache-management.pyRobert P. J. Day2025-06-301-1/+1
| | | | | | | | | (From yocto-docs rev: 3728eea352f8b326ff411aa0f20bfd433ccc7cfa) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: minor grammar correctionRobert P. J. Day2025-06-301-1/+1
| | | | | | | | | (From yocto-docs rev: 4e06c7f08a36c54a7f14760e609058468fab112f) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: replace WORKDIR with UNPACKDIR where appropriateAlexander Kanavin2025-06-306-23/+26
| | | | | | | | (From yocto-docs rev: 25ea8e2a0428b6cb66402283e64144d5ce61daf6) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add SPDX_INCLUDE_COMPILED_SOURCES documentationDaniel Turull2025-06-201-0/+3
| | | | | | | | | | | | | | | Adding documentation for the new feature to store in SPDX only the compiled sources. Merged in oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968 - spdx: add option to include only compiled sources CC: Antonin Godard <antonin.godard@bootlin.com> (From yocto-docs rev: 4dbc63ed1381fe47723d6ba5b7baf2a3b7fd19aa) Signed-off-by: Daniel Turull <daniel.turull@ericsson.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tree-wide: make the :doc: directive use absolute pathsQuentin Schulz2025-06-205-7/+7
| | | | | | | | | | | | | | | | | | | This makes all :doc: directives use an absolute paths (with the root directory being documentation/ in the repo). This is then consistent across the whole source and is easier to review and move files around, you just need to know where a file is located relative to documentation/ directory and use that. This gets rid of paths looking in parent directory with '..' as well as expecting a file to be in the same directory as the other file it points to via the :doc: directive. (From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-05-264-4/+4
| | | | | | | | | | | | | | | | 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: 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx-lint: superfluous backtick in front of roleTrevor Woerner2025-05-261-2/+2
| | | | | | | | | | Fix all instances of backtick-before-role as reported by 'make sphinx-lint'. (From yocto-docs rev: d38f9b25c0bd095fe1158f14226fb74f8645496a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx-lint: various fixesTrevor Woerner2025-05-192-3/+3
| | | | | | | | | | | | | | | A 'make sphinx-lint' pass found the following issues: trailing-whitespace missing-space-after-literal role-with-double-backticks missing-space-before-role (role missing opening tag colon) (From yocto-docs rev: 6d4c67457e00a80dda4cd05bc5f05d8ebd8da5fc) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sbom.rst: how to disable SPDX generationMikko Rapeli2025-05-191-3/+11
| | | | | | | | | | | | Generating SPDX is enabled by default in poky but it can take a lot of build time resources so document how to disable it. (From yocto-docs rev: bcd58b7a9455fbb0ea5944089d663e327f0eb38f) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Fix dead links that use the DISTRO macroAntonin Godard2025-04-212-2/+2
| | | | | | | | | | | | | | | | | | After introducing the DISTRO_LATEST_TAG and DISTRO_REL_LATEST_TAG macros, use them in links that currently use DISTRO/DISTRO_REL_TAG. When building for the tip of a branch, this will replace the current A.B.999 in links to the latest existing tag. The links were found across the documentation by running 'grep -r "http.*5\.2\.999"' inside the _build/html output after building the docs. [YOCTO #14802] (From yocto-docs rev: 29be069ebbf2c55d72fc51d99ed5a558af37c05e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: remove qemu machine name list in runqemu invocationRoss Burton2025-03-241-3/+0
| | | | | | | | | | | This list of "valid" qemu machine names is obsolete and incorrect, so just remove it as it serves no real purpose. (From yocto-docs rev: ee8839480fe574598b4d52a8fd6c11bb301ad3d9) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove all mention of core-image-lsbRoss Burton2025-03-072-15/+13
| | | | | | | | | | | | | | core-image-lsb was removed in 2019[1], so remove all of the incredibly obsolete references in the documentation. [1] oe-core fb064356af615d67d85b65942103bf943d84d290 (From yocto-docs rev: 062445a49919eff117b5478c1fb18d125c1f895c) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/multiconfig: add suggested best practices and baremetal sectionsAntonin Godard2025-02-261-0/+136
| | | | | | | | | | | | | | | | | | | | | | After the suggestions from Mark Hatle on the list (https://lists.yoctoproject.org/g/docs/topic/110487932), add two sections to the multiconfig doc: - Suggested best practices: suggestion for better design of multiconfig builds. - Common use case: baremetal build. This section applies the guidelines from the first sections and apply it to a real-life example of how to use multiconfig. This one to build some baremetal firmware alongside a regular Linux build. Suggested-by: Mark Hatle <mark.hatle@kernel.crashing.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 36fb1e9e5099aa0d858d5478530143e9bac39588) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/multiconfig: improve the current docAntonin Godard2025-02-261-26/+42
| | | | | | | | | | | | | | | | | After the suggestions from Mark Hatle on the list (https://lists.yoctoproject.org/g/docs/topic/110487932), rewrite the introduction to multiconfig with the following changes: - Move the part of overriding TMPDIR or not to a note. - Use BB_CURRENT_MC in the example. - Various additions of references & improved formatting. Suggested-by: Mark Hatle <mark.hatle@kernel.crashing.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 8cedef6d5b701235325e6e0bdd793f8c06dfef57) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/multiconfig: rename to use Multiconfig termAntonin Godard2025-02-261-2/+2
| | | | | | | | | | | Rename this section to explicitely name the multiple configuration feature "multiconfig". Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 286db24f37bf16a157d3897a046f1fc0d33a44b4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: move multiconfig documentation to its own documentAntonin Godard2025-02-263-154/+163
| | | | | | | | | | | In preparation of more section and examples to multiconfig, move the section about it in building.rst into its own document. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 6f60fb09976540dd320816684684c14f6b7ab460) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* vulnerabilities/classes: remove references to cve-check text formatMarta Rybczynska2025-02-261-28/+68
| | | | | | | | | | | The text format has been removed, so also remove references and examples using this format. Replace with examples with the JSON format. (From yocto-docs rev: a52cd7bcadccc53e982f90d6e170d00798322597) Signed-off-by: Marta Rybczynska <marta.rybczynska@ygreky.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/devtool: remove reference to the extensible SDKAntonin Godard2025-02-071-10/+5
| | | | | | | | | | | | | | | There were leftover references to the extensible SDK after moving the devtool documentation from the Extensible SDK document to its own devtool document. This patch follows the bulk move to make it clear what was modified in the document. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 032d2f3297ff4b5ee4e000b3dd0748a58b5f32e0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Move devtool doc from extensible to dev manualAntonin Godard2025-02-077-2/+1330
| | | | | | | | | | | | | | | | | | | | [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>
* dev-manual/packages: add information about signing changesZoltán Böszörményi2025-02-071-3/+13
| | | | | | | | | (From yocto-docs rev: 6c1a77e5db7ae9910d24deb023619b9391c8b4ad) Signed-off-by: Zoltán Böszörményi <zboszor@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/building: document the initramfs-framework recipeAntonin Godard2025-01-291-1/+83
| | | | | | | | | | | | | | | | | [ YOCTO #14747 ] Adding a initramfs is a common task, and the way oe-core offers to do so is by using the initramfs-framework recipe and companion modules. There was already documentation on adding an initramfs but the documentation was lacking details on this framework. Add it before the multiconfig section because it is a bit more important IMO. Reported-by: Alejandro <alejandro@enedino.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: caedbca4eced4cf5bc74aaae64e4ad2887c2fc65) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: move runtime-testing section to the test-manualAntonin Godard2025-01-092-595/+0
| | | | | | | | | | | | | In the same fashion as the previous commit ("ref-manual/packages: move ptest section to the test-manual"), move the runtime testing section of the development tasks manual to the test environment manual. Add a link to it from the test-manual/intro document. (From yocto-docs rev: 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/packages: move ptest section to the test-manualAntonin Godard2025-01-091-109/+3
| | | | | | | | | | | | | | [ YOCTO #15106 ] It makes more sense to document ptests in the test-manual. Since ptests are still related to packages, keep a link to ptests from packages.rst to the test-manual. Reported-by: Yoann Congal <yoann.congal@smile.fr> (From yocto-docs rev: b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Drop support for BB_DANGLINGAPPENDS_WARNONLYAntonin Godard2024-12-281-5/+17
| | | | | | | | | | | | | | | Support for this variable was dropped in BitBake, see commit fca9c9e3cb6f8e9f99bf51dc5e8a8d83f4c84c69 ("cooker: Drop support for BB_DANGLINGAPPENDS_WARNONLY"). Drop this variable here as well and rewrite the "Appending Other Layers Metadata With Your Layer" section to advise to rename the recipe and check if the bbappend is still relevant - otherwise to use BBWARN. (From yocto-docs rev: 10b59d09ebfb6c119995643ed68cb26092b6f2a4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove debug-tweaks referencesAntonin Godard2024-12-283-9/+8
| | | | | | | | | | | | | | | | | | | | | We no longer provide this feature, so remove documentation for it. In most cases, we can replace occurrences of "debug-tweaks" by "allow-empty-password empty-root-password allow-root-login post-install-logging" to achieve what this feature previously enabled. Subtle, but the default local.conf does not include post-install-logging, so in parts where there is mention of the default local.conf file, adjust the documentation to only mention the first three above. In the intro manual, instead of providing instructions that replace EXTRA_IMAGE_FEATURES entirely, provide ones that append EXTRA_IMAGE_FEATURES. (From yocto-docs rev: f0efd4c7df91863304b92514664bdd1fa62b1fbb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/bmaptool.rst: simplify and fix instructionsMichael Opdenacker2024-12-201-5/+4
| | | | | | | | | | | | | | | | | | | - Remove duplicate instructions - Detail how to run bmaptool directly if you installed it on your host instead of building it through the ``bmaptool-native`` recipe, as running "oe-run-native bmaptool-native bmaptool ..." won't work in this case. - Use "chmod a+w" instead of "chmod 666", better advice, and only run "chmod" in the option that runs "oe-run-native" (From yocto-docs rev: 4afa71ef6e5bf1db126c80e6d987f588d0b5a086) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/bmaptool.rst: correct command for bmaptool-nativeMichael Opdenacker2024-12-201-1/+1
| | | | | | | | | | | | | | | | | Using only "bitbake bmaptool-native", running "oe-run-native bmaptool-native bmaptool ..." fails as follows: Error: Have you run 'bitbake bmaptool-native -caddto_recipe_sysroot'? Running the "bitbake bmaptool-native -caddto_recipe_sysroot" target is actually sufficient. (From yocto-docs rev: 72fe904a3bbb5e2c7279ab1f119c2beca200dcf2) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: fix styling of references to bmaptoolMichael Opdenacker2024-12-202-11/+11
| | | | | | | | | | | | | | | To follow the styling conventions when we are refering to the name of a tool instead of the command itself (documentation/standards.md). This also improves the HTML rendering of the bmaptools subsection. (From yocto-docs rev: c569d840c4b6f43e10629b6f1ff45189211e27a9) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> 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-203-17/+15
| | | | | | | | | | | | | | | | | | | | | | 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>
* dev-manual: bblock: use warning block instead of attentionAntonin Godard2024-11-151-1/+1
| | | | | | | | | | | | Sphinx recommends using warning and note here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 7d5eb0cee5b2b7096969819d7d7ce569a3c92f27) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: document how to provide confs from layer.confAntonin Godard2024-11-151-0/+90
| | | | | | | | | | | | | | | | | | | | | | Add a section on providing global level configuration from the layer.conf file. Since this file is parsed at an earlier stage in the parsing process, it's not possible to combine bb.utils.contains and {DISTRO,MACHINE}_FEATURES to conditionally set some configurations. This patch documents: - First that this file can be used for providing such configuration. - Then demonstrate how to conditionally provide them, using a technique that is currently used in meta-virtualization (https://git.yoctoproject.org/meta-virtualization/tree/conf/layer.conf#n50). Fixes [YOCTO #12688]. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: cc3fa1b0e51377f4e03eaa1ca60c2f2ee0cd917e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: add bblock documentationJulien Stephan2024-11-072-0/+130
| | | | | | | | | | | | bblock is a helper tool to lock/unlock tasks and recipes to specific signatures. Add a documentation page for it. (From yocto-docs rev: a082aa39840587d3af6c3f4a2c2747564ca37414) Signed-off-by: Julien Stephan <jstephan@baylibre.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-08-12 16:34:42 +0000