Skip to content

Commit 1365ca3

Browse files
committed
Autogenerated HTML docs for v2.45.0-145-g3e4a2
1 parent 7af7f87 commit 1365ca3

Some content is hidden

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

52 files changed

+368
-85
lines changed

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-04-30</span>
738+
<span id="revdate">2024-05-13</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-04-30</span>
738+
<span id="revdate">2024-05-13</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

RelNotes/2.46.0.txt

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,22 @@ UI, Workflows & Features
1010
* The "--rfc" option of "git format-patch" learned to take an
1111
optional string value to be used in place of "RFC" to tweak the
1212
"[PATCH]" on the subject header.
13-
(merge ce36894509 jc/format-patch-rfc-more later to maint).
13+
14+
* The credential helper protocol, together with the HTTP layer, have
15+
been enhanced to support authentication schemes different from
16+
username & password pair, like Bearer and NTLM.
17+
18+
* Command line completion script (in contrib/) learned to complete
19+
"git symbolic-ref" a bit better (you need to enable plumbing
20+
commands to be completed with GIT_COMPLETION_SHOW_ALL_COMMANDS).
21+
22+
* When the user responds to a prompt given by "git add -p" with an
23+
unsupported command, list of available commands were given, which
24+
was too much if the user knew what they wanted to type but merely
25+
made a typo. Now the user gets a much shorter error message.
26+
27+
* The color parsing code learned to handle 12-bit RGB colors, spelled
28+
as "#RGB" (in addition to "#RRGGBB" that is already supported).
1429

1530

1631
Performance, Internal Implementation, Development Support etc.
@@ -23,6 +38,20 @@ Performance, Internal Implementation, Development Support etc.
2338
that are used in fuzzer tests, to make sure at least they build
2439
without bitrot, in Linux CI runs.
2540

41+
* Code to write out reftable has seen some optimization and
42+
simplification.
43+
44+
* Tests to ensure interoperability between reftable written by jgit
45+
and our code have been added and enabled in CI.
46+
47+
* The singleton index_state instance "the_index" has been eliminated
48+
by always instantiating "the_repository" and replacing references
49+
to "the_index" with references to its .index member.
50+
51+
52+
* Git-GUI has a new maintainer, Johannes Sixt.
53+
(merge e18ad8eb26 jc/git-gui-maintainer-update later to maint).
54+
2655

2756
Fixes since v2.45
2857
-----------------
@@ -52,4 +81,37 @@ Fixes since v2.45
5281
errored out. Now it keeps going.
5382
(merge c75662bfc9 js/for-each-repo-keep-going later to maint).
5483

84+
* zsh can pretend to be a normal shell pretty well except for some
85+
glitches that we tickle in some of our scripts. Work them around
86+
so that "vimdiff" and our test suite works well enough with it.
87+
(merge fedd5c79ff bc/zsh-compatibility later to maint).
88+
89+
* Command line completion support for zsh (in contrib/) has been
90+
updated to stop exposing internal state to end-user shell
91+
interaction.
92+
(merge 3c20acdf46 dk/zsh-git-repo-path-fix later to maint).
93+
94+
* Tests that try to corrupt in-repository files in chunked format did
95+
not work well on macOS due to its broken "mv", which has been
96+
worked around.
97+
(merge 861dc19ba8 jc/test-workaround-broken-mv later to maint).
98+
99+
* The maximum size of attribute files is enforced more consistently.
100+
(merge c793f9cb08 tb/attr-limits later to maint).
101+
102+
* Unbreak CI jobs so that we do not attempt to use Python 2 that has
103+
been removed from the platform.
104+
(merge 5ca0c455f1 ps/ci-python-2-deprecation later to maint).
105+
106+
* Git 2.43 started using the tree of HEAD as the source of attributes
107+
in a bare repository, which has severe performance implications.
108+
For now, revert the change, without ripping out a more explicit
109+
support for the attr.tree configuration variable.
110+
(merge 51441e6460 jc/no-default-attr-tree-in-bare later to maint).
111+
55112
* Other code cleanup, docfix, build fix, etc.
113+
(merge 4cf6e7bf5e jt/doc-submitting-rerolled-series later to maint).
114+
(merge a5a4cb7b27 rs/diff-parseopts-cleanup later to maint).
115+
(merge 395c130fd8 ma/win32-unix-domain-socket later to maint).
116+
(merge 7df2405b38 jk/ci-macos-gcc13-fix later to maint).
117+
(merge 55702c543e fa/p4-error 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-04-30</span>
738+
<span id="revdate">2024-05-13</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

SubmittingPatches.html

Lines changed: 10 additions & 8 deletions
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-04-30</span>
738+
<span id="revdate">2024-05-13</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">
@@ -1257,10 +1257,12 @@ <h4 id="_code_format_patch_code_and_code_send_email_code"><code>format-patch</co
12571257
e-mail tools, so that they may comment on specific portions of
12581258
your code. For this reason, each patch should be submitted
12591259
"inline" in a separate message.</p></div>
1260-
<div class="paragraph"><p>Multiple related patches should be grouped into their own e-mail
1261-
thread to help readers find all parts of the series. To that end,
1262-
send them as replies to either an additional "cover letter" message
1263-
(see below), the first patch, or the respective preceding patch.</p></div>
1260+
<div class="paragraph"><p>All subsequent versions of a patch series and other related patches should be
1261+
grouped into their own e-mail thread to help readers find all parts of the
1262+
series. To that end, send them as replies to either an additional "cover
1263+
letter" message (see below), the first patch, or the respective preceding patch.
1264+
Here is a <a href="MyFirstContribution.html#v2-git-send-email">step-by-step guide</a> on
1265+
how to submit updated versions of a patch series.</p></div>
12641266
<div class="paragraph"><p>If your log message (including your name on the
12651267
<code>Signed-off-by</code> trailer) is not writable in ASCII, make sure that
12661268
you send off a message in the correct encoding.</p></div>
@@ -1344,11 +1346,11 @@ <h2 id="_subsystems_with_dedicated_maintainers">Subsystems with dedicated mainta
13441346
<div class="ulist"><ul>
13451347
<li>
13461348
<p>
1347-
<code>git-gui/</code> comes from git-gui project, maintained by Pratyush Yadav:
1349+
<code>git-gui/</code> comes from git-gui project, maintained by Johannes Sixt:
13481350
</p>
13491351
<div class="literalblock">
13501352
<div class="content">
1351-
<pre><code>https://github.com/prati0100/git-gui.git</code></pre>
1353+
<pre><code>https://github.com/j6t/git-gui</code></pre>
13521354
</div></div>
13531355
</li>
13541356
<li>
@@ -1580,7 +1582,7 @@ <h3 id="_gnus">Gnus</h3>
15801582
<div id="footer">
15811583
<div id="footer-text">
15821584
Last updated
1583-
2024-05-01 10:56:52 PDT
1585+
2024-05-13 12:26:57 PDT
15841586
</div>
15851587
</div>
15861588
</body>

SubmittingPatches.txt

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -455,10 +455,12 @@ e-mail tools, so that they may comment on specific portions of
455455
your code. For this reason, each patch should be submitted
456456
"inline" in a separate message.
457457

458-
Multiple related patches should be grouped into their own e-mail
459-
thread to help readers find all parts of the series. To that end,
460-
send them as replies to either an additional "cover letter" message
461-
(see below), the first patch, or the respective preceding patch.
458+
All subsequent versions of a patch series and other related patches should be
459+
grouped into their own e-mail thread to help readers find all parts of the
460+
series. To that end, send them as replies to either an additional "cover
461+
letter" message (see below), the first patch, or the respective preceding patch.
462+
Here is a link:MyFirstContribution.html#v2-git-send-email[step-by-step guide] on
463+
how to submit updated versions of a patch series.
462464

463465
If your log message (including your name on the
464466
`Signed-off-by` trailer) is not writable in ASCII, make sure that
@@ -543,9 +545,9 @@ not a text/plain, it's something else.
543545
Some parts of the system have dedicated maintainers with their own
544546
repositories.
545547

546-
- `git-gui/` comes from git-gui project, maintained by Pratyush Yadav:
548+
- `git-gui/` comes from git-gui project, maintained by Johannes Sixt:
547549

548-
https://github.com/prati0100/git-gui.git
550+
https://github.com/j6t/git-gui
549551

550552
- `gitk-git/` comes from Paul Mackerras's gitk project:
551553

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-04-30</span>
738+
<span id="revdate">2024-05-13</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

config.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,8 @@ terminals, this is usually not the same as setting to "white black".
316316
Colors may also be given as numbers between 0 and 255; these use ANSI
317317
256-color mode (but note that not all terminals may support this). If
318318
your terminal supports it, you may also specify 24-bit RGB values as
319-
hex, like `#ff0ab3`.
319+
hex, like `#ff0ab3`, or 12-bit RGB values like `#f1b`, which is
320+
equivalent to the 24-bit color `#ff11bb`.
320321
+
321322
The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
322323
`italic`, and `strike` (for crossed-out or "strikethrough" letters).

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-04-30</span>
738+
<span id="revdate">2024-05-13</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">

git-config.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1946,7 +1946,8 @@ <h3 id="_values">Values</h3>
19461946
<div class="paragraph"><p>Colors may also be given as numbers between 0 and 255; these use ANSI
19471947
256-color mode (but note that not all terminals may support this). If
19481948
your terminal supports it, you may also specify 24-bit RGB values as
1949-
hex, like <code>#ff0ab3</code>.</p></div>
1949+
hex, like <code>#ff0ab3</code>, or 12-bit RGB values like <code>#f1b</code>, which is
1950+
equivalent to the 24-bit color <code>#ff11bb</code>.</p></div>
19501951
<div class="paragraph"><p>The accepted attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, <code>blink</code>, <code>reverse</code>,
19511952
<code>italic</code>, and <code>strike</code> (for crossed-out or "strikethrough" letters).
19521953
The position of any attributes with respect to the colors

git-credential.html

Lines changed: 121 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ <h2 id="_synopsis">SYNOPSIS</h2>
750750
<div class="sectionbody">
751751
<div class="listingblock">
752752
<div class="content">
753-
<pre><code>'git credential' (fill|approve|reject)</code></pre>
753+
<pre><code>'git credential' (fill|approve|reject|capability)</code></pre>
754754
</div></div>
755755
</div>
756756
</div>
@@ -779,6 +779,8 @@ <h2 id="_description">DESCRIPTION</h2>
779779
<div class="paragraph"><p>If the action is <code>reject</code>, git-credential will send the description to
780780
any configured credential helpers, which may erase any stored
781781
credentials matching the description.</p></div>
782+
<div class="paragraph"><p>If the action is <code>capability</code>, git-credential will announce any capabilities
783+
it supports to standard output.</p></div>
782784
<div class="paragraph"><p>If the action is <code>approve</code> or <code>reject</code>, no output should be emitted.</p></div>
783785
</div>
784786
</div>
@@ -863,7 +865,9 @@ <h2 id="IOFMT">INPUT/OUTPUT FORMAT</h2>
863865
attribute per line. Each attribute is specified by a key-value pair,
864866
separated by an <code>=</code> (equals) sign, followed by a newline.</p></div>
865867
<div class="paragraph"><p>The key may contain any bytes except <code>=</code>, newline, or NUL. The value may
866-
contain any bytes except newline or NUL.</p></div>
868+
contain any bytes except newline or NUL. A line, including the trailing
869+
newline, may not exceed 65535 bytes in order to allow implementations to
870+
parse efficiently.</p></div>
867871
<div class="paragraph"><p>Attributes with keys that end with C-style array brackets <code>[]</code> can have
868872
multiple values. Each instance of a multi-valued attribute forms an
869873
ordered list of values - the order of the repeated attributes defines
@@ -958,6 +962,80 @@ <h2 id="IOFMT">INPUT/OUTPUT FORMAT</h2>
958962
username in the example above) will be left unset.</p></div>
959963
</dd>
960964
<dt class="hdlist1">
965+
<code>authtype</code>
966+
</dt>
967+
<dd>
968+
<p>
969+
This indicates that the authentication scheme in question should be used.
970+
Common values for HTTP and HTTPS include <code>basic</code>, <code>bearer</code>, and <code>digest</code>,
971+
although the latter is insecure and should not be used. If <code>credential</code>
972+
is used, this may be set to an arbitrary string suitable for the protocol in
973+
question (usually HTTP).
974+
</p>
975+
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
976+
provided on input.</p></div>
977+
</dd>
978+
<dt class="hdlist1">
979+
<code>credential</code>
980+
</dt>
981+
<dd>
982+
<p>
983+
The pre-encoded credential, suitable for the protocol in question (usually
984+
HTTP). If this key is sent, <code>authtype</code> is mandatory, and <code>username</code> and
985+
<code>password</code> are not used. For HTTP, Git concatenates the <code>authtype</code> value and
986+
this value with a single space to determine the <code>Authorization</code> header.
987+
</p>
988+
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
989+
provided on input.</p></div>
990+
</dd>
991+
<dt class="hdlist1">
992+
<code>ephemeral</code>
993+
</dt>
994+
<dd>
995+
<p>
996+
This boolean value indicates, if true, that the value in the <code>credential</code>
997+
field should not be saved by the credential helper because its usefulness is
998+
limited in time. For example, an HTTP Digest <code>credential</code> value is computed
999+
using a nonce and reusing it will not result in successful authentication.
1000+
This may also be used for situations with short duration (e.g., 24-hour)
1001+
credentials. The default value is false.
1002+
</p>
1003+
<div class="paragraph"><p>The credential helper will still be invoked with <code>store</code> or <code>erase</code> so that it
1004+
can determine whether the operation was successful.</p></div>
1005+
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
1006+
provided on input.</p></div>
1007+
</dd>
1008+
<dt class="hdlist1">
1009+
<code>state[]</code>
1010+
</dt>
1011+
<dd>
1012+
<p>
1013+
This value provides an opaque state that will be passed back to this helper
1014+
if it is called again. Each different credential helper may specify this
1015+
once. The value should include a prefix unique to the credential helper and
1016+
should ignore values that don&#8217;t match its prefix.
1017+
</p>
1018+
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
1019+
provided on input.</p></div>
1020+
</dd>
1021+
<dt class="hdlist1">
1022+
<code>continue</code>
1023+
</dt>
1024+
<dd>
1025+
<p>
1026+
This is a boolean value, which, if enabled, indicates that this
1027+
authentication is a non-final part of a multistage authentication step. This
1028+
is common in protocols such as NTLM and Kerberos, where two rounds of client
1029+
authentication are required, and setting this flag allows the credential
1030+
helper to implement the multistage authentication step. This flag should
1031+
only be sent if a further stage is required; that is, if another round of
1032+
authentication is expected.
1033+
</p>
1034+
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
1035+
provided on input. This attribute is <em>one-way</em> from a credential helper to
1036+
pass information to Git (or other programs invoking <code>git credential</code>).</p></div>
1037+
</dd>
1038+
<dt class="hdlist1">
9611039
<code>wwwauth[]</code>
9621040
</dt>
9631041
<dd>
@@ -971,8 +1049,47 @@ <h2 id="IOFMT">INPUT/OUTPUT FORMAT</h2>
9711049
they appear in the HTTP response. This attribute is <em>one-way</em> from Git
9721050
to pass additional information to credential helpers.</p></div>
9731051
</dd>
1052+
<dt class="hdlist1">
1053+
<code>capability[]</code>
1054+
</dt>
1055+
<dd>
1056+
<p>
1057+
This signals that Git, or the helper, as appropriate, supports the capability
1058+
in question. This can be used to provide better, more specific data as part
1059+
of the protocol. A <code>capability[]</code> directive must precede any value depending
1060+
on it and these directives <em>should</em> be the first item announced in the
1061+
protocol.
1062+
</p>
1063+
<div class="paragraph"><p>There are two currently supported capabilities. The first is <code>authtype</code>, which
1064+
indicates that the <code>authtype</code>, <code>credential</code>, and <code>ephemeral</code> values are
1065+
understood. The second is <code>state</code>, which indicates that the <code>state[]</code> and
1066+
<code>continue</code> values are understood.</p></div>
1067+
<div class="paragraph"><p>It is not obligatory to use the additional features just because the capability
1068+
is supported, but they should not be provided without the capability.</p></div>
1069+
</dd>
9741070
</dl></div>
975-
<div class="paragraph"><p>Unrecognised attributes are silently discarded.</p></div>
1071+
<div class="paragraph"><p>Unrecognised attributes and capabilities are silently discarded.</p></div>
1072+
</div>
1073+
</div>
1074+
<div class="sect1">
1075+
<h2 id="CAPA-IOFMT">CAPABILITY INPUT/OUTPUT FORMAT</h2>
1076+
<div class="sectionbody">
1077+
<div class="paragraph"><p>For <code>git credential capability</code>, the format is slightly different. First, a
1078+
<code>version 0</code> announcement is made to indicate the current version of the
1079+
protocol, and then each capability is announced with a line like <code>capability
1080+
authtype</code>. Credential helpers may also implement this format, again with the
1081+
<code>capability</code> argument. Additional lines may be added in the future; callers
1082+
should ignore lines which they don&#8217;t understand.</p></div>
1083+
<div class="paragraph"><p>Because this is a new part of the credential helper protocol, older versions of
1084+
Git, as well as some credential helpers, may not support it. If a non-zero
1085+
exit status is received, or if the first line doesn&#8217;t start with the word
1086+
<code>version</code> and a space, callers should assume that no capabilities are supported.</p></div>
1087+
<div class="paragraph"><p>The intention of this format is to differentiate it from the credential output
1088+
in an unambiguous way. It is possible to use very simple credential helpers
1089+
(e.g., inline shell scripts) which always produce identical output. Using a
1090+
distinct format allows users to continue to use this syntax without having to
1091+
worry about correctly implementing capability advertisements or accidentally
1092+
confusing callers querying for capabilities.</p></div>
9761093
</div>
9771094
</div>
9781095
<div class="sect1">
@@ -986,7 +1103,7 @@ <h2 id="_git">GIT</h2>
9861103
<div id="footer">
9871104
<div id="footer-text">
9881105
Last updated
989-
2023-10-23 14:43:46 PDT
1106+
2024-05-13 12:26:56 PDT
9901107
</div>
9911108
</div>
9921109
</body>

0 commit comments

Comments
 (0)