Re: [edk2-devel] [PATCH 1/1] BaseTools: add repo name option to SetupGit.py

["Philippe Mathieu-Daudé" <philmd@redhat.com>]

On 5/1/20 10:00 PM, Rebecca Cran wrote:
> Allow users who didn't clone one of the TianoCore repos from a
> canonical URL to specify the name of the repo (edk2, edk2-platforms
> or edk2-non-osi) when running SetupGit.py to allow them to configure
> their repo properly.
> 
> The new option is:
> 
>    -n repo, --name repo  set the repo name to configure for, if not
>                          detected automatically
> 
> Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> ---
> Tested with:
>    pylama : no new issues detected
> Option tested:
>    -n : correctly said a parameter was needed
>    -n edk2 : configured the repo for edk2
>    -n edk2-foo : errored out with a list of repo names
>    -n edk2-platforms : updated the configuration for edk2-platforms
> 
> Note the error block in __main__ if the upstream isn't found is
> redundant, since it already errors out and exits in get_upstream.
> 
>   BaseTools/Scripts/SetupGit.py | 12 +++++++++---
>   1 file changed, 9 insertions(+), 3 deletions(-)
> 
> diff --git a/BaseTools/Scripts/SetupGit.py b/BaseTools/Scripts/SetupGit.py
> index e320ba2f887e..4416111ac0a5 100644
> --- a/BaseTools/Scripts/SetupGit.py
> +++ b/BaseTools/Scripts/SetupGit.py
> @@ -106,10 +106,11 @@ def fuzzy_match_repo_url(one, other):
>       return False
>   
>   
> -def get_upstream(url):
> +def get_upstream(url, name):
>       """Extracts the dict for the current repo origin."""
>       for upstream in UPSTREAMS:
> -        if fuzzy_match_repo_url(upstream['repo'], url):
> +        if (fuzzy_match_repo_url(upstream['repo'], url) or
> +                upstream['name'] == name):
>               return upstream
>       print("Unknown upstream '%s' - aborting!" % url)
>       sys.exit(3)
> @@ -143,6 +144,11 @@ if __name__ == '__main__':
>                           help='overwrite existing settings conflicting with program defaults',
>                           action='store_true',
>                           required=False)
> +    PARSER.add_argument('-n', '--name', type=str, metavar='repo',
> +                        choices=['edk2', 'edk2-platforms', 'edk2-non-osi'],

Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>

> +                        help='set the repo name to configure for, if not '
> +                             'detected automatically',
> +                        required=False)
>       PARSER.add_argument('-v', '--verbose',
>                           help='enable more detailed output',
>                           action='store_true',
> @@ -156,7 +162,7 @@ if __name__ == '__main__':
>   
>       URL = REPO.remotes.origin.url
>   
> -    UPSTREAM = get_upstream(URL)
> +    UPSTREAM = get_upstream(URL, ARGS.name)
>       if not UPSTREAM:
>           print("Upstream '%s' unknown, aborting!" % URL)
>           sys.exit(7)
>