From 9f4be8c7b6c4cf23e151c8d96eb253f1e13049cf Mon Sep 17 00:00:00 2001 From: Steve Goldhaber Date: Fri, 11 Feb 2022 13:14:34 -0700 Subject: [PATCH] Add documentation about externals = None feature --- README.md | 5 +++++ manic/checkout.py | 6 ++++++ 2 files changed, 11 insertions(+) diff --git a/README.md b/README.md index c931c8e213..9475301b5d 100644 --- a/README.md +++ b/README.md @@ -201,6 +201,11 @@ The root of the source tree will be referred to as `${SRC_ROOT}` below. externals description file pointed 'useful_library/sub-xternals.cfg', Then the main 'externals' field in the top level repo should point to 'sub-externals.cfg'. + Note that by default, `checkout_externals` will clone an external's + submodules. As a special case, the entry, `externals = None`, will + prevent this behavior. For more control over which externals are + checked out, create an externals file (and see the `from_submodule` + configuration entry below). * from_submodule (True / False) : used to pull the repo_url, local_path, and hash properties for this external from the .gitmodules file in diff --git a/manic/checkout.py b/manic/checkout.py index 2223b1f0d8..a581f8787c 100755 --- a/manic/checkout.py +++ b/manic/checkout.py @@ -227,6 +227,12 @@ def commandline_arguments(args=None): Now, %(prog)s will process Externals.cfg and also process Externals_LIBX.cfg as if it was a sub-external. + Note that by default, checkout_externals will clone an external's + submodules. As a special case, the entry, "externals = None", will + prevent this behavior. For more control over which externals are + checked out, create an externals file (and see the from_submodule + configuration entry below). + * from_submodule (True / False) : used to pull the repo_url, local_path, and hash properties for this external from the .gitmodules file in this repository. Note that the section name (the entry in square