This series completes the initial implementation of the Scalar command as a
core component of Git. For readers new to the topic of Scalar, the
roadmap/design doc [1] provides some background information including how
the project started & evolved, as well as its current intent & high-level
design.
Goals
=====
The goal of this series is, as noted in the roadmap linked earlier, to
integrate Scalar as a core user-facing component of Git. There's no
individual existing precedent that the integration is 100% based on; it's
more of an amalgam of the approaches used with builtins installed directly
to the bindir (e.g. 'git-upload-pack'), contributed tools (e.g. 'gitk'), and
the 'git' executable itself. The resulting behavior is:
* Scalar is built & installed unconditionally (like a builtin).
* Scalar is included in 'bin-wrappers/' and is installed into the 'bin/'
directory (like 'git-upload-pack').
* Scalar's documentation is installed as 'man1' docs (like 'gitk').
* Scalar is not invoked via the 'git' executable (it's called directly,
like 'git' itself).
The move out of 'contrib/' is also intended to mean that the relationship
between Git and Scalar should no longer be a strict one-way dependency. In
this series, this architectural change is what permits making a change to
'help.c' specifically for the sake of Scalar. Future contributions can and
should (where appropriate!) share code between Scalar and non-Scalar parts
of Git.
Organization
============
The series is broken up as follows:
1. Fix a CI-breaking documentation error in 'scalar.txt' (patch 1).
2. Move Scalar code out of 'contrib/' and into core Git, including changes
in build definition(s) to build & install Scalar and its resources
(patch 2).
3. Make 'git help scalar' open the 'scalar' command documentation,
introduce 'scalar help' as an alias. This is done after moving out of
'contrib/' due to it involving Scalar-related changes to the non-Scalar
file 'help.c' (patches 3-4).
4. Expand test coverage, including perf testing (patches 5-6)
5. Add a perf test configuration allowing users to register standard perf
test repos with Scalar (patch 7).
6. Remove the internally-focused Scalar roadmap from
'Documentation/technical/scalar.txt', include it as one of the HTML
technical docs (patch 8).
Prior series
============
* Add 'scalar' command in 'contrib/':
https://lore.kernel.org/git/pull.1005.v10.git.1638538470.gitgitgadget@xxxxxxxxx/
* Introduce 'scalar diagnose':
https://lore.kernel.org/git/pull.1128.v6.git.1653145696.gitgitgadget@xxxxxxxxx/
* Add '-c/-C' compatibility:
https://lore.kernel.org/git/pull.1130.v2.git.1643380317358.gitgitgadget@xxxxxxxxx/
* [DROPPED] Integrate Scalar into CI builds:
https://lore.kernel.org/git/pull.1129.git.1654160735.gitgitgadget@xxxxxxxxx/
* Document Scalar's role in Git & plan remaining work:
https://lore.kernel.org/git/pull.1275.v2.git.1657584367.gitgitgadget@xxxxxxxxx/
* Generalize 'scalar diagnose' into 'git diagnose' builtin & 'git bugreport
--diagnose':
https://lore.kernel.org/git/pull.1310.v4.git.1660335019.gitgitgadget@xxxxxxxxx/
* Add FSMonitor support to Scalar, refactor enlistment search:
https://lore.kernel.org/git/pull.1324.v3.git.1660858853.gitgitgadget@xxxxxxxxx/
Thanks!
* Victoria
[1]
https://lore.kernel.org/git/65eda9755d2a29e222bf7e6cc719921b24377cc6.1657584367.git.gitgitgadget@xxxxxxxxx/
Johannes Schindelin (2):
git help: special-case `scalar`
scalar: implement the `help` subcommand
Victoria Dye (6):
scalar: fix command documentation section header
scalar: include in standard Git build & installation
scalar-clone: add test coverage
t/perf: add Scalar performance tests
t/perf: add 'GIT_PERF_USE_SCALAR' run option
Documentation/technical: include Scalar technical doc
.gitignore | 1 +
Documentation/Makefile | 2 +
{contrib/scalar => Documentation}/scalar.txt | 2 +-
Documentation/technical/scalar.txt | 61 --------
Makefile | 30 ++--
builtin/help.c | 2 +
contrib/buildsystems/CMakeLists.txt | 9 +-
contrib/scalar/.gitignore | 2 -
contrib/scalar/Makefile | 35 -----
contrib/scalar/t/Makefile | 81 -----------
contrib/scalar/scalar.c => scalar.c | 20 +++
t/perf/README | 4 +
t/perf/p9210-scalar.sh | 43 ++++++
t/perf/perf-lib.sh | 13 +-
t/perf/run | 3 +
.../t/t9099-scalar.sh => t/t9210-scalar.sh | 10 +-
t/t9211-scalar-clone.sh | 135 ++++++++++++++++++
17 files changed, 249 insertions(+), 204 deletions(-)
rename {contrib/scalar => Documentation}/scalar.txt (99%)
delete mode 100644 contrib/scalar/.gitignore
delete mode 100644 contrib/scalar/Makefile
delete mode 100644 contrib/scalar/t/Makefile
rename contrib/scalar/scalar.c => scalar.c (98%)
create mode 100755 t/perf/p9210-scalar.sh
rename contrib/scalar/t/t9099-scalar.sh => t/t9210-scalar.sh (96%)
create mode 100755 t/t9211-scalar-clone.sh
base-commit: d42b38dfb5edf1a7fddd9542d722f91038407819
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1341%2Fvdye%2Ffeature%2Fscalar-toplevel-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1341/vdye/feature/scalar-toplevel-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1341
--
gitgitgadget
