scalar: update technical doc roadmap with FSMonitor support
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>
Victoria Dye committed
Aug 18, 2022 at 21:40 UTC
8e2841890a14496c9ee91e1b0f74dc178848049d
1 file changed
+10
-7
Documentation/technical/scalar.txt
+10
-7
@@ -84,13 +84,13 @@ series have been accepted:
84
85
- `scalar-diagnose`: The `scalar` command is taught the `diagnose` subcommand.
86
87
+- 'scalar-add-fsmonitor: Enable the built-in FSMonitor in Scalar
88
+ enlistments. At the end of this series, Scalar should be feature-complete
89
+ from the perspective of a user.
90
+
91
Roughly speaking (and subject to change), the following series are needed to
92
"finish" this initial version of Scalar:
93
90
-- Finish Scalar features: Enable the built-in FSMonitor in Scalar enlistments
91
- and implement `scalar help`. At the end of this series, Scalar should be
92
- feature-complete from the perspective of a user.
93
-
94
- Generalize features not specific to Scalar: In the spirit of making Scalar
95
configure only what is needed for large repo performance, move common
96
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
98
repository.
99
100
- Move Scalar to toplevel: Move Scalar out of `contrib/` and into the root of
101
- `git`, including updates to build and install it with the rest of Git. This
102
- change will incorporate Scalar into the Git CI and test framework, as well as
103
- expand regression and performance testing to ensure the tool is stable.
101
+ `git`. This includes a variety of related updates, including:
102
+ - building & installing Scalar in the Git root-level 'make [install]'.
103
+ - builing & testing Scalar as part of CI.
104
+ - moving and expanding test coverage of Scalar (including perf tests).
105
+ - implementing 'scalar help'/'git help scalar' to display scalar
106
+ documentation.
107
108
Finally, there are two additional patch series that exist in Microsoft's fork of
109
Git, but there is no current plan to upstream them. There are some interesting