linux/poky.git/bitbake/doc, branch dunfell-23.0.23

bitbake: fetch2/git: Clarify the meaning of namespace

2023-02-13T07:48:16+00:00

Namespace in this context means a branch, a tag, etc., clarify it in the description. Also, fix a typo "a any", replace with plain "any". This patch is based of feedback on new applied patch d32e5b0e ("fetch2/git: Prevent git fetcher from fetching gitlab repository metadata") (Bitbake rev: c527976e28165de9606497c48d834872fe68372e) Signed-off-by: Marek Vasut Signed-off-by: Richard Purdie (cherry picked from commit b4999425c812b25cb359d5163d11e3c1b030dc28) Signed-off-by: Steve Sakoman Signed-off-by: Richard Purdie

bitbake: fetch2/git: Prevent git fetcher from fetching gitlab repository metadata

2023-02-13T07:48:16+00:00

The bitbake git fetcher currently fetches 'refs/*:refs/*', i.e. every single object in the remote repository. This works poorly with gitlab and github, which use the remote git repository to track its metadata like merge requests, CI pipelines and such. Specifically, gitlab generates refs/merge-requests/*, refs/pipelines/* and refs/keep-around/* and they all contain massive amount of data that are useless for the bitbake build purposes. The amount of useless data can in fact be so massive (e.g. with FDO mesa.git repository) that some proxies may outright terminate the 'git fetch' connection, and make it appear as if bitbake got stuck on 'git fetch' with no output. To avoid fetching all these useless metadata, tweak the git fetcher such that it only fetches refs/heads/* and refs/tags/* . Avoid using negative refspecs as those are only available in new git versions. Per feedback on the ML, Gerrit may push commits outsides of branches or tags during CI runs, which currently works with the 'nobranch=1' fetcher parameter. To retain this functionality, keep fetching everything in case the 'nobranch=1' is present. This still avoids fetching massive amount of data in the common case, since 'nobranch=1' is rare. Update 'nobranch' documentation. Reviewed-by: Peter Kjellerstedt (Bitbake rev: efb2903e6c94a5c884485ecb91f1fca7e8ee18f1) Signed-off-by: Marek Vasut Signed-off-by: Alexandre Belloni (cherry picked from commit d32e5b0ec2ab85ffad7e56ac5b3160860b732556) Signed-off-by: Steve Sakoman Signed-off-by: Richard Purdie

bitbake: doc/conf.py: add missing import sys

2021-01-04T10:55:00+00:00

Due to the calls to sys.stderr.write() and sys.exit() in exception handling in case of sphinx_rtd_theme not being installed, the following exception is raised by Python due to the fact that sys module not being imported. (Bitbake rev: a394eeec6aeb98c6395cb5da2036ce936bdaa0a0) Signed-off-by: Richard Purdie (cherry picked from commit 5ddf0e5bee0de59d07295fc5693e20b1a0380fde) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

bitbake: sphinx: partial undo (bitbake-user-manual: update perforce fetcher docs)

2021-01-04T10:55:00+00:00

This change is not applicable to 1.46/dunfell branch, and was brought by the automatic backport of Sphinx docs, so let's undo it. Note that this patch also included a general statement which applies to 1.46, so this snippet was not removed. (Bitbake rev: b164cf6790e47271a0848104a6c9507dd35c7f8f) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

bitbake: sphinx: undo (bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example)

2021-01-04T10:55:00+00:00

This change is not applicable to 1.46/dunfell branch, and was brought by the automatic backport of Sphinx docs, so let's undo it. (Bitbake rev: 07bc934fab62c0a238ec62a8516396191095a231) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

bitbake: sphinx: import sphinx docs

2021-01-04T10:55:00+00:00

The Bitbake manual was migrated to Sphinx in Yocto Project 3.2. Since the docs between 3.2 and 3.1 are "similar", and since 3.1 is an LTS release, we agreed to backport the documentation onto 3.1. If we look at all docs changes in 3.1 and 3.2, we have the following: === Changes in 3.1 git log --oneline b94dec477a8d48ebceec91952ba290798c56c1f5..origin/1.46 -- doc/ ==== 324aaa7f bitbake-user-manual-metadata.xml: fix a minor error f92e19a3 doc: More explanation to tasks that recursively depend on themselves e4695176 doc: Clarify how task dependencies relate to RDEPENDS 25c5c79b user manual: properly tag content as be367887 docs: delete reference to obsolete recipe-depends.dot === Changes in 3.2/master git log --oneline b94dec477a8d48ebceec91952ba290798c56c1f5..origin/master -- doc/ ==== a7c47f1e sphinx: rename Makefile.sphinx 427721d8 sphinx: remove DocBook files d52190ea docs: static: theme_overrides.css: fix responsive design on <640px screens 9ae5cce7 docs: sphinx: report errors when dependencies are not met ec4c481a docs: update README file after migrationg to Sphinx c87cc35a docs: sphinx: replace special quotes with double quotes ebdeef2c docs: ref-variables: add links to terms in glossary 29081375 bitbake-user-manual: fix bad links a0f37789 sphinx: theme_override: Use bold for emphasis text cbc5ca48 sphinx: theme_override: properly set font for verbatim text 08b1ae23 sphinx: remove leading '/' 99ba6fe9 sphinx: update style for important, caution and warnings d99760cc sphinx: last manual round of fixes/improvements 4f94633a sphinx: bitbake-user-manual: insert additional blank line after title 63adcaa5 sphinx: add releases page 3e940d93 sphinx: conf: enable extlinks extension 9921c652 sphinx: index: move the boilerplate at the end of the page 4e461224 sphinx: add SPDX headers cb19159c sphinx: Enhance the sphinx experience/nagivation with: 10a54678 sphinx: tweak html output a bit 219b2348 sphinx: Makefile.sphinx: add clean and publish targets 35fdc185 sphinx: fixes all remaining warnings e11d2dd1 sphinx: fix links inside notes 57300955 sphinx: fixup for links fa304c01 sphinx: override theme CSS 29af1cd2 sphinx: switch to readthedocs theme e8359fd8 sphinx: bitbake-user-manual: use builtin sphinx glossary 6bf6c8d6 sphinx: initial sphinx support 84ccba0f sphinx: add initial build infrastructure 44b57216 bitbake-user-manual: update perforce fetcher docs 9186ca47 bitbake-user-manual: Add BBFILES_DYNAMIC 7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example 06b5cf0a bitbake-user-manual-metadata.xml: fix a minor error c92a266c doc: More explanation to tasks that recursively depend on themselves caf42243 doc: Clarify how task dependencies relate to RDEPENDS 647c13d4 user manual: properly tag content as 2effbb6e docs: delete reference to obsolete recipe-depends.dot We can conclude the following commits exist in 3.2 and not in 3.1 (if we filter out sphinx changes) 44b57216 bitbake-user-manual: update perforce fetcher docs 9186ca47 bitbake-user-manual: Add BBFILES_DYNAMIC 7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example Out of these 3 changes, the following patches are for 3.2 only: 44b57216 bitbake-user-manual: update perforce fetcher docs 7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example To backport the Sphinx docs, we then need to cherry-pick all docs patches from 3.2/1.48 and 'undo' the two patches above. This first patch is the first step that imports all Sphinx files, and remove Docbook files. It was done with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ b94dec477a8d48ebceec91952ba290798c56c1f5..origin/master -- doc/ \ | cut -f1 -d' ') (Bitbake rev: cd68f14031eb45006b44d10b348e35c69ac21ad0) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

bitbake: bitbake-user-manual: Add BBFILES_DYNAMIC

2020-10-13T08:40:10+00:00

- add missing entry for BBFILES_DYNAMIC, ported from yocto-docs - add description for the new inverse mode (Bitbake rev: c27a5cc80852595549ad4156e4bb7f5a05e4cd15) Signed-off-by: Konrad Weihmann Signed-off-by: Richard Purdie (cherry picked from commit 9186ca47ce73b4d1c87eb69163698a04679fb55c) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

bitbake: bitbake-user-manual-metadata.xml: fix a minor error

2020-06-05T20:37:15+00:00

In the '_remove' example in bitbake-user-manual-metadata.xml, there is no 'jkl' in the original value of FOO2. So remove it from result. (Bitbake rev: 324aaa7f8d6d83e1e00b8054dac44df561588be8) Signed-off-by: Kai Kang Signed-off-by: Richard Purdie (cherry picked from commit 06b5cf0ab6c6e518ac780d081fab5546334c5c7d) Signed-off-by: Steve Sakoman Signed-off-by: Richard Purdie

bitbake: doc: More explanation to tasks that recursively depend on themselves

2020-06-05T20:37:15+00:00

(Bitbake rev: f92e19a3b3d89eb26eeb74b18ca01248767035b5) Signed-off-by: Jacob Kroon Signed-off-by: Richard Purdie (cherry picked from commit c92a266c8e452833f2a590721aa1c2bd6fbeb2e0) Signed-off-by: Steve Sakoman Signed-off-by: Richard Purdie

bitbake: doc: Clarify how task dependencies relate to RDEPENDS

2020-06-05T20:37:15+00:00

Clarify that BitBake knows how to map entries defined in the runtime dependency namespace back to build-time dependencies (recipes) in which tasks are defined. (Bitbake rev: e4695176ffdc5eb959f71a08f77ff6a8e028ffa9) Signed-off-by: Jacob Kroon Signed-off-by: Richard Purdie (cherry picked from commit caf422435ad64aacbdab8a94da3115599dd0938b) Signed-off-by: Steve Sakoman Signed-off-by: Richard Purdie