From baf9d9c5dbe370ffdba30e55e47e6554eb642cc2 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Fri, 19 Oct 2018 01:38:38 -0400 Subject: [PATCH] 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 --- doc/source/artifacts.rst | 6 +++--- doc/source/cli/cli.rst | 32 ++++++++++++++++---------------- pegleg/engine/repository.py | 12 ++++++------ 3 files changed, 25 insertions(+), 25 deletions(-) diff --git a/doc/source/artifacts.rst b/doc/source/artifacts.rst index 70b77f39..5dc0b6ea 100644 --- a/doc/source/artifacts.rst +++ b/doc/source/artifacts.rst @@ -71,10 +71,10 @@ to meet requirements.:: repositories: # Optional field. global: revision: 47676764d3935e4934624bf9593e9115984fe668 - url: ssh://REPO_USERNAME@gerrit:29418/aic-clcp-manifests.git + url: ssh://REPO_USERNAME@:29418/global-manifests.git secrets: revision: master - url: ssh://REPO_USERNAME@gerrit:29418/aic-clcp-security-manifests.git + url: ssh://REPO_USERNAME@:29418/security-manifests.git The ``repositories`` field (optional) maps default authentication information 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 CLI via :ref:`command-line-repository-overrides`. * port - e.g. 29418 - must be included for ssh only. - * repository name - e.g. aic-clcp-manifests + * repository name Self-Contained Repository ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/source/cli/cli.rst b/doc/source/cli/cli.rst index 5b00d057..ac8a9f1b 100644 --- a/doc/source/cli/cli.rst +++ b/doc/source/cli/cli.rst @@ -181,10 +181,10 @@ Example usage: :: - ./pegleg.sh site -r /opt/aic-clcp-site-manifests/ \ + ./pegleg.sh site -r /opt/site-manifests/ \ -u \ - -k /opt/.ssh/gerrit.pub \ - -e global=ssh://REPO_USERNAME@:29418/aic-clcp-manifests.git@master \ + -k /opt/.ssh/git.pub \ + -e global=ssh://REPO_USERNAME@:29418/global-manifests.git@master \ Collect @@ -230,16 +230,16 @@ Example without validation: :: - ./pegleg.sh site -r /opt/aic-clcp-site-manifests \ - -e global=/opt/aic-clcp-manifests \ + ./pegleg.sh site -r /opt/site-manifests \ + -e global=/opt/manifests \ collect -s /workspace Example with validation: :: - ./pegleg.sh site -r /opt/aic-clcp-site-manifests \ - -e global=/opt/aic-clcp-manifests \ + ./pegleg.sh site -r /opt/site-manifests \ + -e global=/opt/manifests \ collect -s /workspace -x P004 --validate 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 ---- @@ -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 ------ @@ -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: @@ -356,8 +356,8 @@ A more complex example involves excluding certain linting checks: :: - ./pegleg.sh site -r /opt/aic-clcp-site-manifests \ - -e global=/opt/aic-clcp-manifests \ + ./pegleg.sh site -r /opt/site-manifests \ + -e global=/opt/manifests \ lint \ -x P001 -x P002 -w P003 @@ -385,8 +385,8 @@ Where: recommended * url (fully qualified) - must have following formats: - * ssh - ://@:/.git - * http|https - :///.git + * ssh - ://@:/.git + * http|https - :///.git Where: @@ -395,11 +395,11 @@ Where: This value will replace the literal string REPO_USERNAME in the corresponding entry under the ``repositories`` field in the relevant :file:`site-definition.yaml` using ``-u`` CLI flag - * must be a valid Gerrit URL + * must be a valid Git URL * must be a valid authentication port for SSH * must be a valid :ref:`git-reference` * must be a valid Git repository name, - e.g. aic-clcp-site-manifests + e.g. site-manifests .. _self-contained-repo: diff --git a/pegleg/engine/repository.py b/pegleg/engine/repository.py index f60fba97..5ff11f08 100644 --- a/pegleg/engine/repository.py +++ b/pegleg/engine/repository.py @@ -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.: - * ssh://REPO_USERNAME@:29418/aic-clcp-manifests.git@ - * https:///aic-clcp-manifests.git@ - * http:///aic-clcp-manifests.git@ + * ssh://REPO_USERNAME@:29418/global-manifests.git@ + * https:///global-manifests.git@ + * http:///global-manifests.git@ * @ * same values as above without @ @@ -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.: - * ssh://REPO_USERNAME@:29418/aic-clcp-manifests.git@ - * https:///aic-clcp-manifests.git@ - * http:///aic-clcp-manifests.git@ + * ssh://REPO_USERNAME@:29418/global-manifests.git@ + * https:///global-manifests.git@ + * http:///global-manifests.git@ * @ * same values as above without @