diff options
| author |   Quentin Schulz <quentin.schulz@theobroma-systems.com> | 2022-01-17 14:08:16 +0100 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-01-17 21:53:50 +0000 |
| commit | 81c09d434aed13fcfc4ba426ae6a0b849447eb5f (patch) | |
| tree | a4497111dabc3df2cf390e3254f24e0ab9ef1716 /doc | |
| parent | 98407efc8c670abd71d3fa88ec3776ee9b5c38f3 (diff) | |
| download | bitbake-81c09d434aed13fcfc4ba426ae6a0b849447eb5f.tar.gz | |
doc: bitbake-user-manual: specify the URL to be used with SSH over git is different from `git clone`'s
The URL expected by git fetcher when the SSH protocol is used differs
from the one given by Git servers to be used with the `git clone`
command.
Add a note making this specificity known to users.
Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | 14 |
1 files changed, 14 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 0fc2d5e69..77384cfdc 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst @@ -396,6 +396,19 @@ This fetcher supports the following parameters: protocol is "file". You can also use "http", "https", "ssh" and "rsync". + .. note:: + + When ``protocol`` is "ssh", the URL expected in :term:`SRC_URI` differs + from the one that is typically passed to ``git clone`` command and provided + by the Git server to fetch from. For example, the URL returned by GitLab + server for ``mesa`` when cloning over SSH is + ``git@gitlab.freedesktop.org:mesa/mesa.git``, however the expected URL in + :term:`SRC_URI` is the following:: + + SRC_URI = "git://git@gitlab.freedesktop.org/mesa/mesa.git;protocol=ssh;..." + + Note the ``:`` character changed for a ``/`` before the path to the project. + - *"nocheckout":* Tells the fetcher to not checkout source code when unpacking when set to "1". Set this option for the URL where there is a custom routine to checkout code. The default is "0". @@ -446,6 +459,7 @@ 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" + SRC_URI = "git://git@gitlab.freedesktop.org/mesa/mesa.git;protocol=ssh;..." .. note:: |