summaryrefslogtreecommitdiff
path: root/contrib/scalar/scalar.txt
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/scalar/scalar.txt')
-rw-r--r--contrib/scalar/scalar.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/contrib/scalar/scalar.txt b/contrib/scalar/scalar.txt
index 56f744a..39143b0 100644
--- a/contrib/scalar/scalar.txt
+++ b/contrib/scalar/scalar.txt
@@ -12,6 +12,7 @@ scalar clone [--single-branch] [--branch <main-branch>] [--full-clone] <url> [<e
scalar list
scalar register [<enlistment>]
scalar unregister [<enlistment>]
+scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [<enlistment>]
DESCRIPTION
-----------
@@ -98,6 +99,24 @@ unregister [<enlistment>]::
Remove the specified repository from the list of repositories
registered with Scalar and stop the scheduled background maintenance.
+Run
+~~~
+
+scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [<enlistment>]::
+ Run the given maintenance task (or all tasks, if `all` was specified).
+ Except for `all` and `config`, this subcommand simply hands off to
+ linkgit:git-maintenance[1] (mapping `fetch` to `prefetch` and
+ `pack-files` to `incremental-repack`).
++
+These tasks are run automatically as part of the scheduled maintenance,
+as soon as the repository is registered with Scalar. It should therefore
+not be necessary to run this subcommand manually.
++
+The `config` task is specific to Scalar and configures all those
+opinionated default settings that make Git work more efficiently with
+large repositories. As this task is run as part of `scalar clone`
+automatically, explicit invocations of this task are rarely needed.
+
SEE ALSO
--------
linkgit:git-clone[1], linkgit:git-maintenance[1].