diff mbox series

[v2,5/5] bitbake-setup: adjust the decription of git-remote properties to correctly describe remotes

Message ID 20251215125127.2660714-5-alex.kanavin@gmail.com
State New
Headers show
Series [v2,1/5] setup-schema/layers.schema.json: correct indentation | expand

Commit Message

Alexander Kanavin Dec. 15, 2025, 12:51 p.m. UTC 
From: Alexander Kanavin <alex@linutronix.de>

Specifically, 'uri' property is not on the top level (for now), but
inside a remote, which itself is in a 'remotes' dictionary.

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
---
 .../bitbake-user-manual-environment-setup.rst                | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

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 35aa43f9b..ec1bdeecd 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -702,8 +702,9 @@  They contain the following sections:
 
       ``git-remote`` entries are specified with the following options:
 
-      -  ``uri`` (**required**): a URI that follows the git URI syntax.
-         See https://git-scm.com/docs/git-clone#_git_urls for more information.
+      -  ``remotes`` (**required**): a dictionary of git remote names, each containing a ``uri`` property
+         with a URI that follows the git URI syntax. See https://git-scm.com/docs/git-clone#_git_urls
+         and https://git-scm.com/docs/git-remote for more information.
 
       -  ``rev`` (**required**): the revision to checkout. Can be the name of the
          branch to checkout on the latest revision of the specified ``branch``.