Skip to content

Commit 6ca5372

Browse files
gitstergitster
committed
Autogenerated HTML docs for v2.45.1-410-g58bac4
1 parent 1bfbb6c commit 6ca5372

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+1042
-106
lines changed

‎DecisionMaking.html

Lines changed: 821 additions & 0 deletions
Large diffs are not rendered by default.

‎DecisionMaking.txt

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
Decision-Making Process in the Git Project
2+
==========================================
3+
4+
Introduction
5+
------------
6+
This document describes the current decision-making process in the Git
7+
project. It is a descriptive rather than prescriptive doc; that is, we want to
8+
describe how things work in practice rather than explicitly recommending any
9+
particular process or changes to the current process.
10+
11+
Here we document how the project makes decisions for discussions
12+
(with or without patches), in scale larger than an individual patch
13+
series (which is fully covered by the SubmittingPatches document).
14+
15+
16+
Larger Discussions (with patches)
17+
---------------------------------
18+
As with discussions on an individual patch series, starting a larger-scale
19+
discussion often begins by sending a patch or series to the list. This might
20+
take the form of an initial design doc, with implementation following in later
21+
iterations of the series (for example,
22+
link:https://lore.kernel.org/git/0169ce6fb9ccafc089b74ae406db0d1a8ff8ac65.1688165272.git.steadmon@google.com/[adding unit tests] or
23+
link:https://lore.kernel.org/git/[email protected]/[config-based hooks]),
24+
or it might include a full implementation from the beginning.
25+
In either case, discussion progresses the same way for an individual patch series,
26+
until consensus is reached or the topic is dropped.
27+
28+
29+
Larger Discussions (without patches)
30+
------------------------------------
31+
Occasionally, larger discussions might occur without an associated patch series.
32+
These may be very large-scale technical decisions that are beyond the scope of
33+
even a single large patch series, or they may be more open-ended,
34+
policy-oriented discussions (examples:
35+
link:https://lore.kernel.org/git/[email protected]/[introducing Rust]
36+
or link:https://lore.kernel.org/git/[email protected]/[improving submodule UX]).
37+
In either case, discussion progresses as described above for general patch series.
38+
39+
For larger discussions without a patch series or other concrete implementation,
40+
it may be hard to judge when consensus has been reached, as there are not any
41+
official guidelines. If discussion stalls at this point, it may be helpful to
42+
restart discussion with an RFC patch series (such as a partial, unfinished
43+
implementation or proof of concept) that can be more easily debated.
44+
45+
When consensus is reached that it is a good idea, the original
46+
proposer is expected to coordinate the effort to make it happen,
47+
with help from others who were involved in the discussion, as
48+
needed.
49+
50+
For decisions that require code changes, it is often the case that the original
51+
proposer will follow up with a patch series, although it is also common for
52+
other interested parties to provide an implementation (or parts of the
53+
implementation, for very large changes).
54+
55+
For non-technical decisions such as community norms or processes, it is up to
56+
the community as a whole to implement and sustain agreed-upon changes.
57+
The project leadership committe (PLC) may help the implementation of
58+
policy decisions.
59+
60+
61+
Other Discussion Venues
62+
-----------------------
63+
Occasionally decision proposals are presented off-list, e.g. at the semi-regular
64+
Contributors' Summit. While higher-bandwidth face-to-face discussion is often
65+
useful for quickly reaching consensus among attendees, generally we expect to
66+
summarize the discussion in notes that can later be presented on-list. For an
67+
example, see the thread
68+
link:https://lore.kernel.org/git/[email protected]/[Notes
69+
from Git Contributor Summit, Los Angeles (April 5, 2020)] by James Ramsay.
70+
71+
We prefer that "official" discussion happens on the list so that the full
72+
community has opportunity to engage in discussion. This also means that the
73+
mailing list archives contain a more-or-less complete history of project
74+
discussions and decisions.

‎MyFirstContribution.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>My First Contribution to the Git Project</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

‎MyFirstObjectWalk.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>My First Object Walk</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

‎RelNotes/2.46.0.txt

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ UI, Workflows & Features
4949
to the recent update to "git config" that adopted subcommand based
5050
UI.
5151

52+
* The knobs to tweak how reftable files are written have been made
53+
available as configuration variables.
54+
5255

5356
Performance, Internal Implementation, Development Support etc.
5457

@@ -87,14 +90,24 @@ Performance, Internal Implementation, Development Support etc.
8790
builtin/config.c done via the use of global variables.
8891

8992
* The pack bitmap code saw some clean-up to prepare for a follow-up topic.
90-
(merge 85f360fee5 tb/pack-bitmap-write-cleanups later to maint).
9193

9294
* Preliminary code clean-up for "git send-email".
93-
(merge c02dc38570 ds/send-email-per-message-block later to maint).
9495

9596
* The default "creation-factor" used by "git format-patch" has been
9697
raised to make it more aggressively find matching commits.
97-
(merge c22d41d641 jc/format-patch-more-aggressive-range-diff later to maint).
98+
99+
* Before discovering the repository details, We used to assume SHA-1
100+
as the "default" hash function, which has been corrected. Hopefully
101+
this will smoke out codepaths that rely on such an unwarranted
102+
assumptions.
103+
104+
* The project decision making policy has been documented.
105+
106+
* The strcmp-offset tests have been rewritten using the unit test
107+
framework.
108+
109+
* "git add -p" learned to complain when an answer with more than one
110+
letter is given to a prompt that expects a single letter answer.
98111

99112

100113
Fixes since v2.45
@@ -180,6 +193,15 @@ Fixes since v2.45
180193
the keychain.
181194
(merge e1ab45b2da kn/osxkeychain-skip-idempotent-store later to maint).
182195

196+
* The chainlint script (invoked during "make test") did nothing when
197+
it failed to detect the number of available CPUs. It now falls
198+
back to 1 CPU to avoid the problem.
199+
(merge 2e7e9205be es/chainlint-ncores-fix later to maint).
200+
201+
* Revert overly aggressive "layered defence" that went into 2.45.1
202+
and friends, which broke "git-lfs", "git-annex", and other use
203+
cases, so that we can rebuild necessary counterparts in the open.
204+
183205
* Other code cleanup, docfix, build fix, etc.
184206
(merge 4cf6e7bf5e jt/doc-submitting-rerolled-series later to maint).
185207
(merge a5a4cb7b27 rs/diff-parseopts-cleanup later to maint).

‎ReviewingGuidelines.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>Reviewing Patches in the Git Project</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

‎SubmittingPatches.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>Submitting Patches</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

‎ToolsForGit.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>Tools for developing Git</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

‎config.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,8 @@ include::config/rebase.txt[]
498498

499499
include::config/receive.txt[]
500500

501+
include::config/reftable.txt[]
502+
501503
include::config/remote.txt[]
502504

503505
include::config/remotes.txt[]

‎everyday.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>Everyday Git With 20 Commands Or So</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">

‎fsck-msgids.txt

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -164,18 +164,6 @@
164164
`nullSha1`::
165165
(WARN) Tree contains entries pointing to a null sha1.
166166

167-
`symlinkPointsToGitDir`::
168-
(WARN) Symbolic link points inside a gitdir.
169-
170-
`symlinkTargetBlob`::
171-
(ERROR) A non-blob found instead of a symbolic link's target.
172-
173-
`symlinkTargetLength`::
174-
(WARN) Symbolic link target longer than maximum path length.
175-
176-
`symlinkTargetMissing`::
177-
(ERROR) Unable to read symbolic link target's blob.
178-
179167
`treeNotSorted`::
180168
(ERROR) A tree is not properly sorted.
181169

‎git-config.html

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10285,6 +10285,67 @@ <h3 id="_variables">Variables</h3>
1028510285
</p>
1028610286
</dd>
1028710287
<dt class="hdlist1">
10288+
reftable.blockSize
10289+
</dt>
10290+
<dd>
10291+
<p>
10292+
The size in bytes used by the reftable backend when writing blocks.
10293+
The block size is determined by the writer, and does not have to be a
10294+
power of 2. The block size must be larger than the longest reference
10295+
name or log entry used in the repository, as references cannot span
10296+
blocks.
10297+
</p>
10298+
<div class="paragraph"><p>Powers of two that are friendly to the virtual memory system or
10299+
filesystem (such as 4kB or 8kB) are recommended. Larger sizes (64kB) can
10300+
yield better compression, with a possible increased cost incurred by
10301+
readers during access.</p></div>
10302+
<div class="paragraph"><p>The largest block size is <code>16777215</code> bytes (15.99 MiB). The default value is
10303+
<code>4096</code> bytes (4kB). A value of <code>0</code> will use the default value.</p></div>
10304+
</dd>
10305+
<dt class="hdlist1">
10306+
reftable.restartInterval
10307+
</dt>
10308+
<dd>
10309+
<p>
10310+
The interval at which to create restart points. The reftable backend
10311+
determines the restart points at file creation. Every 16 may be
10312+
more suitable for smaller block sizes (4k or 8k), every 64 for larger
10313+
block sizes (64k).
10314+
</p>
10315+
<div class="paragraph"><p>More frequent restart points reduces prefix compression and increases
10316+
space consumed by the restart table, both of which increase file size.</p></div>
10317+
<div class="paragraph"><p>Less frequent restart points makes prefix compression more effective,
10318+
decreasing overall file size, with increased penalties for readers
10319+
walking through more records after the binary search step.</p></div>
10320+
<div class="paragraph"><p>A maximum of <code>65535</code> restart points per block is supported.</p></div>
10321+
<div class="paragraph"><p>The default value is to create restart points every 16 records. A value of <code>0</code>
10322+
will use the default value.</p></div>
10323+
</dd>
10324+
<dt class="hdlist1">
10325+
reftable.indexObjects
10326+
</dt>
10327+
<dd>
10328+
<p>
10329+
Whether the reftable backend shall write object blocks. Object blocks
10330+
are a reverse mapping of object ID to the references pointing to them.
10331+
</p>
10332+
<div class="paragraph"><p>The default value is <code>true</code>.</p></div>
10333+
</dd>
10334+
<dt class="hdlist1">
10335+
reftable.geometricFactor
10336+
</dt>
10337+
<dd>
10338+
<p>
10339+
Whenever the reftable backend appends a new table to the stack, it
10340+
performs auto compaction to ensure that there is only a handful of
10341+
tables. The backend does this by ensuring that tables form a geometric
10342+
sequence regarding the respective sizes of each table.
10343+
</p>
10344+
<div class="paragraph"><p>By default, the geometric sequence uses a factor of 2, meaning that for any
10345+
table, the next-biggest table must at least be twice as big. A maximum factor
10346+
of 256 is supported.</p></div>
10347+
</dd>
10348+
<dt class="hdlist1">
1028810349
remote.pushDefault
1028910350
</dt>
1029010351
<dd>

‎git-fsck.html

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1507,38 +1507,6 @@ <h2 id="_fsck_messages">FSCK MESSAGES</h2>
15071507
</p>
15081508
</dd>
15091509
<dt class="hdlist1">
1510-
<code>symlinkPointsToGitDir</code>
1511-
</dt>
1512-
<dd>
1513-
<p>
1514-
(WARN) Symbolic link points inside a gitdir.
1515-
</p>
1516-
</dd>
1517-
<dt class="hdlist1">
1518-
<code>symlinkTargetBlob</code>
1519-
</dt>
1520-
<dd>
1521-
<p>
1522-
(ERROR) A non-blob found instead of a symbolic link&#8217;s target.
1523-
</p>
1524-
</dd>
1525-
<dt class="hdlist1">
1526-
<code>symlinkTargetLength</code>
1527-
</dt>
1528-
<dd>
1529-
<p>
1530-
(WARN) Symbolic link target longer than maximum path length.
1531-
</p>
1532-
</dd>
1533-
<dt class="hdlist1">
1534-
<code>symlinkTargetMissing</code>
1535-
</dt>
1536-
<dd>
1537-
<p>
1538-
(ERROR) Unable to read symbolic link target&#8217;s blob.
1539-
</p>
1540-
</dd>
1541-
<dt class="hdlist1">
15421510
<code>treeNotSorted</code>
15431511
</dt>
15441512
<dd>

‎git-remote-helpers.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>git-remote-helpers</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">

‎howto/coordinate-embargoed-releases.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1038,7 +1038,7 @@ <h3 id="_example_mail_to_a_href_mailto_oss_security_lists_openwall_com_oss_secur
10381038
<div id="footer">
10391039
<div id="footer-text">
10401040
Last updated
1041-
2024-05-28 13:39:32 PDT
1041+
2024-05-30 16:24:54 PDT
10421042
</div>
10431043
</div>
10441044
</body>

‎howto/keep-canonical-history-correct.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>Keep authoritative canonical history correct with git pull</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -939,7 +939,7 @@ <h1>Keep authoritative canonical history correct with git pull</h1>
939939
<div id="footer">
940940
<div id="footer-text">
941941
Last updated
942-
2024-05-28 13:39:32 PDT
942+
2024-05-30 16:24:53 PDT
943943
</div>
944944
</div>
945945
</body>

‎howto/maintain-git.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>How to maintain Git</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">
@@ -1479,7 +1479,7 @@ <h3 id="_preparing_a_merge_fix">Preparing a "merge-fix"</h3>
14791479
<div id="footer">
14801480
<div id="footer-text">
14811481
Last updated
1482-
2024-05-28 13:39:32 PDT
1482+
2024-05-30 16:24:54 PDT
14831483
</div>
14841484
</div>
14851485
</body>

‎howto/new-command.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@
735735
<body class="article">
736736
<div id="header">
737737
<h1>How to integrate new subcommands</h1>
738-
<span id="revdate">2024-05-28</span>
738+
<span id="revdate">2024-05-30</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -864,7 +864,7 @@ <h2 id="_integrating_a_command">Integrating a command</h2>
864864
<div id="footer">
865865
<div id="footer-text">
866866
Last updated
867-
2024-05-28 13:39:30 PDT
867+
2024-05-30 16:24:52 PDT
868868
</div>
869869
</div>
870870
</body>

0 commit comments

Comments
 (0)