michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: west: add "git." prefix to URL hosts

Browse source 
By request, for clarity.

Suggested-by: Carles Cufí <carles.cufi@nordicsemi.no>
Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Martí Bolívar 2019-10-07 13:58:15 -07:00 • committed by Kumar Gala
commit 957476ccae
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
doc/guides/west/manifest.rst
View file

@ -105,15 +105,15 @@ example:
# [...] # [...]
remotes: remotes:
- name: remote1 - name: remote1
url-base: https://example.com/base1 url-base: https://git.example.com/base1
- name: remote2 - name: remote2
url-base: https://example.com/base2 url-base: https://git.example.com/base2
Above, two remotes are given, with names ``remote1`` and ``remote2``. Their URL Above, two remotes are given, with names ``remote1`` and ``remote2``. Their URL
bases are respectively ``https://example.com/base1`` and bases are respectively ``https://git.example.com/base1`` and
``https://example.com/base2``. You can use SSH URL bases as well; for example, ``https://git.example.com/base2``. You can use SSH URL bases as well; for
you might use ``git@example.com:base1`` if ``remote1`` supported Git over SSH example, you might use ``git@example.com:base1`` if ``remote1`` supported Git
as well. Anything acceptable to Git will work. over SSH as well. Anything acceptable to Git will work.
The ``projects`` subsection contains a sequence describing the project The ``projects`` subsection contains a sequence describing the project
repositories in the west installation. Every project has a unique name. You can 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.
In this manifest: In this manifest:
- ``proj1`` has remote ``remote1``, so its Git fetch URL is - ``proj1`` has remote ``remote1``, so its Git fetch URL is
``https://example.com/base1/proj1``. The remote ``url-base`` is appended with ``https://git.example.com/base1/proj1``. The remote ``url-base`` is appended
a ``/`` and the project ``name`` to form the URL. with a ``/`` and the project ``name`` to form the URL.
Locally, this project will be cloned at path ``extra/project-1`` relative to Locally, this project will be cloned at path ``extra/project-1`` relative to
the west installation's root directory, since it has an explicit ``path`` the west installation's root directory, since it has an explicit ``path``
@ -157,7 +157,7 @@ In this manifest:
detached ``HEAD`` when west next updates this project. detached ``HEAD`` when west next updates this project.
- ``proj2`` has a ``remote`` and a ``repo-path``, so its fetch URL is - ``proj2`` has a ``remote`` and a ``repo-path``, so its fetch URL is
``https://example.com/base2/my-path``. The ``repo-path`` attribute, if ``https://git.example.com/base2/my-path``. The ``repo-path`` attribute, if
present, overrides the default ``name`` when forming the fetch URL. present, overrides the default ``name`` when forming the fetch URL.
Since the project has no ``path`` attribute, its ``name`` is used by Since the project has no ``path`` attribute, its ``name`` is used by
@ -224,9 +224,9 @@ so far using ``defaults`` is:
remotes: remotes:
- name: remote1 - name: remote1
url-base: https://example.com/base1 url-base: https://git.example.com/base1
- name: remote2 - name: remote2
url-base: https://example.com/base2 url-base: https://git.example.com/base2
projects: projects:
- name: proj1 - name: proj1
@ -245,7 +245,7 @@ manifest repository itself. Its value is a map with the following keys:
- ``path``: Optional. The path to clone the manifest repository into, relative - ``path``: Optional. The path to clone the manifest repository into, relative
to the west installation's root directory. If not given, the basename of the to the west installation's root directory. If not given, the basename of the
path component in the manifest repository URL will be used by default. For path component in the manifest repository URL will be used by default. For
example, if the URL is ``https://example.com/project-repo``, the manifest example, if the URL is ``https://git.example.com/project-repo``, the manifest
repository would be cloned to the directory :file:`project-repo`. repository would be cloned to the directory :file:`project-repo`.
- ``west-commands``: Optional. This is analogous to the same key in a - ``west-commands``: Optional. This is analogous to the same key in a