ref-manual: Updated the S variable description.

Fixes [YOCTO #8542]

I updated the description with a new example specific to Git.
When you use Git, you have to specifically set the S directory
for things to work.

(From yocto-docs rev: e31f6ba125c4e173832793c14c931c8298ba3510)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 11 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 3d68dd6ac2..f5249416b9 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -10626,6 +10626,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
      poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
                     </literallayout>
                 </para>
+
+                <para>
+                    This next example assumes Git, which means the default
+                    directory is <filename>${WORKDIR}/git</filename>.
+                    Consequently, you must explicitly set
+                    <filename>S</filename> so the source can be located:
+                    <literallayout class='monospaced'>
+     SRC_URI = "git://path/to/repo.git"
+     S = "${WORKDIR}/git"
+                    </literallayout>
+                </para>
             </glossdef>
         </glossentry>