aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@theobroma-systems.com>2021-09-08 10:50:03 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-09-08 15:55:10 +0100
commitc394f34437686c2f57a27f0c06d7aeb3268bfd41 (patch)
treeb99948bde2251a52ce341a1dd4550faa61d87e52
parentae24a0f2d2d8b4b5ec10efabd0e9362e560832ea (diff)
downloadbitbake-c394f34437686c2f57a27f0c06d7aeb3268bfd41.tar.gz
doc: bitbake-user-manual-fetching: S should be set to WORKDIR/git for git fetcher
Document that S has to be set to "${WORKDIR}/git" in order for the recipe to work if the git fetcher is fetching the main source of code for the recipe. Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-fetching.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index 40b245b6d..a944d0f78 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -441,6 +441,13 @@ Here are some example URLs::
.. note::
+ When using ``git`` as the fetcher of the main source code of your software,
+ ``S`` should be set accordingly::
+
+ S = "${WORKDIR}/git"
+
+.. note::
+
Specifying passwords directly in ``git://`` urls is not supported.
There are several reasons: :term:`SRC_URI` is often written out to logs and
other places, and that could easily leak passwords; it is also all too