Skip to content

Commit 957476c

Browse files
mbolivar-nordicgalak
authored andcommitted
doc: west: add "git." prefix to URL hosts
By request, for clarity. Suggested-by: Carles Cufí <[email protected]> Signed-off-by: Martí Bolívar <[email protected]>
1 parent 9008578 commit 957476c

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/guides/west/manifest.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -105,15 +105,15 @@ example:
105105
# [...]
106106
remotes:
107107
- name: remote1
108-
url-base: https://example.com/base1
108+
url-base: https://git.example.com/base1
109109
- name: remote2
110-
url-base: https://example.com/base2
110+
url-base: https://git.example.com/base2
111111
112112
Above, two remotes are given, with names ``remote1`` and ``remote2``. Their URL
113-
bases are respectively ``https://example.com/base1`` and
114-
``https://example.com/base2``. You can use SSH URL bases as well; for example,
115-
you might use ``[email protected]:base1`` if ``remote1`` supported Git over SSH
116-
as well. Anything acceptable to Git will work.
113+
bases are respectively ``https://git.example.com/base1`` and
114+
``https://git.example.com/base2``. You can use SSH URL bases as well; for
115+
example, you might use ``[email protected]:base1`` if ``remote1`` supported Git
116+
over SSH as well. Anything acceptable to Git will work.
117117

118118
The ``projects`` subsection contains a sequence describing the project
119119
repositories in the west installation. Every project has a unique name. You can
@@ -145,8 +145,8 @@ Here is an example. We'll assume the ``remotes`` given above.
145145
In this manifest:
146146

147147
- ``proj1`` has remote ``remote1``, so its Git fetch URL is
148-
``https://example.com/base1/proj1``. The remote ``url-base`` is appended with
149-
a ``/`` and the project ``name`` to form the URL.
148+
``https://git.example.com/base1/proj1``. The remote ``url-base`` is appended
149+
with a ``/`` and the project ``name`` to form the URL.
150150

151151
Locally, this project will be cloned at path ``extra/project-1`` relative to
152152
the west installation's root directory, since it has an explicit ``path``
@@ -157,7 +157,7 @@ In this manifest:
157157
detached ``HEAD`` when west next updates this project.
158158

159159
- ``proj2`` has a ``remote`` and a ``repo-path``, so its fetch URL is
160-
``https://example.com/base2/my-path``. The ``repo-path`` attribute, if
160+
``https://git.example.com/base2/my-path``. The ``repo-path`` attribute, if
161161
present, overrides the default ``name`` when forming the fetch URL.
162162

163163
Since the project has no ``path`` attribute, its ``name`` is used by
@@ -224,9 +224,9 @@ so far using ``defaults`` is:
224224
225225
remotes:
226226
- name: remote1
227-
url-base: https://example.com/base1
227+
url-base: https://git.example.com/base1
228228
- name: remote2
229-
url-base: https://example.com/base2
229+
url-base: https://git.example.com/base2
230230
231231
projects:
232232
- name: proj1
@@ -245,7 +245,7 @@ manifest repository itself. Its value is a map with the following keys:
245245
- ``path``: Optional. The path to clone the manifest repository into, relative
246246
to the west installation's root directory. If not given, the basename of the
247247
path component in the manifest repository URL will be used by default. For
248-
example, if the URL is ``https://example.com/project-repo``, the manifest
248+
example, if the URL is ``https://git.example.com/project-repo``, the manifest
249249
repository would be cloned to the directory :file:`project-repo`.
250250

251251
- ``west-commands``: Optional. This is analogous to the same key in a

0 commit comments

Comments
 (0)