Autogenerated HTML docs for v2.48.1-220-gbc204b

Author: gitster

Diff for: BreakingChanges.txt

@@ -154,6 +154,31 @@ Cf. <[email protected]>,
     <CAKvOHKAFXQwt4D8yUCCkf_TQL79mYaJ=KAKhtpDNTvHJFuX1NA@mail.gmail.com>,
     <[email protected]>,
 
+* Support for storing shorthands for remote URLs in "$GIT_COMMON_DIR/branches/"
+  and "$GIT_COMMON_DIR/remotes/" has been long superseded by storing remotes in
+  the repository configuration.
++
+The mechanism has originally been introduced in f170e4b39d ([PATCH] fetch/pull:
+short-hand notation for remote repositories., 2005-07-16) and was superseded by
+6687f8fea2 ([PATCH] Use .git/remote/origin, not .git/branches/origin.,
+2005-08-20), where we switched from ".git/branches/" to ".git/remotes/". That
+commit already mentions an upcoming deprecation of the ".git/branches/"
+directory, and starting with a1d4aa7424 (Add repository-layout document.,
+2005-09-01) we have also marked this layout as deprecated. Eventually we also
+started to migrate away from ".git/remotes/" in favor of config-based remotes,
+and we have marked the directory as legacy in 3d3d282146 (Documentation:
+Grammar correction, wording fixes and cleanup, 2011-08-23)
++
+As our documentation mentions, these directories are not to be found in modern
+repositories at all and most users aren't even aware of these mechanisms. They
+have been deprecated for almost 20 years and 14 years respectively, and we are
+not aware of any active users that have complained about this deprecation.
+Furthermore, the ".git/branches/" directory is nowadays misleadingly named and
+may cause confusion as "branches" are almost exclusively used in the context of
+references.
++
+These features will be removed.
+
 == Superseded features that will not be deprecated
 
 Some features have gained newer replacements that aim to improve the design in

Diff for: RelNotes/2.49.0.txt

@@ -26,6 +26,11 @@ Performance, Internal Implementation, Development Support etc.
  * Introduce a new API to visit objects in batches based on a common
    path, or by type.
 
+ * Following the procedure we established to introduce breaking
+   changes for Git 3.0, allow an early opt-in for removing support of
+   $GIT_DIR/branches/ and $GIT_DIR/remotes/ directories to configure
+   remotes.
+
 
 Fixes since v2.48
 -----------------
@@ -113,6 +118,14 @@ Fixes since v2.48
    stress that the command reads its data from the standard input.
    (merge 49edce4ff9 jc/show-index-h-update later to maint).
 
+ * The API around choosing to use unsafe variant of SHA-1
+   implementation has been updated in an attempt to make it harder to
+   abuse.
+   (merge 04292c3796 tb/unsafe-hash-cleanup later to maint).
+
+ * Fix bugs in an earlier attempt to fix "git refs migration".
+   (merge f11f0a5a2d kn/reflog-migration-fix-fix later to maint).
+
  * Other code cleanup, docfix, build fix, etc.
    (merge ddb5287894 jk/t7407-use-test-grep later to maint).
    (merge 21e1b44865 aj/difftool-config-doc-fix later to maint).
@@ -123,3 +136,5 @@ Fixes since v2.48
    (merge 69666e6746 ja/doc-restore-markup-update later to maint).
    (merge d11d003ba5 sk/strlen-returns-size_t later to maint).
    (merge 77b2d29e91 ja/doc-notes-markup-updates later to maint).
+   (merge 6979bf6f8f jk/combine-diff-cleanup later to maint).
+   (merge 8705c9bd13 kn/pack-write-with-reduced-globals later to maint).

Diff for: gitrepository-layout.html

@@ -636,7 +636,7 @@ <h2 id="_description">DESCRIPTION</h2>
 </dd>
 <dt class="hdlist1">branches</dt>
 <dd>
-<p>A slightly deprecated way to store shorthands to be used
+<p>A deprecated way to store shorthands to be used
 to specify a URL to <em>git fetch</em>, <em>git pull</em> and <em>git push</em>.
 A file can be stored as <code>branches/</code><em>&lt;name&gt;</em> and then
 <em>name</em> can be given to these commands in place of
@@ -645,6 +645,9 @@ <h2 id="_description">DESCRIPTION</h2>
 and not likely to be found in modern repositories. This
 directory is ignored if $GIT_COMMON_DIR is set and
 "$GIT_COMMON_DIR/branches" will be used instead.</p>
+<div class="paragraph">
+<p>Git will stop reading remotes from this directory in Git 3.0.</p>
+</div>
 </dd>
 <dt class="hdlist1">hooks</dt>
 <dd>
@@ -732,6 +735,9 @@ <h2 id="_description">DESCRIPTION</h2>
 and not likely to be found in modern repositories. This
 directory is ignored if $GIT_COMMON_DIR is set and
 "$GIT_COMMON_DIR/remotes" will be used instead.</p>
+<div class="paragraph">
+<p>Git will stop reading remotes from this directory in Git 3.0.</p>
+</div>
 </dd>
 <dt class="hdlist1">logs</dt>
 <dd>
@@ -925,7 +931,7 @@ <h2 id="_git">GIT</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-07 20:36:53 -0800
+Last updated 2025-02-03 11:48:31 -0800
 </div>
 </div>
 </body>

Diff for: gitrepository-layout.txt

@@ -153,7 +153,7 @@ config.worktree::
 	linkgit:git-worktree[1]).
 
 branches::
-	A slightly deprecated way to store shorthands to be used
+	A deprecated way to store shorthands to be used
 	to specify a URL to 'git fetch', 'git pull' and 'git push'.
 	A file can be stored as `branches/<name>` and then
 	'name' can be given to these commands in place of
@@ -162,7 +162,8 @@ branches::
 	and not likely to be found in modern repositories. This
 	directory is ignored if $GIT_COMMON_DIR is set and
 	"$GIT_COMMON_DIR/branches" will be used instead.
-
++
+Git will stop reading remotes from this directory in Git 3.0.
 
 hooks::
 	Hooks are customization scripts used by various Git
@@ -238,6 +239,8 @@ remotes::
 	and not likely to be found in modern repositories. This
 	directory is ignored if $GIT_COMMON_DIR is set and
 	"$GIT_COMMON_DIR/remotes" will be used instead.
++
+Git will stop reading remotes from this directory in Git 3.0.
 
 logs::
 	Records of changes made to refs are stored in this directory.