]> git.ipfire.org Git - thirdparty/git.git/commitdiff
scalar: reword command documentation to clarify purpose
authorVictoria Dye <vdye@github.com>
Tue, 12 Jul 2022 00:06:06 +0000 (00:06 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Jul 2022 18:03:56 +0000 (11:03 -0700)
Rephrase documentation to describe scalar as a "large repo management tool"
rather than an "opinionated management tool". The new description is
intended to more directly reflect the utility of scalar to better guide
users in preparation for scalar being built and installed as part of Git.

Signed-off-by: Victoria Dye <vdye@github.com>
Acked-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
contrib/scalar/scalar.txt

index c0425e065338fd0c55021de85b50362e8ede9727..1a12dc450774c2e1aa8b5142c624b5e7704eb61c 100644 (file)
@@ -3,7 +3,7 @@ scalar(1)
 
 NAME
 ----
-scalar - an opinionated repository management tool
+scalar - A tool for managing large Git repositories
 
 SYNOPSIS
 --------
@@ -20,10 +20,9 @@ scalar delete <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
+Scalar is a repository management tool that optimizes Git for use in large
+repositories. Scalar improves performance by configuring advanced Git settings,
+maintaining repositories in the background, and helping to reduce data sent
 across the network.
 
 An important Scalar concept is the enlistment: this is the top-level directory