git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 0/2] [RFC] scalar: prepare documentation for future work

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Jun 29, 2022, 21:50 UTC
Message-ID
<50rqn1oo-p1p8-r3r5-4p21-o7os0non8spo@tzk.qr>
In-Reply-To
<pull.1275.git.1656521925.gitgitgadget@gmail.com>
Hi Victoria,
thank you for an excellent example of a well-crafted cover letter.

Also, thank you for your fresh perspective, I believe you raised a valid point when you pointed out that there are better ways to describe Scalar's intention than the term "opinionated".

On Wed, 29 Jun 2022, Victoria Dye via GitGitGadget wrote:
Show 28 quoted lines
> A plan for Scalar
> =================
>
> Given the slightly tweaked "philosophy" above, my ultimate goal for Scalar
> is to have it contain only what is too experimental or too large
> repo-focused to be a default option or behavior in Git. Over time, some
> features may be moved out of Scalar and into Git defaults as they are proven
> stable and beneficial to the vast majority of users [4].
>
> So what do we need to get there?
>
> At a high level, the remaining work to "finalize" Scalar (past this RFC) can
> be broken into three parts:
>
>  1. Complete a few more features and subcommands of Scalar (integrate with
>     the built-in FSMonitor & implement scalar help).
>  2. Move stable, general-purpose parts of 'scalar.c' into other Git
>     builtins/libraries (mainly scalar diagnose, either as part of git
>     bug-report [5] or a new git built-in).
>  3. Move Scalar out of contrib/ and into the "top-level" of Git. Includes
>     expanded testing, especially performance testing.
>
> The first makes scalar "feature complete" enough to be valuable to large
> repo users (per my entirely subjective assessment, at least). The second
> brings it in line with the goal of making Scalar only contain what can't
> exist as a default feature of Git. Once those are finished, I think Scalar
> will be out of its "work-in-progress" phase and ready to use as a built-in
> component of Git (accompanied by sufficient testing, of course).
This plan makes a ton of sense to me.

Earlier, I tried to skip step 2, but you are absolutely correct that it would benefit the Git project much more if it wasn't skipped.

Thank you for working on this! Dscho

Previous: Derrick StoleeNext: Victoria Dye via GitGitGadget
Message 8 of 12 in “[RFC] scalar: prepare documentation for future work”
  1. 0/2 [RFC] scalar: prepare documentation for future workVictoria Dye via GitGitGadget, Jun 29, 2022
  2. 1/2 scalar: reword command documentation to clarify purposeVictoria Dye via GitGitGadget, Jun 29, 2022
  3. 2/2 scalar: convert README.md into a technical design docVictoria Dye via GitGitGadget, Jun 29, 2022
  4. Derrick StoleeJun 29, 2022
  5. Victoria DyeJul 11, 2022
  6. Derrick StoleeJul 15, 2022
  7. Derrick StoleeJun 29, 2022
  8. Johannes SchindelinJun 29, 2022
  9. 0/2 scalar: prepare documentation for future workVictoria Dye via GitGitGadget, Jul 12, 2022
  10. 1/2 scalar: reword command documentation to clarify purposeVictoria Dye via GitGitGadget, Jul 12, 2022
  11. 2/2 scalar: convert README.md into a technical design docVictoria Dye via GitGitGadget, Jul 12, 2022
  12. Derrick StoleeJul 15, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.