Skip to content

Commit 386d589

Browse files
committed
Autogenerated HTML docs for v2.51.2-636-ga99f3
1 parent bf5b4c6 commit 386d589

File tree

6 files changed

+99
-4
lines changed

6 files changed

+99
-4
lines changed

‎BreakingChanges.adoc‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,26 @@ The command will be removed.
295295
+
296296
297297

298+
* Support for `core.preferSymlinkRefs=true` has been deprecated and will be
299+
removed in Git 3.0. Writing symbolic refs as symbolic links will be phased
300+
out in favor of using plain files using the textual representation of
301+
symbolic refs.
302+
+
303+
Symbolic references were initially always stored as a symbolic link. This was
304+
changed in 9b143c6e15 (Teach update-ref about a symbolic ref stored in a
305+
textfile., 2005-09-25), where a new textual symref format was introduced to
306+
store those symbolic refs in a plain file. In 9f0bb90d16
307+
(core.prefersymlinkrefs: use symlinks for .git/HEAD, 2006-05-02), the Git
308+
project switched the default to use the textual symrefs in favor of symbolic
309+
links.
310+
+
311+
The migration away from symbolic links has happened almost 20 years ago by now,
312+
and there is no known reason why one should prefer them nowadays. Furthermore,
313+
symbolic links are not supported on some platforms.
314+
+
315+
Note that only the writing side for such symbolic links is deprecated. Reading
316+
such symbolic links is still supported for now.
317+
298318
== Superseded features that will not be deprecated
299319

300320
Some features have gained newer replacements that aim to improve the design in

‎BreakingChanges.html‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -871,6 +871,30 @@ <h3 id="_removals">Removals</h3>
871871
<p>cf. &lt;[email protected]&gt;</p>
872872
</div>
873873
</li>
874+
<li>
875+
<p>Support for <code>core.preferSymlinkRefs=true</code> has been deprecated and will be
876+
removed in Git 3.0. Writing symbolic refs as symbolic links will be phased
877+
out in favor of using plain files using the textual representation of
878+
symbolic refs.</p>
879+
<divclass="paragraph">
880+
<p>Symbolic references were initially always stored as a symbolic link. This was
881+
changed in 9b143c6e15 (Teach update-ref about a symbolic ref stored in a
882+
textfile., 2005-09-25), where a new textual symref format was introduced to
883+
store those symbolic refs in a plain file. In 9f0bb90d16
884+
(core.prefersymlinkrefs: use symlinks for .git/HEAD, 2006-05-02), the Git
885+
project switched the default to use the textual symrefs in favor of symbolic
886+
links.</p>
887+
</div>
888+
<divclass="paragraph">
889+
<p>The migration away from symbolic links has happened almost 20 years ago by now,
890+
and there is no known reason why one should prefer them nowadays. Furthermore,
891+
symbolic links are not supported on some platforms.</p>
892+
</div>
893+
<divclass="paragraph">
894+
<p>Note that only the writing side for such symbolic links is deprecated. Reading
895+
such symbolic links is still supported for now.</p>
896+
</div>
897+
</li>
874898
</ul>
875899
</div>
876900
</div>
@@ -909,7 +933,7 @@ <h2 id="_superseded_features_that_will_not_be_deprecated">Superseded features th
909933
</div>
910934
<divid="footer">
911935
<divid="footer-text">
912-
Last updated 2025-10-08 13:52:53 -0700
936+
Last updated 2025-10-30 13:01:01 -0700
913937
</div>
914938
</div>
915939
</body>

‎RelNotes/2.52.0.adoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,12 @@ UI, Workflows & Features
6464
* "git fast-import" is taught to handle signed tags, just like it
6565
recently learned to handle signed commits, in different ways.
6666

67+
* A new configuration variable commitGraph.changedPaths allows to
68+
turn "--changed-paths" on by default for "git commit-graph".
69+
70+
* "Symlink symref" has been added to the list of things that will
71+
disappear at Git 3.0 boundary.
72+
6773

6874
Performance, Internal Implementation, Development Support etc.
6975
--------------------------------------------------------------
@@ -149,6 +155,9 @@ Performance, Internal Implementation, Development Support etc.
149155
* The code in "git repack" machinery has been cleaned up to prepare
150156
for incremental update of midx files.
151157
158+
* Two slightly different ways to get at "all the packfiles" in API
159+
has been cleaned up.
160+
152161
153162
Fixes since v2.51
154163
-----------------
@@ -359,6 +368,20 @@ including security updates, are included in this release.
359368
fail doe to overly long pathname in our test environment, which has
360369
been worked around by using "ssh-agent -T".
361370

371+
* strbuf_split*() to split a string into multiple strbufs is often a
372+
wrong API to use. A few uses of it have been removed by
373+
simplifying the code.
374+
(merge 2ab72a16d9 ob/gpg-interface-cleanup later to maint).
375+
376+
* "git shortlog" knows "--committer" and "--author" options, which
377+
the command line completion (in contrib/) did not handle well,
378+
which has been corrected.
379+
(merge c568fa8e1c kf/log-shortlog-completion-fix later to maint).
380+
381+
* "git bisect" command did not react correctly to "git bisect help"
382+
and "git bisect unknown", which has been corrected.
383+
(merge 2bb3a012f3 rz/bisect-help-unknown later to maint).
384+
362385
* Other code cleanup, docfix, build fix, etc.
363386
(merge 529a60a885 ua/t1517-short-help-tests later to maint).
364387
(merge 22d421fed9 ac/deglobal-fmt-merge-log-config later to maint).

‎git-commit-graph.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ take a while on large repositories. It provides significant performance gains
7171
for getting history of a directory or a file with `git log -- <path>`. If
7272
this option is given, future commit-graph writes will automatically assume
7373
that this option was intended. Use `--no-changed-paths` to stop storing this
74-
data.
74+
data.`--changed-paths` is implied by config `commitGraph.changedPaths=true`.
7575
+
7676
With the `--max-new-filters=<n>` option, generate at most `n` new Bloom
7777
filters (if `--changed-paths` is specified). If `n` is `-1`, no limit is

‎git-commit-graph.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ <h2 id="_commands">COMMANDS</h2>
533533
for getting history of a directory or a file with <code>git</code><code>log</code><code>--</code><em>&lt;path&gt;</em>. If
534534
this option is given, future commit-graph writes will automatically assume
535535
that this option was intended. Use <code>--no-changed-paths</code> to stop storing this
536-
data.</p>
536+
data.<code>--changed-paths</code> is implied by config <code>commitGraph.changedPaths=true</code>.</p>
537537
</div>
538538
<divclass="paragraph">
539539
<p>With the <code>--max-new-filters=</code><em>&lt;n&gt;</em> option, generate at most <code>n</code> new Bloom
@@ -659,6 +659,18 @@ <h2 id="_configuration">CONFIGURATION</h2>
659659
<p>Specifies the default value for the <code>--max-new-filters</code> option of <code>git</code>
660660
<code>commit-graph</code><code>write</code> (c.f., <ahref="git-commit-graph.html">git-commit-graph(1)</a>).</p>
661661
</dd>
662+
<dtclass="hdlist1">commitGraph.changedPaths</dt>
663+
<dd>
664+
<p>If true, then <code>git</code><code>commit-graph</code><code>write</code> will compute and write
665+
changed-path Bloom filters by default, equivalent to passing
666+
<code>--changed-paths</code>. If false or unset, changed-paths Bloom filters will
667+
be written during <code>git</code><code>commit-graph</code><code>write</code> only if the filters already
668+
exist in the current commit-graph file. This matches the default
669+
behavior of <code>git</code><code>commit-graph</code><code>write</code> without any <code>--</code>[<code>no-</code>]<code>changed-paths</code>
670+
option. To rewrite a commit-graph file without any filters, use the
671+
<code>--no-changed-paths</code> option. Command-line option <code>--</code>[<code>no-</code>]<code>changed-paths</code>
672+
always takes precedence over this configuration. Defaults to unset.</p>
673+
</dd>
662674
<dtclass="hdlist1">commitGraph.readChangedPaths</dt>
663675
<dd>
664676
<p>Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and
@@ -718,7 +730,7 @@ <h2 id="_git">GIT</h2>
718730
</div>
719731
<divid="footer">
720732
<divid="footer-text">
721-
Last updated 2025-08-25 14:46:08 -0700
733+
Last updated 2025-10-30 13:01:01 -0700
722734
</div>
723735
</div>
724736
</body>

‎git-config.html‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2956,6 +2956,18 @@ <h3 id="_variables">Variables</h3>
29562956
<p>Specifies the default value for the <code>--max-new-filters</code> option of <code>git</code>
29572957
<code>commit-graph</code><code>write</code> (c.f., <ahref="git-commit-graph.html">git-commit-graph(1)</a>).</p>
29582958
</dd>
2959+
<dtclass="hdlist1">commitGraph.changedPaths</dt>
2960+
<dd>
2961+
<p>If true, then <code>git</code><code>commit-graph</code><code>write</code> will compute and write
2962+
changed-path Bloom filters by default, equivalent to passing
2963+
<code>--changed-paths</code>. If false or unset, changed-paths Bloom filters will
2964+
be written during <code>git</code><code>commit-graph</code><code>write</code> only if the filters already
2965+
exist in the current commit-graph file. This matches the default
2966+
behavior of <code>git</code><code>commit-graph</code><code>write</code> without any <code>--</code>[<code>no-</code>]<code>changed-paths</code>
2967+
option. To rewrite a commit-graph file without any filters, use the
2968+
<code>--no-changed-paths</code> option. Command-line option <code>--</code>[<code>no-</code>]<code>changed-paths</code>
2969+
always takes precedence over this configuration. Defaults to unset.</p>
2970+
</dd>
29592971
<dtclass="hdlist1">commitGraph.readChangedPaths</dt>
29602972
<dd>
29612973
<p>Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and
@@ -3338,6 +3350,10 @@ <h3 id="_variables">Variables</h3>
33383350
and other symbolic reference files, use symbolic links.
33393351
This is sometimes needed to work with old scripts that
33403352
expect HEAD to be a symbolic link.</p>
3353+
<divclass="paragraph">
3354+
<p>This configuration is deprecated and will be removed in Git 3.0. Symbolic refs
3355+
will always be written as textual symrefs.</p>
3356+
</div>
33413357
</dd>
33423358
<dtclass="hdlist1">core.alternateRefsCommand</dt>
33433359
<dd>

0 commit comments

Comments
(0)