Skip to content

Commit 9eb7a73

Browse files
vdyegitster
authored andcommitted
Documentation/technical: include Scalar technical doc
Include 'Documentation/technical/scalar.txt' alongside the other HTML technical docs when installing them. Now that the document is intended as a widely-accessible reference, remove the internal work-in-progress roadmap from the document. Those details should no longer be needed to guide Scalar's development and, if they were left, they could fall out-of-date and be misleading to readers. Signed-off-by: Victoria Dye <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ba1b117 commit 9eb7a73

File tree

2 files changed

+1
-61
lines changed

2 files changed

+1
-61
lines changed

Documentation/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ TECH_DOCS += technical/parallel-checkout
116116
TECH_DOCS += technical/partial-clone
117117
TECH_DOCS += technical/racy-git
118118
TECH_DOCS += technical/reftable
119+
TECH_DOCS += technical/scalar
119120
TECH_DOCS += technical/send-pack-pipeline
120121
TECH_DOCS += technical/shallow
121122
TECH_DOCS += technical/trivial-merge

Documentation/technical/scalar.txt

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -64,64 +64,3 @@ some "global" `git` options (e.g., `-c` and `-C`).
6464
Because `scalar` is not invoked as a Git subcommand (like `git scalar`), it is
6565
built and installed as its own executable in the `bin/` directory, alongside
6666
`git`, `git-gui`, etc.
67-
68-
Roadmap
69-
-------
70-
71-
NOTE: this section will be removed once the remaining tasks outlined in this
72-
roadmap are complete.
73-
74-
Scalar is a large enough project that it is being upstreamed incrementally,
75-
living in `contrib/` until it is feature-complete. So far, the following patch
76-
series have been accepted:
77-
78-
- `scalar-the-beginning`: The initial patch series which sets up
79-
`contrib/scalar/` and populates it with a minimal `scalar` command that
80-
demonstrates the fundamental ideas.
81-
82-
- `scalar-c-and-C`: The `scalar` command learns about two options that can be
83-
specified before the command, `-c <key>=<value>` and `-C <directory>`.
84-
85-
- `scalar-diagnose`: The `scalar` command is taught the `diagnose` subcommand.
86-
87-
- `scalar-generalize-diagnose`: Move the functionality of `scalar diagnose`
88-
into `git diagnose` and `git bugreport --diagnose`.
89-
90-
- 'scalar-add-fsmonitor: Enable the built-in FSMonitor in Scalar
91-
enlistments. At the end of this series, Scalar should be feature-complete
92-
from the perspective of a user.
93-
94-
Roughly speaking (and subject to change), the following series are needed to
95-
"finish" this initial version of Scalar:
96-
97-
- Move Scalar to toplevel: Move Scalar out of `contrib/` and into the root of
98-
`git`. This includes a variety of related updates, including:
99-
- building & installing Scalar in the Git root-level 'make [install]'.
100-
- builing & testing Scalar as part of CI.
101-
- moving and expanding test coverage of Scalar (including perf tests).
102-
- implementing 'scalar help'/'git help scalar' to display scalar
103-
documentation.
104-
105-
Finally, there are two additional patch series that exist in Microsoft's fork of
106-
Git, but there is no current plan to upstream them. There are some interesting
107-
ideas there, but the implementation is too specific to Azure Repos and/or VFS
108-
for Git to be of much help in general.
109-
110-
These still exist mainly because the GVFS protocol is what Azure Repos has
111-
instead of partial clone, while Git is focused on improving partial clone:
112-
113-
- `scalar-with-gvfs`: The primary purpose of this patch series is to support
114-
existing Scalar users whose repositories are hosted in Azure Repos (which does
115-
not support Git's partial clones, but supports its predecessor, the GVFS
116-
protocol, which is used by Scalar to emulate the partial clone).
117-
118-
Since the GVFS protocol will never be supported by core Git, this patch series
119-
will remain in Microsoft's fork of Git.
120-
121-
- `run-scalar-functional-tests`: The Scalar project developed a quite
122-
comprehensive set of integration tests (or, "Functional Tests"). They are the
123-
sole remaining part of the original C#-based Scalar project, and this patch
124-
adds a GitHub workflow that runs them all.
125-
126-
Since the tests partially depend on features that are only provided in the
127-
`scalar-with-gvfs` patch series, this patch cannot be upstreamed.

0 commit comments

Comments
 (0)