diff options
| author | Derrick Stolee <derrickstolee@github.com> | 2023-08-28 13:52:24 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-08-28 09:16:06 -0700 |
| commit | 4527db8ff8c61b173e4c2533b53d34d019a6f061 (patch) | |
| tree | f7e25b3502efb39b575b25a0773a818bd2f0dbb5 /Documentation/scalar.txt | |
| parent | fb7d80edcae482f4fa5d4be0227dc3054734e5f3 (diff) | |
| download | git-4527db8ff8c61b173e4c2533b53d34d019a6f061.tar.gz | |
scalar: add --[no-]src option
Some users have strong aversions to Scalar's opinion that the repository
should be in a 'src' directory, even though this creates a clean slate
for placing build artifacts in adjacent directories.
The new --no-src option allows users to opt out of the default behavior.
While adding options, make sure the usage output by 'scalar clone -h'
reports the same as the SYNOPSIS line in Documentation/scalar.txt.
Signed-off-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/scalar.txt')
| -rw-r--r-- | Documentation/scalar.txt | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/Documentation/scalar.txt b/Documentation/scalar.txt index f33436c7f6..361f51a647 100644 --- a/Documentation/scalar.txt +++ b/Documentation/scalar.txt @@ -8,7 +8,8 @@ scalar - A tool for managing large Git repositories SYNOPSIS -------- [verse] -scalar clone [--single-branch] [--branch <main-branch>] [--full-clone] <url> [<enlistment>] +scalar clone [--single-branch] [--branch <main-branch>] [--full-clone] + [--[no-]src] <url> [<enlistment>] scalar list scalar register [<enlistment>] scalar unregister [<enlistment>] @@ -80,6 +81,11 @@ remote-tracking branch for the branch this option was used for the initial cloning. If the HEAD at the remote did not point at any branch when `--single-branch` clone was made, no remote-tracking branch is created. +--[no-]src:: + By default, `scalar clone` places the cloned repository within a + `<entlistment>/src` directory. Use `--no-src` to place the cloned + repository directly in the `<enlistment>` directory. + --[no-]full-clone:: A sparse-checkout is initialized by default. This behavior can be turned off via `--full-clone`. |