Autogenerated HTML docs for v2.39.0-95-g7c2ef

19 files changed, 183 insertions, 17 deletions

diff --git a/RelNotes/2.40.0.txt b/RelNotes/2.40.0.txt
index 669a03518..73a7cdb0b 100644
--- a/RelNotes/2.40.0.txt
+++ b/RelNotes/2.40.0.txt
@@ -14,6 +14,11 @@ UI, Workflows & Features
    just gives an empty output, while the former still gives an error
    message.
 
+ * Introduce a case insensitive mode to the Bash completion helpers.
+
+ * The advice message given by "git status" when it takes long time to
+   enumerate untracked paths has been updated.
+
 
 Performance, Internal Implementation, Development Support etc.
 
@@ -34,4 +39,31 @@ Fixes since v2.39
    arguments when invoked directly.
    (merge d4f7036887 rs/multi-filter-args later to maint).
 
+ * Make fsmonitor more robust to avoid the flakiness seen in t7527.
+   (merge 6692d45477 jh/t7527-unflake-by-forcing-cookie later to maint).
+
+ * Stop using deprecated macOS API in fsmonitor.
+   (merge b0226007f0 jh/fsmonitor-darwin-modernize later to maint).
+
+ * Redefining system functions for a few functions did not follow our
+   usual "implement git_foo() and #define foo(args) git_foo(args)"
+   pattern, which has broken build for some folks.
+   (merge e1a95b78d8 jk/avoid-redef-system-functions-2.30 later to maint).
+   (merge 395bec6b39 jk/avoid-redef-system-functions later to maint).
+
+ * The way the diff machinery prepares the options array for the
+   parse_options API has been refactored to avoid resource leaks.
+   (merge 189e97bc4b rs/diff-parseopts later to maint).
+
+ * Correct pthread API usage.
+   (merge 786e67611d sx/pthread-error-check-fix later to maint).
+
  * Other code cleanup, docfix, build fix, etc.
+   (merge 77e04b2ed4 rs/t4205-do-not-exit-in-test-script later to maint).
+   (merge faebba436e rs/plug-pattern-list-leak-in-lof later to maint).
+   (merge 243caa8982 ab/t5314-avoid-losing-exit-status later to maint).
+   (merge 4d81ce1b99 ab/t7600-avoid-losing-exit-status-of-git later to maint).
+   (merge 5f3bfdc4f3 ab/t4023-avoid-losing-exit-status-of-diff later to maint).
+   (merge 500317ae03 js/t3920-shell-and-or-fix later to maint).
+   (merge 86325d36e6 rs/t3920-crlf-eating-grep-fix later to maint).
+   (merge cfbd173ccb rj/branch-copy-and-rename later to maint).
diff --git a/git-status.html b/git-status.html
index 3804e58e9..ee69e21ce 100644
--- a/git-status.html
+++ b/git-status.html
@@ -1361,6 +1361,80 @@ using <code>git --no-optional-locks status</code> (see <a href="git.html">git(1)
 </div>

 </div>

 <div class="sect1">

+<h2 id="_untracked_files_and_performance">UNTRACKED FILES AND PERFORMANCE</h2>

+<div class="sectionbody">

+<div class="paragraph"><p><code>git status</code> can be very slow in large worktrees if/when it

+needs to search for untracked files and directories. There are

+many configuration options available to speed this up by either

+avoiding the work or making use of cached results from previous

+Git commands. There is no single optimum set of settings right

+for everyone. We&#8217;ll list a summary of the relevant options to help

+you, but before going into the list, you may want to run <code>git status</code>

+again, because your configuration may already be caching <code>git status</code>

+results, so it could be faster on subsequent runs.</p></div>

+<div class="ulist"><ul>

+<li>

+<p>

+The <code>--untracked-files=no</code> flag or the

+        <code>status.showUntrackedfiles=false</code> config (see above for both):

+        indicate that <code>git status</code> should not report untracked

+        files. This is the fastest option. <code>git status</code> will not list

+        the untracked files, so you need to be careful to remember if

+        you create any new files and manually <code>git add</code> them.

+</p>

+</li>

+<li>

+<p>

+<code>advice.statusUoption=false</code> (see <a href="git-config.html">git-config(1)</a>):

+        setting this variable to <code>false</code> disables the warning message

+        given when enumerating untracked files takes more than 2

+        seconds.  In a large project, it may take longer and the user

+        may have already accepted the trade off (e.g. using "-uno" may

+        not be an acceptable option for the user), in which case, there

+        is no point issuing the warning message, and in such a case,

+        disabling the warning may be the best.

+</p>

+</li>

+<li>

+<p>

+<code>core.untrackedCache=true</code> (see <a href="git-update-index.html">git-update-index(1)</a>):

+        enable the untracked cache feature and only search directories

+        that have been modified since the previous <code>git status</code> command.

+        Git remembers the set of untracked files within each directory

+        and assumes that if a directory has not been modified, then

+        the set of untracked files within has not changed.  This is much

+        faster than enumerating the contents of every directory, but still

+        not without cost, because Git still has to search for the set of

+        modified directories. The untracked cache is stored in the

+        <code>.git/index</code> file. The reduced cost of searching for untracked

+        files is offset slightly by the increased size of the index and

+        the cost of keeping it up-to-date. That reduced search time is

+        usually worth the additional size.

+</p>

+</li>

+<li>

+<p>

+<code>core.untrackedCache=true</code> and <code>core.fsmonitor=true</code> or

+        <code>core.fsmonitor=&lt;hook_command_pathname&gt;</code> (see

+        <a href="git-update-index.html">git-update-index(1)</a>): enable both the untracked cache

+        and FSMonitor features and only search directories that have

+        been modified since the previous <code>git status</code> command.  This

+        is faster than using just the untracked cache alone because

+        Git can also avoid searching for modified directories.  Git

+        only has to enumerate the exact set of directories that have

+        changed recently. While the FSMonitor feature can be enabled

+        without the untracked cache, the benefits are greatly reduced

+        in that case.

+</p>

+</li>

+</ul></div>

+<div class="paragraph"><p>Note that after you turn on the untracked cache and/or FSMonitor

+features it may take a few <code>git status</code> commands for the various

+caches to warm up before you see improved command times.  This is

+normal.</p></div>

+</div>

+</div>

+<div class="sect1">

 <h2 id="_see_also">SEE ALSO</h2>

 <div class="sectionbody">

 <div class="paragraph"><p><a href="gitignore.html">gitignore(5)</a></p></div>

@@ -1377,7 +1451,7 @@ using <code>git --no-optional-locks status</code> (see <a href="git.html">git(1)
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-10-29 03:53:56 JST

+ 2022-12-19 12:03:12 JST

 </div>

 </div>

 </body>

diff --git a/git-status.txt b/git-status.txt
index 5e438a7fd..a051b1e8f 100644
--- a/git-status.txt
+++ b/git-status.txt
@@ -457,6 +457,66 @@ during the write may conflict with other simultaneous processes, causing
 them to fail. Scripts running `status` in the background should consider
 using `git --no-optional-locks status` (see linkgit:git[1] for details).
 
+UNTRACKED FILES AND PERFORMANCE
+-------------------------------
+
+`git status` can be very slow in large worktrees if/when it
+needs to search for untracked files and directories. There are
+many configuration options available to speed this up by either
+avoiding the work or making use of cached results from previous
+Git commands. There is no single optimum set of settings right
+for everyone. We'll list a summary of the relevant options to help
+you, but before going into the list, you may want to run `git status`
+again, because your configuration may already be caching `git status`
+results, so it could be faster on subsequent runs.
+
+* The `--untracked-files=no` flag or the
+	`status.showUntrackedfiles=false` config (see above for both):
+	indicate that `git status` should not report untracked
+	files. This is the fastest option. `git status` will not list
+	the untracked files, so you need to be careful to remember if
+	you create any new files and manually `git add` them.
+
+* `advice.statusUoption=false` (see linkgit:git-config[1]):
+	setting this variable to `false` disables the warning message
+	given when enumerating untracked files takes more than 2
+	seconds.  In a large project, it may take longer and the user
+	may have already accepted the trade off (e.g. using "-uno" may
+	not be an acceptable option for the user), in which case, there
+	is no point issuing the warning message, and in such a case,
+	disabling the warning may be the best.
+
+* `core.untrackedCache=true` (see linkgit:git-update-index[1]):
+	enable the untracked cache feature and only search directories
+	that have been modified since the previous `git status` command.
+	Git remembers the set of untracked files within each directory
+	and assumes that if a directory has not been modified, then
+	the set of untracked files within has not changed.  This is much
+	faster than enumerating the contents of every directory, but still
+	not without cost, because Git still has to search for the set of
+	modified directories. The untracked cache is stored in the
+	`.git/index` file. The reduced cost of searching for untracked
+	files is offset slightly by the increased size of the index and
+	the cost of keeping it up-to-date. That reduced search time is
+	usually worth the additional size.
+
+* `core.untrackedCache=true` and `core.fsmonitor=true` or
+	`core.fsmonitor=<hook_command_pathname>` (see
+	linkgit:git-update-index[1]): enable both the untracked cache
+	and FSMonitor features and only search directories that have
+	been modified since the previous `git status` command.  This
+	is faster than using just the untracked cache alone because
+	Git can also avoid searching for modified directories.  Git
+	only has to enumerate the exact set of directories that have
+	changed recently. While the FSMonitor feature can be enabled
+	without the untracked cache, the benefits are greatly reduced
+	in that case.
+
+Note that after you turn on the untracked cache and/or FSMonitor
+features it may take a few `git status` commands for the various
+caches to warm up before you see improved command times.  This is
+normal.
+
 SEE ALSO
 --------
 linkgit:gitignore[5]
diff --git a/howto/coordinate-embargoed-releases.html b/howto/coordinate-embargoed-releases.html
index a6e08fac6..9d621c3b9 100644
--- a/howto/coordinate-embargoed-releases.html
+++ b/howto/coordinate-embargoed-releases.html
@@ -1038,7 +1038,7 @@ Thanks,
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:19 JST

+ 2022-12-19 12:03:46 JST

 </div>

 </div>

 </body>

diff --git a/howto/keep-canonical-history-correct.html b/howto/keep-canonical-history-correct.html
index d7555eb30..b38ca68ba 100644
--- a/howto/keep-canonical-history-correct.html
+++ b/howto/keep-canonical-history-correct.html
@@ -938,7 +938,7 @@ tip of your <em>master</em> again and redo the two merges:</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:19 JST

+ 2022-12-19 12:03:46 JST

 </div>

 </div>

 </body>

diff --git a/howto/maintain-git.html b/howto/maintain-git.html
index 42b715b88..9d378e8c8 100644
--- a/howto/maintain-git.html
+++ b/howto/maintain-git.html
@@ -1478,7 +1478,7 @@ $ git update-ref -d $mf/ai/topic</code></pre>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:19 JST

+ 2022-12-19 12:03:46 JST

 </div>

 </div>

 </body>

diff --git a/howto/new-command.html b/howto/new-command.html
index 50206bca0..d54bb2521 100644
--- a/howto/new-command.html
+++ b/howto/new-command.html
@@ -863,7 +863,7 @@ letter [PATCH 0/n].
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:17 JST

+ 2022-12-19 12:03:44 JST

 </div>

 </div>

 </body>

diff --git a/howto/rebase-from-internal-branch.html b/howto/rebase-from-internal-branch.html
index cc8a0c659..7b424abf2 100644
--- a/howto/rebase-from-internal-branch.html
+++ b/howto/rebase-from-internal-branch.html
@@ -895,7 +895,7 @@ the #1' commit.</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:19 JST

+ 2022-12-19 12:03:46 JST

 </div>

 </div>

 </body>

diff --git a/howto/rebuild-from-update-hook.html b/howto/rebuild-from-update-hook.html
index 189a75add..d7704e9b0 100644
--- a/howto/rebuild-from-update-hook.html
+++ b/howto/rebuild-from-update-hook.html
@@ -847,7 +847,7 @@ This is still crude and does not protect against simultaneous
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:19 JST

+ 2022-12-19 12:03:46 JST

 </div>

 </div>

 </body>

diff --git a/howto/recover-corrupted-blob-object.html b/howto/recover-corrupted-blob-object.html
index 606d9b515..81725f8e9 100644
--- a/howto/recover-corrupted-blob-object.html
+++ b/howto/recover-corrupted-blob-object.html
@@ -880,7 +880,7 @@ thing.</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:19 JST

+ 2022-12-19 12:03:46 JST

 </div>

 </div>

 </body>

diff --git a/howto/recover-corrupted-object-harder.html b/howto/recover-corrupted-object-harder.html
index c1fba2579..741639d12 100644
--- a/howto/recover-corrupted-object-harder.html
+++ b/howto/recover-corrupted-object-harder.html
@@ -1189,7 +1189,7 @@ int main(int argc, char **argv)
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:19 JST

+ 2022-12-19 12:03:46 JST

 </div>

 </div>

 </body>

diff --git a/howto/revert-a-faulty-merge.html b/howto/revert-a-faulty-merge.html
index 5a42f9f49..27f971b01 100644
--- a/howto/revert-a-faulty-merge.html
+++ b/howto/revert-a-faulty-merge.html
@@ -1025,7 +1025,7 @@ P---o---o---M---x---x---W---x---M2
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:19 JST

+ 2022-12-19 12:03:45 JST

 </div>

 </div>

 </body>

diff --git a/howto/revert-branch-rebase.html b/howto/revert-branch-rebase.html
index bc5ea189b..8ce21114b 100644
--- a/howto/revert-branch-rebase.html
+++ b/howto/revert-branch-rebase.html
@@ -907,7 +907,7 @@ Committed merge 7fb9b7262a1d1e0a47bbfdcbbcf50ce0635d3f8f
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:17 JST

+ 2022-12-19 12:03:44 JST

 </div>

 </div>

 </body>

diff --git a/howto/separating-topic-branches.html b/howto/separating-topic-branches.html
index e95981993..983515180 100644
--- a/howto/separating-topic-branches.html
+++ b/howto/separating-topic-branches.html
@@ -841,7 +841,7 @@ o---o"master"</code></pre>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:18 JST

+ 2022-12-19 12:03:45 JST

 </div>

 </div>

 </body>

diff --git a/howto/setup-git-server-over-http.html b/howto/setup-git-server-over-http.html
index 079f419ea..7518f3e22 100644
--- a/howto/setup-git-server-over-http.html
+++ b/howto/setup-git-server-over-http.html
@@ -1071,7 +1071,7 @@ help diagnosing the problem, but removes security checks.</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:18 JST

+ 2022-12-19 12:03:45 JST

 </div>

 </div>

 </body>

diff --git a/howto/update-hook-example.html b/howto/update-hook-example.html
index d041d166c..d02e7624c 100644
--- a/howto/update-hook-example.html
+++ b/howto/update-hook-example.html
@@ -930,7 +930,7 @@ that JC can make non-fast-forward pushes on it.</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:18 JST

+ 2022-12-19 12:03:45 JST

 </div>

 </div>

 </body>

diff --git a/howto/use-git-daemon.html b/howto/use-git-daemon.html
index b3fbfe22a..16b1279ef 100644
--- a/howto/use-git-daemon.html
+++ b/howto/use-git-daemon.html
@@ -791,7 +791,7 @@ a good practice to put the paths after a "--" separator.</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:18 JST

+ 2022-12-19 12:03:45 JST

 </div>

 </div>

 </body>

diff --git a/howto/using-merge-subtree.html b/howto/using-merge-subtree.html
index c804d306a..fbf42d109 100644
--- a/howto/using-merge-subtree.html
+++ b/howto/using-merge-subtree.html
@@ -848,7 +848,7 @@ Please note that if the other project merges from you, then it will
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:17 JST

+ 2022-12-19 12:03:44 JST

 </div>

 </div>

 </body>

diff --git a/howto/using-signed-tag-in-pull-request.html b/howto/using-signed-tag-in-pull-request.html
index 2264c164b..39a244d9a 100644
--- a/howto/using-signed-tag-in-pull-request.html
+++ b/howto/using-signed-tag-in-pull-request.html
@@ -952,7 +952,7 @@ as part of the merge commit.</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2022-12-14 18:46:18 JST

+ 2022-12-19 12:03:44 JST

 </div>

 </div>

 </body>