Autogenerated manpages for v2.36.1-74-g277cf0
[git-manpages.git] / man1 / git-sparse-checkout.1
blob96dada427f6fb4e95fb21badc03b90532146de04
1 '\" t
2 .\"     Title: git-sparse-checkout
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 05/11/2022
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.36.1.74.g277cf0bc36
8 .\"  Language: English
9 .\"
10 .TH "GIT\-SPARSE\-CHECKOU" "1" "05/11/2022" "Git 2\&.36\&.1\&.74\&.g277cf0b" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-sparse-checkout \- Reduce your working tree to a subset of tracked files
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit sparse\-checkout <subcommand> [<options>]\fR
36 .fi
37 .sp
38 .SH "DESCRIPTION"
39 .sp
40 This command is used to create sparse checkouts, which means that it changes the working tree from having all tracked files present, to only have a subset of them\&. It can also switch which subset of files are present, or undo and go back to having all tracked files present in the working copy\&.
41 .sp
42 The subset of files is chosen by providing a list of directories in cone mode (which is recommended), or by providing a list of patterns in non\-cone mode\&.
43 .sp
44 When in a sparse\-checkout, other Git commands behave a bit differently\&. For example, switching branches will not update paths outside the sparse\-checkout directories/patterns, and \fBgit commit \-a\fR will not record paths outside the sparse\-checkout directories/patterns as deleted\&.
45 .sp
46 THIS COMMAND IS EXPERIMENTAL\&. ITS BEHAVIOR, AND THE BEHAVIOR OF OTHER COMMANDS IN THE PRESENCE OF SPARSE\-CHECKOUTS, WILL LIKELY CHANGE IN THE FUTURE\&.
47 .SH "COMMANDS"
48 .PP
49 \fIlist\fR
50 .RS 4
51 Describe the directories or patterns in the sparse\-checkout file\&.
52 .RE
53 .PP
54 \fIset\fR
55 .RS 4
56 Enable the necessary sparse\-checkout config settings (\fBcore\&.sparseCheckout\fR,
57 \fBcore\&.sparseCheckoutCone\fR, and
58 \fBindex\&.sparse\fR) if they are not already set to the desired values, and write a set of patterns to the sparse\-checkout file from the list of arguments following the
59 \fIset\fR
60 subcommand\&. Update the working directory to match the new patterns\&.
61 .sp
62 To ensure that adjusting the sparse\-checkout settings within a worktree does not alter the sparse\-checkout settings in other worktrees, the
63 \fIset\fR
64 subcommand will upgrade your repository config to use worktree\-specific config if not already present\&. The sparsity defined by the arguments to the
65 \fIset\fR
66 subcommand are stored in the worktree\-specific sparse\-checkout file\&. See
67 \fBgit-worktree\fR(1)
68 and the documentation of
69 \fBextensions\&.worktreeConfig\fR
71 \fBgit-config\fR(1)
72 for more details\&.
73 .sp
74 When the
75 \fB\-\-stdin\fR
76 option is provided, the directories or patterns are read from standard in as a newline\-delimited list instead of from the arguments\&.
77 .sp
78 When
79 \fB\-\-cone\fR
80 is passed or
81 \fBcore\&.sparseCheckoutCone\fR
82 is enabled, the input list is considered a list of directories\&. This allows for better performance with a limited set of patterns (see
83 \fICONE PATTERN SET\fR
84 below)\&. The input format matches the output of
85 \fBgit ls\-tree \-\-name\-only\fR\&. This includes interpreting pathnames that begin with a double quote (") as C\-style quoted strings\&. Note that the set command will write patterns to the sparse\-checkout file to include all files contained in those directories (recursively) as well as files that are siblings of ancestor directories\&. This may become the default in the future; \-\-no\-cone can be passed to request non\-cone mode\&.
86 .sp
87 When
88 \fB\-\-no\-cone\fR
89 is passed or
90 \fBcore\&.sparseCheckoutCone\fR
91 is not enabled, the input list is considered a list of patterns\&. This mode is harder to use and less performant, and is thus not recommended\&. See the "Sparse Checkout" section of
92 \fBgit-read-tree\fR(1)
93 and the "Pattern Set" sections below for more details\&.
94 .sp
95 Use the
96 \fB\-\-[no\-]sparse\-index\fR
97 option to use a sparse index (the default is to not use it)\&. A sparse index reduces the size of the index to be more closely aligned with your sparse\-checkout definition\&. This can have significant performance advantages for commands such as
98 \fBgit status\fR
100 \fBgit add\fR\&. This feature is still experimental\&. Some commands might be slower with a sparse index until they are properly integrated with the feature\&.
102 \fBWARNING:\fR
103 Using a sparse index requires modifying the index in a way that is not completely understood by external tools\&. If you have trouble with this compatibility, then run
104 \fBgit sparse\-checkout init \-\-no\-sparse\-index\fR
105 to rewrite your index to not be sparse\&. Older versions of Git will not understand the sparse directory entries index extension and may fail to interact with your repository until it is disabled\&.
108 \fIadd\fR
109 .RS 4
110 Update the sparse\-checkout file to include additional directories (in cone mode) or patterns (in non\-cone mode)\&. By default, these directories or patterns are read from the command\-line arguments, but they can be read from stdin using the
111 \fB\-\-stdin\fR
112 option\&.
115 \fIreapply\fR
116 .RS 4
117 Reapply the sparsity pattern rules to paths in the working tree\&. Commands like merge or rebase can materialize paths to do their work (e\&.g\&. in order to show you a conflict), and other sparse\-checkout commands might fail to sparsify an individual file (e\&.g\&. because it has unstaged changes or conflicts)\&. In such cases, it can make sense to run
118 \fBgit sparse\-checkout reapply\fR
119 later after cleaning up affected paths (e\&.g\&. resolving conflicts, undoing or committing changes, etc\&.)\&.
122 \fBreapply\fR
123 command can also take
124 \fB\-\-[no\-]cone\fR
126 \fB\-\-[no\-]sparse\-index\fR
127 flags, with the same meaning as the flags from the
128 \fBset\fR
129 command, in order to change which sparsity mode you are using without needing to also respecify all sparsity paths\&.
132 \fIdisable\fR
133 .RS 4
134 Disable the
135 \fBcore\&.sparseCheckout\fR
136 config setting, and restore the working directory to include all files\&.
139 \fIinit\fR
140 .RS 4
141 Deprecated command that behaves like
142 \fBset\fR
143 with no specified paths\&. May be removed in the future\&.
145 Historically,
146 \fBset\fR
147 did not handle all the necessary config settings, which meant that both
148 \fBinit\fR
150 \fBset\fR
151 had to be called\&. Invoking both meant the
152 \fBinit\fR
153 step would first remove nearly all tracked files (and in cone mode, ignored files too), then the
154 \fBset\fR
155 step would add many of the tracked files (but not ignored files) back\&. In addition to the lost files, the performance and UI of this combination was poor\&.
157 Also, historically,
158 \fBinit\fR
159 would not actually initialize the sparse\-checkout file if it already existed\&. This meant it was possible to return to a sparse\-checkout without remembering which paths to pass to a subsequent
160 \fIset\fR
162 \fIadd\fR
163 command\&. However,
164 \fB\-\-cone\fR
166 \fB\-\-sparse\-index\fR
167 options would not be remembered across the disable command, so the easy restore of calling a plain
168 \fBinit\fR
169 decreased in utility\&.
171 .SH "SPARSE CHECKOUT"
173 "Sparse checkout" allows populating the working directory sparsely\&. It uses the skip\-worktree bit (see \fBgit-update-index\fR(1)) to tell Git whether a file in the working directory is worth looking at\&. If the skip\-worktree bit is set, and the file is not present in the working tree, then its absence is ignored\&. 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\&.
175 The \fB$GIT_DIR/info/sparse\-checkout\fR file is used to define the skip\-worktree reference bitmap\&. When Git updates the working directory, it updates the skip\-worktree bits in the index based on this file\&. The files matching the patterns in the file will appear in the working directory, and the rest will not\&.
177 To enable the sparse\-checkout feature, run \fBgit sparse\-checkout set\fR to set the patterns you want to use\&.
179 To repopulate the working directory with all files, use the \fBgit sparse\-checkout disable\fR command\&.
180 .SH "FULL PATTERN SET"
182 By default, the sparse\-checkout file uses the same syntax as \fB\&.gitignore\fR files\&.
184 While \fB$GIT_DIR/info/sparse\-checkout\fR is usually used to specify what files are included, you can also specify what files are \fInot\fR included, using negative patterns\&. For example, to remove the file \fBunwanted\fR:
186 .if n \{\
187 .RS 4
191 !unwanted
193 .if n \{\
197 .SH "CONE PATTERN SET"
199 The full pattern set allows for arbitrary pattern matches and complicated inclusion/exclusion rules\&. These can result in O(N*M) pattern matches when updating the index, where N is the number of patterns and M is the number of paths in the index\&. To combat this performance issue, a more restricted pattern set is allowed when \fBcore\&.sparseCheckoutCone\fR is enabled\&.
201 The accepted patterns in the cone pattern set are:
203 .RS 4
204 .ie n \{\
205 \h'-04' 1.\h'+01'\c
207 .el \{\
208 .sp -1
209 .IP "  1." 4.2
211 \fBRecursive:\fR
212 All paths inside a directory are included\&.
215 .RS 4
216 .ie n \{\
217 \h'-04' 2.\h'+01'\c
219 .el \{\
220 .sp -1
221 .IP "  2." 4.2
223 \fBParent:\fR
224 All files immediately inside a directory are included\&.
227 In addition to the above two patterns, we also expect that all files in the root directory are included\&. If a recursive pattern is added, then all leading directories are added as parent patterns\&.
229 By default, when running \fBgit sparse\-checkout init\fR, the root directory is added as a parent pattern\&. At this point, the sparse\-checkout file contains the following patterns:
231 .if n \{\
232 .RS 4
236 !/*/
238 .if n \{\
243 This says "include everything in root, but nothing two levels below root\&."
245 When in cone mode, the \fBgit sparse\-checkout set\fR subcommand takes a list of directories instead of a list of sparse\-checkout patterns\&. In this mode, the command \fBgit sparse\-checkout set A/B/C\fR sets the directory \fBA/B/C\fR as a recursive pattern, the directories \fBA\fR and \fBA/B\fR are added as parent patterns\&. The resulting sparse\-checkout file is now
247 .if n \{\
248 .RS 4
252 !/*/
254 !/A/*/
255 /A/B/
256 !/A/B/*/
257 /A/B/C/
259 .if n \{\
264 Here, order matters, so the negative patterns are overridden by the positive patterns that appear lower in the file\&.
266 If \fBcore\&.sparseCheckoutCone=true\fR, then Git will parse the sparse\-checkout file expecting patterns of these types\&. Git will warn if the patterns do not match\&. If the patterns do match the expected format, then Git will use faster hash\- based algorithms to compute inclusion in the sparse\-checkout\&.
268 In the cone mode case, the \fBgit sparse\-checkout list\fR subcommand will list the directories that define the recursive patterns\&. For the example sparse\-checkout file above, the output is as follows:
270 .if n \{\
271 .RS 4
274 $ git sparse\-checkout list
275 A/B/C
277 .if n \{\
282 If \fBcore\&.ignoreCase=true\fR, then the pattern\-matching algorithm will use a case\-insensitive check\&. This corrects for case mismatched filenames in the \fIgit sparse\-checkout set\fR command to reflect the expected cone in the working directory\&.
284 When changing the sparse\-checkout patterns in cone mode, Git will inspect each tracked directory that is not within the sparse\-checkout cone to see if it contains any untracked files\&. If all of those files are ignored due to the \fB\&.gitignore\fR patterns, then the directory will be deleted\&. If any of the untracked files within that directory is not ignored, then no deletions will occur within that directory and a warning message will appear\&. If these files are important, then reset your sparse\-checkout definition so they are included, use \fBgit add\fR and \fBgit commit\fR to store them, then remove any remaining files manually to ensure Git can behave optimally\&.
285 .SH "SUBMODULES"
287 If your repository contains one or more submodules, then submodules are populated based on interactions with the \fBgit submodule\fR command\&. Specifically, \fBgit submodule init \-\- <path>\fR will ensure the submodule at \fB<path>\fR is present, while \fBgit submodule deinit [\-f] \-\- <path>\fR will remove the files for the submodule at \fB<path>\fR (including any untracked files, uncommitted changes, and unpushed history)\&. Similar to how sparse\-checkout removes files from the working tree but still leaves entries in the index, deinitialized submodules are removed from the working directory but still have an entry in the index\&.
289 Since submodules may have unpushed changes or untracked files, removing them could result in data loss\&. Thus, changing sparse inclusion/exclusion rules will not cause an already checked out submodule to be removed from the working copy\&. Said another way, just as \fBcheckout\fR will not cause submodules to be automatically removed or initialized even when switching between branches that remove or add submodules, using \fBsparse\-checkout\fR to reduce or expand the scope of "interesting" files will not cause submodules to be automatically deinitialized or initialized either\&.
291 Further, the above facts mean that there are multiple reasons that "tracked" files might not be present in the working copy: sparsity pattern application from sparse\-checkout, and submodule initialization state\&. Thus, commands like \fBgit grep\fR that work on tracked files in the working copy may return results that are limited by either or both of these restrictions\&.
292 .SH "SEE ALSO"
294 \fBgit-read-tree\fR(1) \fBgitignore\fR(5)
295 .SH "GIT"
297 Part of the \fBgit\fR(1) suite