Skip to content

Commit 779de2b

Browse files
committed
Autogenerated HTML docs for v2.49.0-634-g8613c
1 parent 63a3a57 commit 779de2b

File tree

7 files changed

+178
-33
lines changed

7 files changed

+178
-33
lines changed

RelNotes/2.50.0.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,13 @@ UI, Workflows & Features
6565
* Make repository clean-up tasks "gc" can do available to "git
6666
maintenance" front-end.
6767

68+
* Bundle-URI feature did not use refs recorded in the bundle other
69+
than normal branches as anchoring points to optimize the follow-up
70+
fetch during "git clone"; now it is told to utilize all.
71+
72+
* The `send-email` documentation has been updated with OAuth2.0
73+
related examples.
74+
6875

6976
Performance, Internal Implementation, Development Support etc.
7077
--------------------------------------------------------------
@@ -148,6 +155,8 @@ Performance, Internal Implementation, Development Support etc.
148155
149156
* Further code clean-up in the object-store layer.
150157
158+
* Build performance fix.
159+
151160
152161
Fixes since v2.49
153162
-----------------
@@ -294,6 +303,9 @@ Fixes since v2.49
294303
derived systems use different errno, which has been worked around.
295304
(merge f47bcc3413 cf/wrapper-bsd-eloop later to maint).
296305

306+
* Use-after-free fix in the sequencer.
307+
(merge 5dbaec628d pw/sequencer-reflog-use-after-free later to maint).
308+
297309
* Other code cleanup, docfix, build fix, etc.
298310
(merge 227c4f33a0 ja/doc-block-delimiter-markup-fix later to maint).
299311
(merge 2bfd3b3685 ab/decorate-code-cleanup later to maint).
@@ -321,3 +333,6 @@ Fixes since v2.49
321333
(merge 42cf4ac552 ps/ci-resurrect-p4-on-github later to maint).
322334
(merge 104add8368 js/diff-codeql-false-positive-workaround later to maint).
323335
(merge f62977b93c en/get-tree-entry-doc later to maint).
336+
(merge e5dd0a05ed ly/am-split-stgit-leakfix later to maint).
337+
(merge bac220e154 rc/t1001-test-path-is-file later to maint).
338+
(merge 91db6c735d ly/reftable-writer-leakfix later to maint).

git-send-email.adoc

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -509,12 +509,12 @@ include::includes/cmd-config-section-all.adoc[]
509509

510510
include::config/sendemail.adoc[]
511511

512-
EXAMPLES
513-
--------
514-
Use gmail as the smtp server
512+
EXAMPLES OF SMTP SERVERS
513+
------------------------
514+
Use Gmail as the SMTP Server
515515
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
516-
To use 'git send-email' to send your patches through the GMail SMTP server,
517-
edit ~/.gitconfig to specify your account settings:
516+
To use `git send-email` to send your patches through the Gmail SMTP server,
517+
edit `~/.gitconfig` to specify your account settings:
518518

519519
----
520520
[sendemail]
@@ -528,6 +528,41 @@ If you have multi-factor authentication set up on your Gmail account, you can
528528
generate an app-specific password for use with 'git send-email'. Visit
529529
https://security.google.com/settings/security/apppasswords to create it.
530530

531+
You can also use OAuth2.0 authentication with Gmail. `OAUTHBEARER` and
532+
`XOAUTH2` are common methods used for this type of authentication. Gmail
533+
supports both of them. As an example, if you want to use `OAUTHBEARER`, edit
534+
your `~/.gitconfig` file and add `smtpAuth = OAUTHBEARER` to your account
535+
settings:
536+
537+
----
538+
[sendemail]
539+
smtpEncryption = tls
540+
smtpServer = smtp.gmail.com
541+
smtpUser = [email protected]
542+
smtpServerPort = 587
543+
smtpAuth = OAUTHBEARER
544+
----
545+
546+
Use Microsoft Outlook as the SMTP Server
547+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
548+
Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
549+
Therefore, OAuth2.0 authentication must be used for Outlook. Also, it only
550+
supports `XOAUTH2` authentication method.
551+
552+
Edit `~/.gitconfig` to specify your account settings for Outlook and use its
553+
SMTP server with `git send-email`:
554+
555+
----
556+
[sendemail]
557+
smtpEncryption = tls
558+
smtpServer = smtp.office365.com
559+
smtpUser = [email protected]
560+
smtpServerPort = 587
561+
smtpAuth = XOAUTH2
562+
----
563+
564+
SENDING PATCHES
565+
---------------
531566
Once your commits are ready to be sent to the mailing list, run the
532567
following commands:
533568

@@ -536,9 +571,25 @@ following commands:
536571
$ git send-email outgoing/*
537572

538573
The first time you run it, you will be prompted for your credentials. Enter the
539-
app-specific or your regular password as appropriate. If you have credential
540-
helper configured (see linkgit:git-credential[1]), the password will be saved in
541-
the credential store so you won't have to type it the next time.
574+
app-specific or your regular password as appropriate.
575+
576+
If you have a credential helper configured (see linkgit:git-credential[1]), the
577+
password will be saved in the credential store so you won't have to type it the
578+
next time.
579+
580+
If you are using OAuth2.0 authentication, you need to use an access token in
581+
place of a password when prompted. Various OAuth2.0 token generators are
582+
available online. Community maintained credential helpers for Gmail and Outlook
583+
are also available:
584+
585+
- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail]
586+
(cross platform, dedicated helper for authenticating Gmail accounts)
587+
588+
- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook]
589+
(cross platform, dedicated helper for authenticating Microsoft Outlook accounts)
590+
591+
You can also see linkgit:gitcredentials[7] for more OAuth based authentication
592+
helpers.
542593

543594
Note: the following core Perl modules that may be installed with your
544595
distribution of Perl are required:

git-send-email.html

Lines changed: 78 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1273,13 +1273,13 @@ <h2 id="_configuration">CONFIGURATION</h2>
12731273
</div>
12741274
</div>
12751275
<div class="sect1">
1276-
<h2 id="_examples">EXAMPLES</h2>
1276+
<h2 id="_examples_of_smtp_servers">EXAMPLES OF SMTP SERVERS</h2>
12771277
<div class="sectionbody">
12781278
<div class="sect2">
1279-
<h3 id="_use_gmail_as_the_smtp_server">Use gmail as the smtp server</h3>
1279+
<h3 id="_use_gmail_as_the_smtp_server">Use Gmail as the SMTP Server</h3>
12801280
<div class="paragraph">
1281-
<p>To use <em>git send-email</em> to send your patches through the GMail SMTP server,
1282-
edit ~/.gitconfig to specify your account settings:</p>
1281+
<p>To use <code>git</code> <code>send-email</code> to send your patches through the Gmail SMTP server,
1282+
edit <code>~/.gitconfig</code> to specify your account settings:</p>
12831283
</div>
12841284
<div class="listingblock">
12851285
<div class="content">
@@ -1296,6 +1296,51 @@ <h3 id="_use_gmail_as_the_smtp_server">Use gmail as the smtp server</h3>
12961296
<a href="https://security.google.com/settings/security/apppasswords" class="bare">https://security.google.com/settings/security/apppasswords</a> to create it.</p>
12971297
</div>
12981298
<div class="paragraph">
1299+
<p>You can also use OAuth2.0 authentication with Gmail. <code>OAUTHBEARER</code> and
1300+
<code>XOAUTH2</code> are common methods used for this type of authentication. Gmail
1301+
supports both of them. As an example, if you want to use <code>OAUTHBEARER</code>, edit
1302+
your <code>~/.gitconfig</code> file and add <code>smtpAuth</code> <code>=</code> <code>OAUTHBEARER</code> to your account
1303+
settings:</p>
1304+
</div>
1305+
<div class="listingblock">
1306+
<div class="content">
1307+
<pre>[sendemail]
1308+
smtpEncryption = tls
1309+
smtpServer = smtp.gmail.com
1310+
smtpUser = [email protected]
1311+
smtpServerPort = 587
1312+
smtpAuth = OAUTHBEARER</pre>
1313+
</div>
1314+
</div>
1315+
</div>
1316+
<div class="sect2">
1317+
<h3 id="_use_microsoft_outlook_as_the_smtp_server">Use Microsoft Outlook as the SMTP Server</h3>
1318+
<div class="paragraph">
1319+
<p>Unlike Gmail, Microsoft Outlook no longer supports app-specific passwords.
1320+
Therefore, OAuth2.0 authentication must be used for Outlook. Also, it only
1321+
supports <code>XOAUTH2</code> authentication method.</p>
1322+
</div>
1323+
<div class="paragraph">
1324+
<p>Edit <code>~/.gitconfig</code> to specify your account settings for Outlook and use its
1325+
SMTP server with <code>git</code> <code>send-email</code>:</p>
1326+
</div>
1327+
<div class="listingblock">
1328+
<div class="content">
1329+
<pre>[sendemail]
1330+
smtpEncryption = tls
1331+
smtpServer = smtp.office365.com
1332+
smtpUser = [email protected]
1333+
smtpServerPort = 587
1334+
smtpAuth = XOAUTH2</pre>
1335+
</div>
1336+
</div>
1337+
</div>
1338+
</div>
1339+
</div>
1340+
<div class="sect1">
1341+
<h2 id="_sending_patches">SENDING PATCHES</h2>
1342+
<div class="sectionbody">
1343+
<div class="paragraph">
12991344
<p>Once your commits are ready to be sent to the mailing list, run the
13001345
following commands:</p>
13011346
</div>
@@ -1308,9 +1353,34 @@ <h3 id="_use_gmail_as_the_smtp_server">Use gmail as the smtp server</h3>
13081353
</div>
13091354
<div class="paragraph">
13101355
<p>The first time you run it, you will be prompted for your credentials. Enter the
1311-
app-specific or your regular password as appropriate. If you have credential
1312-
helper configured (see <a href="git-credential.html">git-credential(1)</a>), the password will be saved in
1313-
the credential store so you won&#8217;t have to type it the next time.</p>
1356+
app-specific or your regular password as appropriate.</p>
1357+
</div>
1358+
<div class="paragraph">
1359+
<p>If you have a credential helper configured (see <a href="git-credential.html">git-credential(1)</a>), the
1360+
password will be saved in the credential store so you won&#8217;t have to type it the
1361+
next time.</p>
1362+
</div>
1363+
<div class="paragraph">
1364+
<p>If you are using OAuth2.0 authentication, you need to use an access token in
1365+
place of a password when prompted. Various OAuth2.0 token generators are
1366+
available online. Community maintained credential helpers for Gmail and Outlook
1367+
are also available:</p>
1368+
</div>
1369+
<div class="ulist">
1370+
<ul>
1371+
<li>
1372+
<p><a href="https://github.com/AdityaGarg8/git-credential-email">git-credential-gmail</a>
1373+
(cross platform, dedicated helper for authenticating Gmail accounts)</p>
1374+
</li>
1375+
<li>
1376+
<p><a href="https://github.com/AdityaGarg8/git-credential-email">git-credential-outlook</a>
1377+
(cross platform, dedicated helper for authenticating Microsoft Outlook accounts)</p>
1378+
</li>
1379+
</ul>
1380+
</div>
1381+
<div class="paragraph">
1382+
<p>You can also see <a href="gitcredentials.html">gitcredentials(7)</a> for more OAuth based authentication
1383+
helpers.</p>
13141384
</div>
13151385
<div class="paragraph">
13161386
<p>Note: the following core Perl modules that may be installed with your
@@ -1321,7 +1391,6 @@ <h3 id="_use_gmail_as_the_smtp_server">Use gmail as the smtp server</h3>
13211391
</div>
13221392
</div>
13231393
</div>
1324-
</div>
13251394
<div class="sect1">
13261395
<h2 id="_see_also">SEE ALSO</h2>
13271396
<div class="sectionbody">
@@ -1341,7 +1410,7 @@ <h2 id="_git">GIT</h2>
13411410
</div>
13421411
<div id="footer">
13431412
<div id="footer-text">
1344-
Last updated 2025-05-12 15:19:42 -0700
1413+
Last updated 2025-05-20 15:10:14 -0700
13451414
</div>
13461415
</div>
13471416
</body>

gitcredentials.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,10 @@ Popular helpers with OAuth support include:
133133

134134
- https://github.com/hickford/git-credential-oauth[git-credential-oauth] (cross platform, included in many Linux distributions)
135135

136+
- https://github.com/AdityaGarg8/git-credential-email[git-credential-gmail] (cross platform, dedicated helper to authenticate Gmail accounts for linkgit:git-send-email[1])
137+
138+
- https://github.com/AdityaGarg8/git-credential-email[git-credential-outlook] (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for linkgit:git-send-email[1])
139+
136140
CREDENTIAL CONTEXTS
137141
-------------------
138142

gitcredentials.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -638,6 +638,12 @@ <h3 id="_oauth">OAuth</h3>
638638
<li>
639639
<p><a href="https://github.com/hickford/git-credential-oauth">git-credential-oauth</a> (cross platform, included in many Linux distributions)</p>
640640
</li>
641+
<li>
642+
<p><a href="https://github.com/AdityaGarg8/git-credential-email">git-credential-gmail</a> (cross platform, dedicated helper to authenticate Gmail accounts for <a href="git-send-email.html">git-send-email(1)</a>)</p>
643+
</li>
644+
<li>
645+
<p><a href="https://github.com/AdityaGarg8/git-credential-email">git-credential-outlook</a> (cross platform, dedicated helper to authenticate Microsoft Outlook accounts for <a href="git-send-email.html">git-send-email(1)</a>)</p>
646+
</li>
641647
</ul>
642648
</div>
643649
</div>
@@ -899,7 +905,7 @@ <h2 id="_git">GIT</h2>
899905
</div>
900906
<div id="footer">
901907
<div id="footer-text">
902-
Last updated 2025-02-14 21:38:14 -0800
908+
Last updated 2025-05-20 15:10:14 -0700
903909
</div>
904910
</div>
905911
</body>

technical/bundle-uri.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,13 @@ will interact with bundle URIs according to the following flow:
232232
are present in the client repository. If some are missing, then the
233233
client delays unbundling until other bundles have been unbundled,
234234
making those OIDs present. When all required OIDs are present, the
235-
client unbundles that data using a refspec. The default refspec is
236-
`+refs/heads/*:refs/bundles/*`, but this can be configured. These refs
237-
are stored so that later `git fetch` negotiations can communicate each
238-
bundled ref as a `have`, reducing the size of the fetch over the Git
239-
protocol. To allow pruning refs from this ref namespace, Git may
240-
introduce a numbered namespace (such as `refs/bundles/<i>/*`) such that
241-
stale bundle refs can be deleted.
235+
client unbundles that data using a refspec. The refspec used is
236+
`+refs/*:refs/bundles/*`. These refs are stored so that later
237+
`git fetch` negotiations can communicate each bundled ref as a `have`,
238+
reducing the size of the fetch over the Git protocol. To allow pruning
239+
refs from this ref namespace, Git may introduce a numbered namespace
240+
(such as `refs/bundles/<i>/*`) such that stale bundle refs can be
241+
deleted.
242242

243243
3. If the file is instead a bundle list, then the client inspects the
244244
`bundle.mode` to see if the list is of the `all` or `any` form.

technical/bundle-uri.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -755,13 +755,13 @@ <h2 id="_cloning_with_bundle_uris">Cloning with Bundle URIs</h2>
755755
are present in the client repository. If some are missing, then the
756756
client delays unbundling until other bundles have been unbundled,
757757
making those OIDs present. When all required OIDs are present, the
758-
client unbundles that data using a refspec. The default refspec is
759-
<code>+refs/heads/*:refs/bundles/*</code>, but this can be configured. These refs
760-
are stored so that later <code>git</code> <code>fetch</code> negotiations can communicate each
761-
bundled ref as a <code>have</code>, reducing the size of the fetch over the Git
762-
protocol. To allow pruning refs from this ref namespace, Git may
763-
introduce a numbered namespace (such as <code>refs/bundles/</code><em>&lt;i&gt;</em><code>/*</code>) such that
764-
stale bundle refs can be deleted.</p>
758+
client unbundles that data using a refspec. The refspec used is
759+
<code>+refs/*:refs/bundles/*</code>. These refs are stored so that later
760+
<code>git</code> <code>fetch</code> negotiations can communicate each bundled ref as a <code>have</code>,
761+
reducing the size of the fetch over the Git protocol. To allow pruning
762+
refs from this ref namespace, Git may introduce a numbered namespace
763+
(such as <code>refs/bundles/</code><em>&lt;i&gt;</em><code>/*</code>) such that stale bundle refs can be
764+
deleted.</p>
765765
</li>
766766
<li>
767767
<p>If the file is instead a bundle list, then the client inspects the
@@ -1218,7 +1218,7 @@ <h2 id="_see_also">See Also</h2>
12181218
</div>
12191219
<div id="footer">
12201220
<div id="footer-text">
1221-
Last updated 2025-02-14 21:38:14 -0800
1221+
Last updated 2025-05-20 15:10:14 -0700
12221222
</div>
12231223
</div>
12241224
</body>

0 commit comments

Comments
 (0)