aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@microsoft.com>2021-04-13 19:00:08 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-15 15:01:47 +0100
commit082683da089115d8b6f71f221cabb41ac401f733 (patch)
treed2696cdf1c6d1864b255cbbb4fc7d45d6eb9ca0a
parente70b925ba98fd4fedf3940d141a4210c953087ca (diff)
downloadbitbake-082683da089115d8b6f71f221cabb41ac401f733.tar.gz
bitbake-082683da089115d8b6f71f221cabb41ac401f733.tar.bz2
bitbake-082683da089115d8b6f71f221cabb41ac401f733.zip
bitbake-user-manual: document no support for using passwords in git URLs
This is based on the comment added in revision aded964eed4ce5a725ed1ab477efabc86b1aa481. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-fetching.rst9
1 files changed, 9 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 e9a5f336..bd6cc0ef 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -441,6 +441,15 @@ 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::
+
+ Specifying passwords directly in ``git://`` urls is not supported.
+ There are several reasons: ``SRC_URI`` is often written out to logs and
+ other places, and that could easily leak passwords; it is also all too
+ easy to share metadata without removing passwords. SSH keys, ``~/.netrc``
+ and ``~/.ssh/config`` files can be used as alternatives.
+
+
.. _gitsm-fetcher:
Git Submodule Fetcher (``gitsm://``)