summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual
Commit message (Collapse)AuthorAgeFilesLines
* bitbake: Add bitbake-setup documentationAntonin Godard2025-11-071-0/+822
| | | | | | | | | | Add documentation for bitbake-setup. This is split in 6 sections, including a quick start guide, terminology and reference. (Bitbake rev: 3089497efc7a1f3f143e151b9d5d024809269b9e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual/ref-variables: extend PERSISTENT_DIR docAntonin Godard2025-11-031-2/+7
| | | | | | | | | | | | | | | | Extend the current documentation of PERSISTENT_DIR: - Mention that it also contains the hash equivalence database when BB_HASHSERVE = auto. - Mention that it should not be shared between builds. [YOCTO #15727] (Bitbake rev: 682c2dccb67a57ecbf93aac8e9deea88bff10155) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: enhance SRCREV_FORMAT descriptionPatrick Vogelaar2025-11-031-0/+6
| | | | | | | | | | | Adding documentation for having an empty first component for the SRCREV_FORMAT. (Bitbake rev: 37ef26cfd5441ce97ff7ec0d5026c92091224c07) Signed-off-by: Patrick Vogelaar <patrick.vogelaar.dev@mailbox.org> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-ref-variables: improve INHERITAdam Blank2025-11-031-3/+11
| | | | | | | | | | | | | Current wording makes it difficult to understand what exactly is done with INHERIT-ed anonymous functions and when. (Bitbake rev: f06af69458083735e69f115edf73f783f18bc08c) Signed-off-by: Adam Blank <adam.blank.g@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: style and completeness correctionsAdam Blank2025-11-032-35/+35
| | | | | | | | | | | | Fix encountered style issues in the fetching section. Mention that "subdir" and fetcher specific parameters can stack-up. (Bitbake rev: 5cb35734c7056aa183bc15d454e125b75267449b) Signed-off-by: Adam Blank <adam.blank.g@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: AUTOREV and SRCREV_FORMAT roles in fetchingAdam Blank2025-11-032-5/+57
| | | | | | | | | | | | | | Describe the roles of AUTOREV and SRCREV_FORMAT in the fetching step. Add their missing descriptions to the variable reference section. Fixes [YOCTO #14498] (Bitbake rev: fbf0a8c5711f56bd64ae4c9d2c1d5ba884508c9f) Signed-off-by: Adam Blank <adam.blank.g@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual-metadata.rst: OE_BUILTIN_FRAGMENTS -> ↵Chen Qi2025-11-031-2/+2
| | | | | | | | | | | | | OE_FRAGMENTS_BUILTIN The actual variable name used in oe-core is OE_FRAGMENTS_BUILTIN, which is in a consistent format with other OE_FRAGMENTS_XXX vars. (Bitbake rev: 86c5f6aa59980d04264bc526976a49fdf749d1af) Signed-off-by: Chen Qi <Qi.Chen@windriver.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake/doc: Correct name of bitbake-dumpsigJörg Sommer2025-10-171-2/+2
| | | | | | | (Bitbake rev: 35a421cdcafb3595b9de5489ffdc567825400d26) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: extend classes and include/require documentationAntonin Godard2025-09-243-29/+131
| | | | | | | | | | | | | | | | | | | | | | | | The current documentation is lacking details on the different kinds of directories for putting classes as well as the order in which BitBake includes files (classes or include files). This patch does the following changes: - Mention the missing classes-recipe and classes-global when applicable. - Add a Class Types section detailed the three different directories for putting classes. - Move the existing section on locating classes/include files below the documentation on the different directives (include/require/inherit). - Extend the documentation on locating files with include/require and inherit to give proper examples, hopefully demystifying this mechanism a bit. [YOCTO #15724] (Bitbake rev: 7bd36f6c6d33211bb2a6b6fc6d40bdbd83b8b7c3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-ref-variables: update BB_TASK_IONICE_LEVELPeter Marko2025-08-191-2/+2
| | | | | | | | | | | | | | | | | Provided example does not work due to two problems. CFQ scheduler was removed in kernel 4.20 (per [1]) Replace it with BFQ scheduler. Also fix typo "queu" -> "queue". [1] https://en.wikipedia.org/wiki/I/O_scheduling (Bitbake rev: 6716853e35ebc2e1523210a83b483cdacb600295) Signed-off-by: Peter Marko <peter.marko@siemens.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-ref-variables: document BB_DEFER_BBCLASSESAntonin Godard2025-07-312-0/+22
| | | | | | | | | | | Document the BB_DEFER_BBCLASSES variable added in 8e741b2e885a ("ast/BBHandler: Add support for BB_DEFER_BBCLASSES"). (Bitbake rev: 3f9eba26b29db526fed263a7e70b824988e17656) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-intro: Mention existence of three supported ↵Robert P. J. Day2025-07-311-0/+12
| | | | | | | | | | | | | "classes" directories Early in Section 1, mention that BitBake supports three related classes directories. (Bitbake rev: 0d5201e904b0e6f4dd9f7bb116dda508ec09b78a) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-intro: Add examples to show general wildcardingRobert P. J. Day2025-07-311-0/+2
| | | | | | | | | | | Add a couple more examples to the wildcarding section to make sure readers understand it's not just a single character wildcard. (Bitbake rev: 572062ba1f0a2953a62ef1974e35134fcb462f5e) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-ref-variables: fixupsAntonin Godard2025-07-311-11/+11
| | | | | | | | | | | | Fix typos reported by Quentin here: https://lore.kernel.org/r/cee995db-4c3d-4bf0-813d-ce3f5f8f92e3@cherry.de https://lore.kernel.org/r/73497b5e-721e-4e5f-beb4-c56ab9178c9f@cherry.de Cc: Quentin Schulz <quentin.schulz@cherry.de> (Bitbake rev: add8a7ac093d60e731a638c25ec15efcc3988781) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake: clarify significance of "include_all" directiveRobert P. J. Day2025-07-281-30/+39
| | | | | | | | | | | | Rewrite the include and include_all sections to drive home the fact that the include_all directive is relevant in only very specific cases, and not something developers should expect to use in normal operation. (Bitbake rev: 4b3bfe70d02cc1c11972357e2dc595acc75056e5) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-fetching: update the Git fetcher tag ↵Antonin Godard2025-07-221-4/+6
| | | | | | | | | | | | description After commit d591d7633fe8 ("fetch/git: Rework tag parameter handling"), update the description of the tag= parameter for the Git fetcher. (Bitbake rev: 85b31a55d114a1430868233d56573b470fef8908) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-fetching: remove 'rev' default valueAntonin Godard2025-07-181-2/+2
| | | | | | | | | | | Remove rev's "master" default value. Mention that it must match SRCREV, if set. Reported-by: Quentin Schulz <quentin.schulz@cherry.de> (Bitbake rev: 2519b317e4afb1686f907274715a9e2b9c6457f4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual-ref-variables: improve BB_PRESSURE_* docAntonin Godard2025-06-261-6/+64
| | | | | | | | | | | | | | | | The current default value for BB_PRESSURE_MAX_CPU is 500, which is really low for most systems. Provide a value of 15000 which limits the load average without being extremely slow either. Provide similar values for BB_PRESSURE_MAX_IO and BB_PRESSURE_MAX_MEMORY. Mention that these should be adjusted depending on the need, and warn about the potential spam of messages when the value is too low. (Bitbake rev: 09baa527dafca4bdf56a9189f6b3f7512886cbfb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual-ref-variables: document ↵Antonin Godard2025-06-261-0/+5
| | | | | | | | | | | | BB_GIT_DEFAULT_DESTSUFFIX This variable was recently added with 378db0fdd95f ("fetch2/git: allow overriding default unpack directory with a variable"). (Bitbake rev: a569be0d369cb8b9457beedfeb75b984f751ba5a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: correctly reference UNPACKDIR when describing ↵Alexander Kanavin2025-06-261-14/+7
| | | | | | | | | | | unpacking Also, drop an obsolete S = WORKDIR/git note. (Bitbake rev: 3884b386cda649030f59e3040dd08e6aa2ec50cf) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: parse/ast: add support for 'built-in' fragmentsAlexander Kanavin2025-06-201-2/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When reviewing proposed fragments to add settings for DISTRO and MACHINE, RP noted that such fragments only add clutter and overhead, and there's no need to maintain them as separate files. Rather when bitbake sees 'fragmentvar/fragmentvalue' it can expand that into FRAGMENTVAR = "fragmentvalue". To achieve that, 'addfragments' directive is extended with a parameter that sets the name of the variable that holds definitions of such built-in fragments, for example like this: "machine:MACHINE distro:DISTRO" Then each enabled fragment name is matched against these definitions and the respective variable is set, e.g. 'machine/qemuarm' would match 'machine:MACHINE' and result in MACHINE set to 'qemuarm'. This happens before any fragment files are looked up on disk, and no such lookup happens if there was a match, which should prevent possible misuse of the feature. So the builtin fragment definition is also an allowlist for them. Please also see the patches for oe-core that show an application of the feature. (Bitbake rev: 3b9d7bea915dc7f10e845854f1dae325743f9456) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: fetch/az: Add sanity check and clarify documentationRobbin Van Damme2025-06-021-2/+2
| | | | | | | | | | | | AZ_SAS token should be prefixed with a question mark. Add a sanity check for this and fix the documentation. [YOCTO #15882] (Bitbake rev: 22011765202514600314732b97f1bb938e21f585) Signed-off-by: Robbin Van Damme <robbinvandamme@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual-metadata: provide link to new docAntonin Godard2025-04-241-5/+2
| | | | | | | | | | | Replace the now obsolete paragraph of the "Other Functions" section by a link to the new "Library Functions" document. (Bitbake rev: 0eecb4b2ee4fe5339340ed0d08783aa03bf051cc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: add a new Library Functions documentAntonin Godard2025-04-241-0/+59
| | | | | | | | | | | | | | | | | | Add a new document to the BitBake user manual that automatically documents the library functions from their docstrings. The docstrings can be formatted in reStructuredText. Here logging utilities and the bb.utils module is documented. Some members of the utils module were deliberately excluded as their usage is most likely only internal to BitBake. Fixes [YOCTO #9612] (Bitbake rev: 0a711949acc2696f32a61c591ee3ea37041acb91) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-metadata.rst: fix python task exampleAntonin Godard2025-04-101-2/+2
| | | | | | | | | | | | | | Fix the old Python 2 print statement, replace it by a bb.plain() call instead. Also replace time by datetime for a slightly simpler example. [YOCTO #14670] Reported-by: Robert Berger <pokylinux@reliableembeddedsystems.com> (Bitbake rev: 874c607f475f3d60677d2720b80a28d0c2e963c6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual-metadata: document the include_all directiveAntonin Godard2025-03-111-0/+27
| | | | | | | | | | Document the include_all directive, which can be used to include multiple files present in the same location in different layers. (Bitbake rev: bd41f09c7fa67f917246a740fd4068e4588a1dcd) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual-ref-variables: document BB_USE_HOME_NPMRCEric Meyers2025-03-091-0/+6
| | | | | | | | | (Bitbake rev: d5562e007c7c64e8613a118ab9a6c73ed2063263) Signed-off-by: Eric Meyers <eric.meyers@arthrex.com> Cc: Geoff Parker <geoffrey.parker@arthrex.com> Cc: Chuck Wolber <chuckwolber@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Update documentation for fast `BB_GIT_SHALLOW`Stefan Koch2025-03-061-5/+20
| | | | | | | (Bitbake rev: b92c95fab631156e8c7ecc4ab18e4b16f7e590dc) Signed-off-by: Stefan Koch <stefan-koch@siemens.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual-ref-variables: document BB_CURRENT_MCAntonin Godard2025-02-251-0/+5
| | | | | | | | | | | Document the BB_CURRENT_MC variable, which holds the name of the current multiconfig build a task is being run under. (Bitbake rev: 178e09ea5ea39e60452077fa2ab90b90478ada6e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake-user-manual-metadata: fix unindent warningsAntonin Godard2024-12-281-3/+3
| | | | | | | | | | | | | Fix Sphinx warnings (treated as errors on local builds): bitbake-user-manual-metadata.rst:979: WARNING: Bullet list ends without a blank line; unexpected unindent. bitbake-user-manual-metadata.rst:982: WARNING: Bullet list ends without a blank line; unexpected unindent. bitbake-user-manual-metadata.rst:985: WARNING: Bullet list ends without a blank line; unexpected unindent. (Bitbake rev: 51d89ce0fc8d188bf10a8bcc6a112466268899ae) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: Document suffix for BBFILE_PRIORITYSimon A. Eugster2024-12-201-1/+5
| | | | | | | | | (Bitbake rev: 08c340d97717e632c5185a52eec46d90359d4006) Signed-off-by: Simon A. Eugster <simon.eu@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual-metadata: add a section about 'addfragments`Alexander Kanavin2024-12-131-1/+47
| | | | | | | (Bitbake rev: 47e4645da582daa8f3e818ba98e9652c2dcf202f) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: document inherit_deferAntonin Godard2024-11-281-7/+36
| | | | | | | | | | | | | | | This was added in 2.7.2. Since using inherit_defer is safer that inherit when inheriting conditionally, move the instructions about that in inherit_defer. Fixes [YOCTO #15640]. Reported-by: Yoann Congal <yoann.congal@smile.fr> (Bitbake rev: eb10df5a9619e243e28e0f4cd6122c24ed668f52) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: cooker: Drop support for BB_DANGLINGAPPENDS_WARNONLYRichard Purdie2024-11-211-12/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | DANGLINGAPPENDS_WARNONLY is a very poorly designed interface and is commonly abused. The challenge is that once it is set, by any layer, it applies everywhere. Some layers rely on this to get notification they need to update bbappend files and having the behaviour change from inclusion of an antisocial layer is not good. In addition, showing warnings as an accepted thing on the console devalues them and trains the user to ignore them. I want to steer us away from this mindset. We could extend the functionality and make it apply only to certain layers, or only to certain appends but then we've basically re-invented BBMASK. Given all the above, we should drop support for BB_DANGLINGAPPENDS_WARNONLY and direct anyone with issues to BBMASK instead. https://lists.openembedded.org/g/openembedded-architecture/message/2029 [YOCTO #14870] (Bitbake rev: fca9c9e3cb6f8e9f99bf51dc5e8a8d83f4c84c69) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/user-manual: Refresh help outputYoann Congal2024-11-181-74/+100
| | | | | | | | | | | | | In commit 9257c48c3e36 ("Group and reorder options in bitbake help"), help output was changed, update the doc to match the new output. (Bitbake rev: 7ef357f1c6fcd50c9d22190ba39d1cfd82070c79) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake: doc/user-manual: Update the BB_HASHSERVE_UPSTREAMJose Quaresma2024-11-021-1/+1
| | | | | | | (Bitbake rev: d8a044351dea6c9e324a8e00dd1aa6f2b606fec6) Signed-off-by: Jose Quaresma <jose.quaresma@foundries.io> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/user-manual: Add BB_LOADFACTOR_MAXRichard Purdie2024-04-121-0/+9
| | | | | | | | Document BB_LOADFACTOR_MAX which was recently added. (Bitbake rev: 833b76e9333e317cab5f17d6f7daaecc89c69547) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: Add section for variable contextSimone Weiß2024-04-111-0/+91
| | | | | | | | | | | | | | This is inspired by the same section in the yocto-docs. It aims to provide information in what contexts(recipes, .conf, bbclass,...) a variable is usually used. For that I tried to group similar variables, so that a short overview is given. This was inspired by [YOCTO #14072], but of course does not implement a warning if a variable is used in an unintended context. (Bitbake rev: 5ced476685376b1a32b7fdd9546f9b61c5962aa0) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake: improve descriptions of '-S printdiff'Alexander Kanavin2024-03-221-3/+4
| | | | | | | (Bitbake rev: becf88c2250a47102c8d36ad8b40839e0bfa9137) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: remove reference to SSTATE_MIRRORS variableMichael Opdenacker2023-09-051-2/+3
| | | | | | | | | | This variable is implemented in OE-Core, and therefore only documented in the Yocto Project manual. (Bitbake rev: 1019998e2f8682c8f2f13320fdb0de1a9a23e854) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: Document challenges of tags with git fetcherRichard Purdie2023-09-051-0/+8
| | | | | | | | | Using tags with the git fetcher may cause surprising behaviour. There are reasons for this, document them. (Bitbake rev: 56224da378ab63526d44fd7a70bcfd2cffe245cc) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: fetch2: add Google Cloud Platform (GCP) fetcherEmil Ekmečić2023-08-111-0/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This fetcher allows BitBake to fetch from a Google Cloud Storage bucket. The fetcher expects a gs:// URI of the following form: SSTATE_MIRRORS = "file://.* gs://<bucket name>/PATH" The fetcher uses the Google Cloud Storage Python Client, and expects it to be installed, configured, and authenticated prior to use. If accepted, this patch should merge in with the corresponding oe-core patch titled "Add GCP fetcher to list of supported protocols". Some comments on the patch: There is also documentation for the fetcher added to the User Manual. I'm still not completely sure about the recommends_checksum() being set to True. As I've noted in the mailing list, it will throw warnings if the fetcher is used in recipes without specifying a checksum. Please let me know if this is intended behavior or if it should be modified. Here is how this fetcher conforms to the fetcher expectations described at this link: https://git.yoctoproject.org/poky/tree/bitbake/lib/bb/fetch2/README a) Yes, network fetching only happens in the fetcher b) The fetcher has nothing to do with the unpack phase so there is no network access there c) This change doesn't affect the behavior of DL_DIR. The GCP fetcher only downloads to the DL_DIR in the same way that other fetchers, namely the S3 and Azure fetchers do. d) The fetcher is identical to the S3 and Azure fetchers in this context e) Yes, the fetcher output is deterministic because it is downloading tarballs from a bucket and not modifying them in any way. f) I set up a local proxy using tinyproxy and set the http_proxy variable to test whether the Python API respected the proxy. It appears that it did as I could see traffic passing through the proxy. I also did some searching online and found posts indicating that the Google Cloud Python APIs supported the classic Linux proxy variables, namely: - https://github.com/googleapis/google-api-python-client/issues/1260 g) Access is minimal, only checking if the file exists and downloading it if it does. h) Not applicable, BitBake already knows which version it wants and the version infomation is encoded in the filename. The fetcher has no concept of versions. i) Not applicable j) Not applicable k) No tests were added as part of this change. I didn't see any tests for the S3 or Azure changes either, is that OK? l) I'm not 100% familiar but I don't believe this fetcher is using any tools during parse time. Please correct me if I'm wrong. (Bitbake rev: 8e7e5719c1de79eb488732818871add3a6fc238b) Signed-off-by: Emil Ekmečić <eekmecic@snap.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: bitbake-user-manual: bitbake-user-manual-hello: add links and ↵Quentin Schulz2023-06-241-7/+7
| | | | | | | | | | | | | | | | highlights for variables Some variables are described in the glossary so add a term role to the references. For the others, highlight them by surrounding them with two backticks. Cc: Quentin Schulz <foss+yocto@0leil.net> (Bitbake rev: 7290a9daf1707ab5b2288f34353f499f5ce57d6a) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: revert change about PREFERRED_PROVIDERSMichael Opdenacker2023-06-211-3/+3
| | | | | | | | | | Partially reverting https://git.openembedded.org/bitbake/commit/?id=d1779e2f7789e516efae434b3781c981d0ef4ded (Bitbake rev: 0556c7bdc82cf665faa141989f2e07dd59517735) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: Document FILE_LAYERNAMERichard Purdie2023-06-201-0/+5
| | | | | | | | Document the new variable. (Bitbake rev: bee20cc624a1155376cf3c899dc5c6d850dacb2c) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: explicit variables taking a colon separated listMichael Opdenacker2023-06-191-8/+8
| | | | | | | | | [YOCTO #15128] (Bitbake rev: d1779e2f7789e516efae434b3781c981d0ef4ded) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: document "network" task flagMichael Opdenacker2023-06-021-0/+6
| | | | | | | | | This addresses [YOCTO #15127] (Bitbake rev: 6abdc81dec06a362bfbcc06d69b90b96bd9bef01) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: fix BB_RUNFMT's default valueUlrich Ölmann2023-04-271-1/+1
| | | | | | | | | | | | According to the code the default value is slightly different (see [1] which reflects the current tip commit at the time of writing). [1] https://git.openembedded.org/bitbake/tree/lib/bb/build.py?id=d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c#n237 (Bitbake rev: c9aaac79f62bb388ec87ca80b6ac119ef39c7c4a) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: add BB_HASH_CODEPARSER_VALSPaul Eggleton2023-04-221-0/+11
| | | | | | | | | New variable for 2.4. (Bitbake rev: d97d62e2cbe4bae17f0886f3b4759e8f9ba6d38c) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: add addpylib and BB_GLOBAL_PYMODULESPaul Eggleton2023-04-222-0/+26
| | | | | | | | | New directive and variable for 2.4. (Bitbake rev: 1b74a7b71e6c8a034163b57ef4e13b4a58c1f844) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-02-13 08:33:23 +0000