[PATCH v4 4/4] doc/bitbake-setup: document "uri" property

Corentin Guillevic
2025-12-19T16:13:10Z

The property 'uri' is a simplification of the property 'remotes'. It is
used to provide only one URI.

Signed-off-by: Corentin Guillevic <corentin.guillevic@smile.fr>
---
.../bitbake-user-manual-environment-setup.rst | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
index ec1bdeecd..b3588f27d 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -673,11 +673,7 @@ They contain the following sections:
"sources": {
"bitbake": {
"git-remote": {
- "remotes": {
- "origin": {
- "uri": "https://git.openembedded.org/bitbake"
- }
- },
+ "uri": "https://git.openembedded.org/bitbake",
"branch": "master",
"rev": "master"
},
@@ -716,6 +712,12 @@ They contain the following sections:
- ``branch`` (**required**): the Git branch, used to check that the
specified ``rev`` is indeed on that branch.

+ - ``uri`` (*optional*): a URI that follows the git URI syntax. Can replace the
+ ``remotes`` structure if only one URI is provided. Despite this, ``uri`` and
+ ``remotes`` can still be used together.
+
+ See https://git-scm.com/docs/git-clone#_git_urls for more information.
+
- ``local`` (*optional*): specifies a path on local disk that should be symlinked
to under ``layers/``. This is useful for local development, where some layer
or other component used in a build is managed separately, but should still be
--
2.51.0