docs: Rename downstream-specific terms to generic ones
This patch set renames gerrit to git because gerrit is implementation specific throughout the documentation and inline docstrings. It also removes instances of aic-clcp-.* as this, again, is downstream-specific. Change-Id: I7d5c27f959130a8bd05fbc447d22e6609e498696
This commit is contained in:
parent
2ea774a744
commit
baf9d9c5db
|
@ -71,10 +71,10 @@ to meet requirements.::
|
||||||
repositories: # Optional field.
|
repositories: # Optional field.
|
||||||
global:
|
global:
|
||||||
revision: 47676764d3935e4934624bf9593e9115984fe668
|
revision: 47676764d3935e4934624bf9593e9115984fe668
|
||||||
url: ssh://REPO_USERNAME@gerrit:29418/aic-clcp-manifests.git
|
url: ssh://REPO_USERNAME@<git_url>:29418/global-manifests.git
|
||||||
secrets:
|
secrets:
|
||||||
revision: master
|
revision: master
|
||||||
url: ssh://REPO_USERNAME@gerrit:29418/aic-clcp-security-manifests.git
|
url: ssh://REPO_USERNAME@<git_url>:29418/security-manifests.git
|
||||||
|
|
||||||
The ``repositories`` field (optional) maps default authentication information
|
The ``repositories`` field (optional) maps default authentication information
|
||||||
for each of the manifests repositories supported, for example:
|
for each of the manifests repositories supported, for example:
|
||||||
|
@ -94,7 +94,7 @@ Each of the above fields must have 2 pieces of information:
|
||||||
* REPO_USERNAME - must be included for ssh only. Can be overridden with the
|
* REPO_USERNAME - must be included for ssh only. Can be overridden with the
|
||||||
CLI via :ref:`command-line-repository-overrides`.
|
CLI via :ref:`command-line-repository-overrides`.
|
||||||
* port - e.g. 29418 - must be included for ssh only.
|
* port - e.g. 29418 - must be included for ssh only.
|
||||||
* repository name - e.g. aic-clcp-manifests
|
* repository name
|
||||||
|
|
||||||
Self-Contained Repository
|
Self-Contained Repository
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
|
@ -181,10 +181,10 @@ Example usage:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
./pegleg.sh site -r /opt/aic-clcp-site-manifests/ \
|
./pegleg.sh site -r /opt/site-manifests/ \
|
||||||
-u <AUTH_USER> \
|
-u <AUTH_USER> \
|
||||||
-k /opt/.ssh/gerrit.pub \
|
-k /opt/.ssh/git.pub \
|
||||||
-e global=ssh://REPO_USERNAME@<GERRIT URL>:29418/aic-clcp-manifests.git@master \
|
-e global=ssh://REPO_USERNAME@<GIT URL>:29418/global-manifests.git@master \
|
||||||
<command> <options>
|
<command> <options>
|
||||||
|
|
||||||
Collect
|
Collect
|
||||||
|
@ -230,16 +230,16 @@ Example without validation:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
./pegleg.sh site -r /opt/aic-clcp-site-manifests \
|
./pegleg.sh site -r /opt/site-manifests \
|
||||||
-e global=/opt/aic-clcp-manifests \
|
-e global=/opt/manifests \
|
||||||
collect <site_name> -s /workspace
|
collect <site_name> -s /workspace
|
||||||
|
|
||||||
Example with validation:
|
Example with validation:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
./pegleg.sh site -r /opt/aic-clcp-site-manifests \
|
./pegleg.sh site -r /opt/site-manifests \
|
||||||
-e global=/opt/aic-clcp-manifests \
|
-e global=/opt/manifests \
|
||||||
collect <site_name> -s /workspace -x P004 --validate
|
collect <site_name> -s /workspace -x P004 --validate
|
||||||
|
|
||||||
List
|
List
|
||||||
|
@ -264,7 +264,7 @@ Example:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
./pegleg site -r /opt/aic-clcp-site-manifests list -o /workspace
|
./pegleg site -r /opt/site-manifests list -o /workspace
|
||||||
|
|
||||||
Show
|
Show
|
||||||
----
|
----
|
||||||
|
@ -292,7 +292,7 @@ Example:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
./pegleg site -r /opt/aic-clcp-site-manifests show site_name -o /workspace
|
./pegleg site -r /opt/site-manifests show site_name -o /workspace
|
||||||
|
|
||||||
Render
|
Render
|
||||||
------
|
------
|
||||||
|
@ -320,7 +320,7 @@ Example:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
./pegleg site -r /opt/aic-clcp-site-manifests render site_name -o output
|
./pegleg site -r /opt/site-manifests render site_name -o output
|
||||||
|
|
||||||
.. _cli-site-lint:
|
.. _cli-site-lint:
|
||||||
|
|
||||||
|
@ -356,8 +356,8 @@ A more complex example involves excluding certain linting checks:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
./pegleg.sh site -r /opt/aic-clcp-site-manifests \
|
./pegleg.sh site -r /opt/site-manifests \
|
||||||
-e global=/opt/aic-clcp-manifests \
|
-e global=/opt/manifests \
|
||||||
lint <site_name> \
|
lint <site_name> \
|
||||||
-x P001 -x P002 -w P003
|
-x P001 -x P002 -w P003
|
||||||
|
|
||||||
|
@ -385,8 +385,8 @@ Where:
|
||||||
recommended
|
recommended
|
||||||
* url (fully qualified) - must have following formats:
|
* url (fully qualified) - must have following formats:
|
||||||
|
|
||||||
* ssh - <PROTOCOL>://<REPO_USERNAME>@<GERRIT URL>:<PORT>/<REPO_NAME>.git
|
* ssh - <PROTOCOL>://<REPO_USERNAME>@<GIT URL>:<PORT>/<REPO_NAME>.git
|
||||||
* http|https - <PROTOCOL>://<GERRIT URL>/<REPO_NAME>.git
|
* http|https - <PROTOCOL>://<GIT URL>/<REPO_NAME>.git
|
||||||
|
|
||||||
Where:
|
Where:
|
||||||
|
|
||||||
|
@ -395,11 +395,11 @@ Where:
|
||||||
This value will replace the literal string REPO_USERNAME in the
|
This value will replace the literal string REPO_USERNAME in the
|
||||||
corresponding entry under the ``repositories`` field in the relevant
|
corresponding entry under the ``repositories`` field in the relevant
|
||||||
:file:`site-definition.yaml` using ``-u`` CLI flag
|
:file:`site-definition.yaml` using ``-u`` CLI flag
|
||||||
* <GERRIT_URL> must be a valid Gerrit URL
|
* <GIT_URL> must be a valid Git URL
|
||||||
* <PORT> must be a valid authentication port for SSH
|
* <PORT> must be a valid authentication port for SSH
|
||||||
* <REVISION> must be a valid :ref:`git-reference`
|
* <REVISION> must be a valid :ref:`git-reference`
|
||||||
* <REPO_NAME> must be a valid Git repository name,
|
* <REPO_NAME> must be a valid Git repository name,
|
||||||
e.g. aic-clcp-site-manifests
|
e.g. site-manifests
|
||||||
|
|
||||||
.. _self-contained-repo:
|
.. _self-contained-repo:
|
||||||
|
|
||||||
|
|
|
@ -157,9 +157,9 @@ def _process_site_repository(repo_url_or_path, repo_revision):
|
||||||
|
|
||||||
:param repo_url_or_path: Repo URL and associated auth information. E.g.:
|
:param repo_url_or_path: Repo URL and associated auth information. E.g.:
|
||||||
|
|
||||||
* ssh://REPO_USERNAME@<GERRIT_URL>:29418/aic-clcp-manifests.git@<ref>
|
* ssh://REPO_USERNAME@<GIT_URL>:29418/global-manifests.git@<ref>
|
||||||
* https://<GERRIT_URL>/aic-clcp-manifests.git@<ref>
|
* https://<GIT_URL>/global-manifests.git@<ref>
|
||||||
* http://<GERRIT_URL>/aic-clcp-manifests.git@<ref>
|
* http://<GIT_URL>/global-manifests.git@<ref>
|
||||||
* <LOCAL_REPO_PATH>@<ref>
|
* <LOCAL_REPO_PATH>@<ref>
|
||||||
* same values as above without @<ref>
|
* same values as above without @<ref>
|
||||||
|
|
||||||
|
@ -275,9 +275,9 @@ def _extract_repo_url_and_revision(repo_path_or_url):
|
||||||
|
|
||||||
:param repo_path_or_url: Repo URL and associated auth information. E.g.:
|
:param repo_path_or_url: Repo URL and associated auth information. E.g.:
|
||||||
|
|
||||||
* ssh://REPO_USERNAME@<GERRIT_URL>:29418/aic-clcp-manifests.git@<ref>
|
* ssh://REPO_USERNAME@<GIT_URL>:29418/global-manifests.git@<ref>
|
||||||
* https://<GERRIT_URL>/aic-clcp-manifests.git@<ref>
|
* https://<GIT_URL>/global-manifests.git@<ref>
|
||||||
* http://<GERRIT_URL>/aic-clcp-manifests.git@<ref>
|
* http://<GIT_URL>/global-manifests.git@<ref>
|
||||||
* <LOCAL_REPO_PATH>@<ref>
|
* <LOCAL_REPO_PATH>@<ref>
|
||||||
* same values as above without @<ref>
|
* same values as above without @<ref>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue