summaryrefslogtreecommitdiff
path: root/contrib/scalar/scalar.txt
diff options
context:
space:
mode:
authorLibravatar Derrick Stolee <dstolee@microsoft.com>2021-12-03 13:34:22 +0000
committerLibravatar Junio C Hamano <gitster@pobox.com>2021-12-04 21:52:23 -0800
commit2b7104573ce237398131562c465d838c018d5880 (patch)
tree6004e44b4fc7df1b732c19df953eedf2e8f2926b /contrib/scalar/scalar.txt
parentscalar: let 'unregister' handle a deleted enlistment directory gracefully (diff)
downloadtgif-2b7104573ce237398131562c465d838c018d5880.tar.xz
scalar: implement 'scalar list'
The produced list simply consists of those repositories registered under the multi-valued `scalar.repo` config setting in the user's Git config. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'contrib/scalar/scalar.txt')
-rw-r--r--contrib/scalar/scalar.txt11
1 files changed, 10 insertions, 1 deletions
diff --git a/contrib/scalar/scalar.txt b/contrib/scalar/scalar.txt
index d9a7998449..f93e3d00ef 100644
--- a/contrib/scalar/scalar.txt
+++ b/contrib/scalar/scalar.txt
@@ -8,6 +8,7 @@ scalar - an opinionated repository management tool
SYNOPSIS
--------
[verse]
+scalar list
scalar register [<enlistment>]
scalar unregister [<enlistment>]
@@ -28,11 +29,19 @@ an existing Git worktree with Scalar whose name is not `src`, the enlistment
will be identical to the worktree.
The `scalar` command implements various subcommands, and different options
-depending on the subcommand.
+depending on the subcommand. With the exception of `list`, all subcommands
+expect to be run in an enlistment.
COMMANDS
--------
+List
+~~~~
+
+list::
+ List enlistments that are currently registered by Scalar. This
+ subcommand does not need to be run inside an enlistment.
+
Register
~~~~~~~~