Re: [PATCH v4 01/17] sparse-checkout: create builtin with 'list' subcommand

From: Elijah Newren <newren@gmail.com>
Date: Oct 16, 2019, 19:00 UTC
Message-ID: <CABPp-BEryfaeYhuUsiDTaYdRKpK6GRi7hgZ5XSTVkoHVkx2qQA@mail.gmail.com>
In-Reply-To: <63626e109767c268ee81b50abd21b95b1f1b5bfb.1571147765.git.gitgitgadget@gmail.com>

On Tue, Oct 15, 2019 at 6:56 AM Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 7 quoted lines

> +DESCRIPTION
> +-----------
> +
> +Initialize and modify the sparse-checkout configuration, which reduces
> +the checkout to a set of directories given by a list of prefixes.
> +
> +THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.

I think the wording needs to be a bit more detailed; you copied the wording from git-switch.txt, but usage of git-switch is not expected to modify the behavior of other commands. sparse-checkout, by contrast, is designed to affect other commands: at the very least checkout & switch, and likely will affect grep, diff, log, and a host of others. Perhaps something like:

THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR, AND THE BEHAVIOR OF OTHER COMMANDS IN THE PRESENCE OF SPARSE-CHECKOUTS, WILL LIKELY CHANGE IN THE FUTURE.