Re: [PATCH 6/9] git-sparse-checkout.txt: add a new EXAMPLES section

From: Derrick Stolee <derrickstolee@github.com>
Date: Mar 8, 2022, 14:30 UTC
Message-ID: <5c59964a-a3ce-3723-8044-16727d9d3170@github.com>
In-Reply-To: <3265f41bcab7202991da5a7a160a85820fbff0c4.1646725188.git.gitgitgadget@gmail.com>

On 3/8/2022 2:39 AM, Elijah Newren via GitGitGadget wrote:

Show 5 quoted lines

> From: Elijah Newren <newren@gmail.com>
> 
> Since many users like to learn from examples, provide a section in the
> manual with example commands that would be used and a brief explanation
> of what each does.

Examples are great!

Show 10 quoted lines

> +`git sparse-checkout reapply`::
> +
> +	It is possible for commands to update the working tree in a way
> +	that does not respect the selected sparsity directories, either
> +	because of special cases (such as hitting conflicts when
> +	merging/rebasing), or because some commands didn't fully support
> +	sparse checkouts (e.g. the old `recursive` merge backend had
> +	only limited support).  This command reapplies the existing
> +	sparse directory specifications to make the working directory
> +	match.

This focuses on how a Git command might cause extra data, but it doesn't mention how other tools might create ignored files outside of the sparse-checkout and this will clean them up. Do you want to add that, or do you prefer focusing on just Git reasons?

Thanks, -Stolee