| Message ID | 20251030-bitbake-setup-v1-2-f44a8a2b7c0b@bootlin.com |
|---|---|
| State | New |
| Headers | show |
| Series | Start switching the documentation to bitbake-setup | expand |
lgtm Alex On Thu, 30 Oct 2025 at 17:29, Antonin Godard via lists.yoctoproject.org <antonin.godard=bootlin.com@lists.yoctoproject.org> wrote: > > This was not documented and its usage is going to increase massively > once users start using bitbake-setup. Add a description for this file as > well as an example on how bitbake-setup shares it for multiple builds, > to insist on the "site-wide" usage of this file. > > Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> > --- > Note: a link to bitbake-setup documentation comes in the next patch. > --- > documentation/ref-manual/structure.rst | 29 +++++++++++++++++++++++++++++ > 1 file changed, 29 insertions(+) > > diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst > index f7d7a819d..d817ee426 100644 > --- a/documentation/ref-manual/structure.rst > +++ b/documentation/ref-manual/structure.rst > @@ -339,6 +339,35 @@ Once the build process gets the sample file, it uses ``sed`` to substitute final > version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/templates/default`` > directory. > > +.. _structure-build-conf-site.conf: > + > +``build/conf/site.conf`` > +======================== > + > +This configuration file contains the site specific configurations for your build > +environment. > + > +You could for example edit this file to limit the number of threads used by > +:term:`BitBake` (:term:`BB_NUMBER_THREADS`) or set the location from which you > +want to access downloaded files (:term:`DL_DIR`). > + > +This file can be shared for multiple build directories. For example, > +``bitbake-setup`` makes the :ref:`structure-build-conf-site.conf` file a > +symbolic link to a common ``site.conf`` file:: > + > + ├── poky-master-poky-distro_poky-machine_qemux86-64/ > + │ └── build/ > + │ └── conf/ > + │ └── site.conf -> ../../../site.conf > + ├── poky-master-poky-with-sstate-distro_poky-machine_qemux86-64/ > + │ └── build/ > + │ └── conf/ > + │ └── site.conf -> ../../../site.conf > + └── site.conf > + > +This way, site-specific settings can be shared for multiple build > +configurations. > + > .. _structure-build-conf-bblock.conf: > > ``build/conf/bblock.conf`` > > -- > 2.51.0 > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#7927): https://lists.yoctoproject.org/g/docs/message/7927 > Mute This Topic: https://lists.yoctoproject.org/mt/116033120/1686489 > Group Owner: docs+owner@lists.yoctoproject.org > Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [alex.kanavin@gmail.com] > -=-=-=-=-=-=-=-=-=-=-=- >
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index f7d7a819d..d817ee426 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -339,6 +339,35 @@ Once the build process gets the sample file, it uses ``sed`` to substitute final version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/templates/default`` directory. +.. _structure-build-conf-site.conf: + +``build/conf/site.conf`` +======================== + +This configuration file contains the site specific configurations for your build +environment. + +You could for example edit this file to limit the number of threads used by +:term:`BitBake` (:term:`BB_NUMBER_THREADS`) or set the location from which you +want to access downloaded files (:term:`DL_DIR`). + +This file can be shared for multiple build directories. For example, +``bitbake-setup`` makes the :ref:`structure-build-conf-site.conf` file a +symbolic link to a common ``site.conf`` file:: + + ├── poky-master-poky-distro_poky-machine_qemux86-64/ + │ └── build/ + │ └── conf/ + │ └── site.conf -> ../../../site.conf + ├── poky-master-poky-with-sstate-distro_poky-machine_qemux86-64/ + │ └── build/ + │ └── conf/ + │ └── site.conf -> ../../../site.conf + └── site.conf + +This way, site-specific settings can be shared for multiple build +configurations. + .. _structure-build-conf-bblock.conf: ``build/conf/bblock.conf``
This was not documented and its usage is going to increase massively once users start using bitbake-setup. Add a description for this file as well as an example on how bitbake-setup shares it for multiple builds, to insist on the "site-wide" usage of this file. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- Note: a link to bitbake-setup documentation comes in the next patch. --- documentation/ref-manual/structure.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+)