summaryrefslogtreecommitdiffstats
path: root/git-sparse-checkout.html
diff options
context:
space:
mode:
Diffstat (limited to 'git-sparse-checkout.html')
-rw-r--r--git-sparse-checkout.html27
1 files changed, 25 insertions, 2 deletions
diff --git a/git-sparse-checkout.html b/git-sparse-checkout.html
index b89b100cf..b6ec84be5 100644
--- a/git-sparse-checkout.html
+++ b/git-sparse-checkout.html
@@ -749,7 +749,7 @@ git-sparse-checkout(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>git sparse-checkout</em> (init | list | set | add | reapply | disable) [&lt;options&gt;]</pre>
+<pre class="content"><em>git sparse-checkout</em> (init | list | set | add | reapply | disable | check-rules) [&lt;options&gt;]</pre>
<div class="attribution">
</div></div>
</div>
@@ -897,6 +897,29 @@ paths to pass to a subsequent <em>set</em> or <em>add</em> command. However,
the disable command, so the easy restore of calling a plain <code>init</code>
decreased in utility.</p></div>
</dd>
+<dt class="hdlist1">
+<em>check-rules</em>
+</dt>
+<dd>
+<p>
+ Check whether sparsity rules match one or more paths.
+</p>
+<div class="paragraph"><p>By default <code>check-rules</code> reads a list of paths from stdin and outputs only
+the ones that match the current sparsity rules. The input is expected to consist
+of one path per line, matching the output of <code>git ls-tree --name-only</code> including
+that pathnames that begin with a double quote (") are interpreted as C-style
+quoted strings.</p></div>
+<div class="paragraph"><p>When called with the <code>--rules-file &lt;file&gt;</code> flag the input files are matched
+against the sparse checkout rules found in <code>&lt;file&gt;</code> instead of the current ones.
+The rules in the files are expected to be in the same form as accepted by <code>git
+sparse-checkout set --stdin</code> (in particular, they must be newline-delimited).</p></div>
+<div class="paragraph"><p>By default, the rules passed to the <code>--rules-file</code> option are interpreted as
+cone mode directories. To pass non-cone mode patterns with <code>--rules-file</code>,
+combine the option with the <code>--no-cone</code> option.</p></div>
+<div class="paragraph"><p>When called with the <code>-z</code> flag, the format of the paths input on stdin as well
+as the output paths are \0 terminated and not quoted. Note that this does not
+apply to the format of the rules passed with the <code>--rules-file</code> option.</p></div>
+</dd>
</dl></div>
</div>
</div>
@@ -1289,7 +1312,7 @@ of these restrictions.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2022-10-28 11:53:56 PDT
+ 2023-04-11 13:51:23 PDT
</div>
</div>
</body>