[PATCH v2 1/2] scalar: reword command documentation to clarify purpose

From: Victoria Dye via GitGitGadget <gitgitgadget@gmail.com>
Date: Jul 12, 2022, 00:06 UTC
Message-ID: <38c0b4dff90f44687590c3686d664599c712417b.1657584367.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.1275.v2.git.1657584367.gitgitgadget@gmail.com>

From: Victoria Dye <vdye@github.com>

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>
---
 contrib/scalar/scalar.txt | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/contrib/scalar/scalar.txt b/contrib/scalar/scalar.txt
index c0425e06533..1a12dc45077 100644
--- a/contrib/scalar/scalar.txt
+++ b/contrib/scalar/scalar.txt
@@ -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

-- 
gitgitgadget