Update Git docs to 2.29.2

[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-sparse-checkout.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
\r
<sect2 lang="en" id="git-sparse-checkout(1)">\r
    <title>git-sparse-checkout(1)</title>\r
<indexterm>\r
<primary>git-sparse-checkout(1)</primary>\r
</indexterm>\r
<simplesect id="git-sparse-checkout(1)__name">\r
<title>NAME</title>\r
<simpara>git-sparse-checkout - Initialize and modify the sparse-checkout\r
configuration, which reduces the checkout to a set of paths\r
given by a list of patterns.</simpara>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__synopsis">\r
<title>SYNOPSIS</title>\r
<blockquote>\r
<literallayout><emphasis>git sparse-checkout &lt;subcommand&gt; [options]</emphasis></literallayout>\r
</blockquote>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__description">\r
<title>DESCRIPTION</title>\r
<simpara>Initialize and modify the sparse-checkout configuration, which reduces\r
the checkout to a set of paths given by a list of patterns.</simpara>\r
<simpara>THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR, AND THE BEHAVIOR OF OTHER\r
COMMANDS IN THE PRESENCE OF SPARSE-CHECKOUTS, WILL LIKELY CHANGE IN\r
THE FUTURE.</simpara>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__commands">\r
<title>COMMANDS</title>\r
<variablelist>\r
<varlistentry>\r
<term>\r
<emphasis>list</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        Describe the patterns in the sparse-checkout file.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>init</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        Enable the <emphasis>core.sparseCheckout</emphasis> setting. If the\r
        sparse-checkout file does not exist, then populate it with\r
        patterns that match every file in the root directory and\r
        no other directories, then will remove all directories tracked\r
        by Git. Add patterns to the sparse-checkout file to\r
        repopulate the working directory.\r
</simpara>\r
<simpara>To avoid interfering with other worktrees, it first enables the\r
<emphasis>extensions.worktreeConfig</emphasis> setting and makes sure to set the\r
<emphasis>core.sparseCheckout</emphasis> setting in the worktree-specific config file.</simpara>\r
<simpara>When <emphasis>--cone</emphasis> is provided, the <emphasis>core.sparseCheckoutCone</emphasis> setting is\r
also set, allowing for better performance with a limited set of\r
patterns (see <emphasis>CONE PATTERN SET</emphasis> below).</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>set</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        Write a set of patterns to the sparse-checkout file, as given as\r
        a list of arguments following the <emphasis>set</emphasis> subcommand. Update the\r
        working directory to match the new patterns. Enable the\r
        core.sparseCheckout config setting if it is not already enabled.\r
</simpara>\r
<simpara>When the <emphasis>--stdin</emphasis> option is provided, the patterns are read from\r
standard in as a newline-delimited list instead of from the arguments.</simpara>\r
<simpara>When <emphasis>core.sparseCheckoutCone</emphasis> is enabled, the input list is considered a\r
list of directories instead of sparse-checkout patterns. The command writes\r
patterns to the sparse-checkout file to include all files contained in those\r
directories (recursively) as well as files that are siblings of ancestor\r
directories. The input format matches the output of <emphasis>git ls-tree --name-only</emphasis>.\r
This includes interpreting pathnames that begin with a double quote (") as\r
C-style quoted strings.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>add</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        Update the sparse-checkout file to include additional patterns.\r
        By default, these patterns are read from the command-line arguments,\r
        but they can be read from stdin using the <emphasis>--stdin</emphasis> option. When\r
        <emphasis>core.sparseCheckoutCone</emphasis> is enabled, the given patterns are interpreted\r
        as directory names as in the <emphasis>set</emphasis> subcommand.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>reapply</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        Reapply the sparsity pattern rules to paths in the working tree.\r
        Commands like merge or rebase can materialize paths to do their\r
        work (e.g. in order to show you a conflict), and other\r
        sparse-checkout commands might fail to sparsify an individual file\r
        (e.g. because it has unstaged changes or conflicts).  In such\r
        cases, it can make sense to run <emphasis>git sparse-checkout reapply</emphasis> later\r
        after cleaning up affected paths (e.g. resolving conflicts, undoing\r
        or committing changes, etc.).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>disable</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        Disable the <emphasis>core.sparseCheckout</emphasis> config setting, and restore the\r
        working directory to include all files. Leaves the sparse-checkout\r
        file intact so a later <emphasis>git sparse-checkout init</emphasis> command may\r
        return the working directory to the same state.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__sparse_checkout">\r
<title>SPARSE CHECKOUT</title>\r
<simpara>"Sparse checkout" allows populating the working directory sparsely.\r
It uses the skip-worktree bit (see <xref linkend="git-update-index(1)" />) to tell\r
Git whether a file in the working directory is worth looking at. If\r
the skip-worktree bit is set, then the file is ignored in the working\r
directory. Git will not populate the contents of those files, which\r
makes a sparse checkout helpful when working in a repository with many\r
files, but only a few are important to the current user.</simpara>\r
<simpara>The <emphasis>$GIT_DIR/info/sparse-checkout</emphasis> file is used to define the\r
skip-worktree reference bitmap. When Git updates the working\r
directory, it updates the skip-worktree bits in the index based\r
on this file. The files matching the patterns in the file will\r
appear in the working directory, and the rest will not.</simpara>\r
<simpara>To enable the sparse-checkout feature, run <emphasis>git sparse-checkout init</emphasis> to\r
initialize a simple sparse-checkout file and enable the <emphasis>core.sparseCheckout</emphasis>\r
config setting. Then, run <emphasis>git sparse-checkout set</emphasis> to modify the patterns in\r
the sparse-checkout file.</simpara>\r
<simpara>To repopulate the working directory with all files, use the\r
<emphasis>git sparse-checkout disable</emphasis> command.</simpara>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__full_pattern_set">\r
<title>FULL PATTERN SET</title>\r
<simpara>By default, the sparse-checkout file uses the same syntax as <emphasis>.gitignore</emphasis>\r
files.</simpara>\r
<simpara>While <emphasis>$GIT_DIR/info/sparse-checkout</emphasis> is usually used to specify what\r
files are included, you can also specify what files are <emphasis>not</emphasis> included,\r
using negative patterns. For example, to remove the file <emphasis>unwanted</emphasis>:</simpara>\r
<screen>/*\r
!unwanted</screen>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__cone_pattern_set">\r
<title>CONE PATTERN SET</title>\r
<simpara>The full pattern set allows for arbitrary pattern matches and complicated\r
inclusion/exclusion rules. These can result in O(N*M) pattern matches when\r
updating the index, where N is the number of patterns and M is the number\r
of paths in the index. To combat this performance issue, a more restricted\r
pattern set is allowed when <emphasis>core.sparseCheckoutCone</emphasis> is enabled.</simpara>\r
<simpara>The accepted patterns in the cone pattern set are:</simpara>\r
<orderedlist numeration="arabic">\r
<listitem>\r
<simpara>\r
<emphasis role="strong">Recursive:</emphasis> All paths inside a directory are included.\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis role="strong">Parent:</emphasis> All files immediately inside a directory are included.\r
</simpara>\r
</listitem>\r
</orderedlist>\r
<simpara>In addition to the above two patterns, we also expect that all files in the\r
root directory are included. If a recursive pattern is added, then all\r
leading directories are added as parent patterns.</simpara>\r
<simpara>By default, when running <emphasis>git sparse-checkout init</emphasis>, the root directory is\r
added as a parent pattern. At this point, the sparse-checkout file contains\r
the following patterns:</simpara>\r
<screen>/*\r
!/*/</screen>\r
<simpara>This says "include everything in root, but nothing two levels below root."</simpara>\r
<simpara>When in cone mode, the <emphasis>git sparse-checkout set</emphasis> subcommand takes a list of\r
directories instead of a list of sparse-checkout patterns. In this mode,\r
the command <emphasis>git sparse-checkout set A/B/C</emphasis> sets the directory <emphasis>A/B/C</emphasis> as\r
a recursive pattern, the directories <emphasis>A</emphasis> and <emphasis>A/B</emphasis> are added as parent\r
patterns. The resulting sparse-checkout file is now</simpara>\r
<screen>/*\r
!/*/\r
/A/\r
!/A/*/\r
/A/B/\r
!/A/B/*/\r
/A/B/C/</screen>\r
<simpara>Here, order matters, so the negative patterns are overridden by the positive\r
patterns that appear lower in the file.</simpara>\r
<simpara>If <emphasis>core.sparseCheckoutCone=true</emphasis>, then Git will parse the sparse-checkout file\r
expecting patterns of these types. Git will warn if the patterns do not match.\r
If the patterns do match the expected format, then Git will use faster hash-\r
based algorithms to compute inclusion in the sparse-checkout.</simpara>\r
<simpara>In the cone mode case, the <emphasis>git sparse-checkout list</emphasis> subcommand will list the\r
directories that define the recursive patterns. For the example sparse-checkout\r
file above, the output is as follows:</simpara>\r
<screen>$ git sparse-checkout list\r
A/B/C</screen>\r
<simpara>If <emphasis>core.ignoreCase=true</emphasis>, then the pattern-matching algorithm will use a\r
case-insensitive check. This corrects for case mismatched filenames in the\r
<emphasis>git sparse-checkout set</emphasis> command to reflect the expected cone in the working\r
directory.</simpara>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__submodules">\r
<title>SUBMODULES</title>\r
<simpara>If your repository contains one or more submodules, then submodules\r
are populated based on interactions with the <emphasis>git submodule</emphasis> command.\r
Specifically, <emphasis>git submodule init -- &lt;path&gt;</emphasis> will ensure the submodule\r
at <emphasis>&lt;path&gt;</emphasis> is present, while <emphasis>git submodule deinit [-f] -- &lt;path&gt;</emphasis>\r
will remove the files for the submodule at <emphasis>&lt;path&gt;</emphasis> (including any\r
untracked files, uncommitted changes, and unpushed history).  Similar\r
to how sparse-checkout removes files from the working tree but still\r
leaves entries in the index, deinitialized submodules are removed from\r
the working directory but still have an entry in the index.</simpara>\r
<simpara>Since submodules may have unpushed changes or untracked files,\r
removing them could result in data loss.  Thus, changing sparse\r
inclusion/exclusion rules will not cause an already checked out\r
submodule to be removed from the working copy.  Said another way, just\r
as <emphasis>checkout</emphasis> will not cause submodules to be automatically removed or\r
initialized even when switching between branches that remove or add\r
submodules, using <emphasis>sparse-checkout</emphasis> to reduce or expand the scope of\r
"interesting" files will not cause submodules to be automatically\r
deinitialized or initialized either.</simpara>\r
<simpara>Further, the above facts mean that there are multiple reasons that\r
"tracked" files might not be present in the working copy: sparsity\r
pattern application from sparse-checkout, and submodule initialization\r
state.  Thus, commands like <emphasis>git grep</emphasis> that work on tracked files in\r
the working copy may return results that are limited by either or both\r
of these restrictions.</simpara>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__see_also">\r
<title>SEE ALSO</title>\r
<simpara><xref linkend="git-read-tree(1)" />\r
<xref linkend="gitignore(5)" /></simpara>\r
</simplesect>\r
<simplesect id="git-sparse-checkout(1)__git">\r
<title>GIT</title>\r
<simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
</simplesect>\r
</sect2>\r