Skip to content

Commit

Permalink
Add documentation about externals = None feature
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Goldhaber committed Feb 11, 2022
1 parent a3b3a03 commit 9f4be8c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions manic/checkout.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9f4be8c

Please sign in to comment.