@@ -112,6 +112,34 @@ Going Further
:doc:`/dev-manual/hashequivserver` section of the Yocto Project Development
Tasks Manual for more information.
+- If the mirror is protected behind a username and password, the
+ :term:`build host` needs to be configured so the :term:`build system
+ <OpenEmbedded Build System>` is able to download the shared state cache using
+ authentication.
+
+ The recommended way to do that is by setting the following parameters
+ in ``$HOME/.netrc`` (``$HOME`` being the :term:`build host` home
+ directory)::
+
+ machine someserver.tld
+ login <user>
+ password <password>
+
+ This file requires permissions set to ``400`` or ``600`` to prevent
+ other users from reading the file:
+
+ .. code-block:: console
+
+ $ chmod 600 "$HOME/.netrc"
+
+ Another method to configure the username and password is from the
+ URL in :term:`SSTATE_MIRRORS` directly, with the ``user`` and ``pswd``
+ parameters::
+
+ SSTATE_MIRRORS ?= "\
+ file://.* https://someserver.tld/share/sstate/PATH;user=<user>;pswd=<password>;downloadfilename=PATH \
+ "
+
- If the :term:`BB_NO_NETWORK` variable is set to "1" on clients as a means to
disable any accesses to the network, the :term:`SSTATE_MIRROR_ALLOW_NETWORK`
variable may be used to allow the clients to fetch from the shared state
@@ -10100,34 +10100,6 @@ system and gives an overview of their function and contents.
cache (sstate-cache) results from previous builds. The sstate-cache
you point to can also be from builds on other machines.
- .. note::
-
- If the mirror is protected behind a username and password, the
- :term:`build host` needs to be configured so the :term:`build system
- <OpenEmbedded Build System>` is able to download the sstate cache using
- authentication.
-
- The recommended way to do that is by setting the following parameters
- in ``$HOME/.netrc`` (``$HOME`` being the :term:`build host` home
- directory)::
-
- machine someserver.tld
- login <user>
- password <password>
-
- This file requires permissions set to ``400`` or ``600`` to prevent
- other users from reading the file::
-
- chmod 600 "$HOME/.netrc"
-
- Another method to configure the username and password is from the
- URL in :term:`SSTATE_MIRRORS` directly, with the ``user`` and ``pswd``
- parameters::
-
- SSTATE_MIRRORS ?= "\
- file://.* https://someserver.tld/share/sstate/PATH;user=<user>;pswd=<password>;downloadfilename=PATH \
- "
-
The Yocto Project actually shares the cache data objects built by its
autobuilder::
Let's gather the different tips on setting up a shared state mirror in the same document, so move the user/password note from the SSTATE_MIRRORS variable definition to the sstate-mirrors-setup.rst doc. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- documentation/dev-manual/sstate-mirrors-setup.rst | 28 +++++++++++++++++++++++ documentation/ref-manual/variables.rst | 28 ----------------------- 2 files changed, 28 insertions(+), 28 deletions(-)