development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-26 19:19:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

scalar: update technical doc roadmap with FSMonitor support

Browse source 
Update the Scalar roadmap to reflect completion of enabling the built-in
FSMonitor in Scalar.

Note that implementation of 'scalar help' was moved to the final set of
changes to move Scalar out of 'contrib/'. This is due to a dependency on
changes to 'git help', as all changes to the main Git tree *exclusively*
implemented to support Scalar are part of that series.

Signed-off-by: Victoria Dye <vdye@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Victoria Dye 2022-08-18 21:40:53 +00:00 committed by Junio C Hamano
parent ec4c23116b
commit 8e2841890a
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
Documentation/technical/scalar.txt
View file

@ -84,13 +84,13 @@ series have been accepted:
- `scalar-diagnose`: The `scalar` command is taught the `diagnose` subcommand.
- 'scalar-add-fsmonitor: Enable the built-in FSMonitor in Scalar
enlistments. At the end of this series, Scalar should be feature-complete
from the perspective of a user.
Roughly speaking (and subject to change), the following series are needed to
"finish" this initial version of Scalar:
- Finish Scalar features: Enable the built-in FSMonitor in Scalar enlistments
and implement `scalar help`. At the end of this series, Scalar should be
feature-complete from the perspective of a user.
- Generalize features not specific to Scalar: In the spirit of making Scalar
configure only what is needed for large repo performance, move common
utilities into other parts of Git. Some of this will be internal-only, but one
@ -98,9 +98,12 @@ Roughly speaking (and subject to change), the following series are needed to
repository.
- Move Scalar to toplevel: Move Scalar out of `contrib/` and into the root of
`git`, including updates to build and install it with the rest of Git. This
change will incorporate Scalar into the Git CI and test framework, as well as
expand regression and performance testing to ensure the tool is stable.
`git`. This includes a variety of related updates, including:
- building & installing Scalar in the Git root-level 'make [install]'.
- builing & testing Scalar as part of CI.
- moving and expanding test coverage of Scalar (including perf tests).
- implementing 'scalar help'/'git help scalar' to display scalar
documentation.
Finally, there are two additional patch series that exist in Microsoft's fork of
Git, but there is no current plan to upstream them. There are some interesting