Re: [PATCH v4 09/10] Documentation: clarify/correct a few sparsity related statements

From: Elijah Newren <newren@gmail.com>
Date: Dec 14, 2021, 07:48 UTC
Message-ID: <CABPp-BFDF2YsUQw7RE=WgupN9i6Q8pRH2M6r1YgP9c6JChTRPA@mail.gmail.com>
In-Reply-To: <84ffc06d-09a7-0180-5460-6e1460b8aaac@gmail.com>

On Mon, Dec 13, 2021 at 11:38 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:

Show 14 quoted lines

>
> On 14/12/21 11.09, Elijah Newren via GitGitGadget wrote:
> >   --sparse::
> > -     Initialize the sparse-checkout file so the working
> > -     directory starts with only the files in the root
> > -     of the repository. The sparse-checkout file can be
> > -     modified to grow the working directory as needed.
> > +     Employ a sparse-checkout, with only files in the toplevel
> > +     directory initially being present.  The
> > +     linkgit:git-sparse-checkout[1] command can be used to grow the
> > +     working directory as needed.
> >
>
> s/toplevel/top-level/

No, the only occurrence of either term in Documentation/glossary.txt (though used incidentally) is 'toplevel' rather than 'top-level', git rev-parse has a --show-toplevel flag with no hyphen between top and level, and the occurrences of 'toplevel' in the codebase from a quick grep outnumber top-level 2 to 1. I'll keep 'toplevel'.

Show 10 quoted lines

> >   It uses the skip-worktree bit (see linkgit:git-update-index[1]) to tell
> >   Git whether a file in the working directory is worth looking at. If
> >   the skip-worktree bit is set, then the file is ignored in the working
> > -directory. Git will not populate the contents of those files, which
> > +directory. Git will avoid populating the contents of those files, which
> >   makes a sparse checkout helpful when working in a repository with many
> >   files, but only a few are important to the current user.
> >
>
> Looks OK.