mirror of
https://github.com/git/git.git
synced 2024-05-22 01:36:09 +02:00
d0feac4e8c
Let's start implementing the `register` command. With this commit, recommended settings are configured upon `scalar register`, and Git's background maintenance is started. The recommended config settings may very well change in the future. For example, once the built-in FSMonitor is available, we will want to enable it upon `scalar register`. For that reason, we explicitly support running `scalar register` in an already-registered enlistment. Co-authored-by: Victoria Dye <vdye@github.com> 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>
55 lines
1.6 KiB
Plaintext
55 lines
1.6 KiB
Plaintext
scalar(1)
|
|
=========
|
|
|
|
NAME
|
|
----
|
|
scalar - an opinionated repository management tool
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
scalar register [<enlistment>]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Scalar is an opinionated repository management tool. By creating new
|
|
repositories or registering existing repositories with Scalar, your Git
|
|
experience will speed up. Scalar sets advanced Git config settings,
|
|
maintains your repositories in the background, and helps reduce data sent
|
|
across the network.
|
|
|
|
An important Scalar concept is the enlistment: this is the top-level directory
|
|
of the project. It usually contains the subdirectory `src/` which is a Git
|
|
worktree. This encourages the separation between tracked files (inside `src/`)
|
|
and untracked files, such as build artifacts (outside `src/`). When registering
|
|
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.
|
|
|
|
COMMANDS
|
|
--------
|
|
|
|
Register
|
|
~~~~~~~~
|
|
|
|
register [<enlistment>]::
|
|
Adds the enlistment's repository to the list of registered repositories
|
|
and starts background maintenance. If `<enlistment>` is not provided,
|
|
then the enlistment associated with the current working directory is
|
|
registered.
|
|
+
|
|
Note: when this subcommand is called in a worktree that is called `src/`, its
|
|
parent directory is considered to be the Scalar enlistment. If the worktree is
|
|
_not_ called `src/`, it itself will be considered to be the Scalar enlistment.
|
|
|
|
SEE ALSO
|
|
--------
|
|
linkgit:git-maintenance[1].
|
|
|
|
Scalar
|
|
---
|
|
Associated with the linkgit:git[1] suite
|