[PATCH] doc: bitbake-user-manual-fetching: S should be set to WORKDIR/git for git fetcher

[PATCH] doc: bitbake-user-manual-fetching: S should be set to WORKDIR/git for git fetcher

[Quentin Schulz]

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>
---
 doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index 40b245b6d3..aad0700180 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -439,6 +439,13 @@ Here are some example URLs::
    SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1"
    SRC_URI = "git://git.oe.handhelds.org/git/vip.git;protocol=http"
 
+.. 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.
-- 
2.31.1