Skip to content

Commit a45cb07

Browse files
gitstergitster
committed
Autogenerated HTML docs for v2.48.1-91-g5f8f7
1 parent e480a99 commit a45cb07

7 files changed

+178
-31
lines changed

‎RelNotes/2.49.0.txt

+22
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,30 @@ Fixes since v2.48
4848
diagnosed as an error, which has been corrected.
4949
(merge ca7158076f jt/fsck-skiplist-parse-fix later to maint).
5050

51+
* Extended SHA-1 expression parser did not work well when a branch
52+
with an unusual name (e.g. "foo{bar") is involved.
53+
(merge 191f0c8db2 en/object-name-with-funny-refname-fix later to maint).
54+
55+
* The meson build procedure looked for the 'version-def.h' file in a
56+
wrong directory, which has been corrected.
57+
(merge 4771501c0a tc/meson-use-our-version-def-h later to maint).
58+
59+
* The meson build procedure for Documentation/technical/ hierarchy was
60+
missing necessary dependencies, which has been corrected.
61+
(merge 1dca492edd sj/meson-doc-technical-dependency-fix later to maint).
62+
63+
* The "instaweb" bound only to local IP address without "--local" and
64+
to all addresses with "--local", which was the other way around, when
65+
using Python's http.server class, which has been corrected.
66+
(merge 76baf97fa1 ak/instaweb-python-port-binding-fix later to maint).
67+
68+
* Document that it is insecure to use Personal Access Tokens, which
69+
some hosting providers take as username/password, embedded in URLs.
70+
(merge a90ff409f0 mh/doc-credential-helpers-with-pat later to maint).
71+
5172
* Other code cleanup, docfix, build fix, etc.
5273
(merge ddb5287894 jk/t7407-use-test-grep later to maint).
5374
(merge 21e1b44865 aj/difftool-config-doc-fix later to maint).
5475
(merge 6a63995335 mh/gitattr-doc-markup-fix later to maint).
5576
(merge 43850dcf9c sk/unit-test-hash later to maint).
77+
(merge 4ad47d2de3 jc/cli-doc-option-and-config later to maint).

‎git-credential-cache.html

+23-1
Original file line numberDiff line numberDiff line change
@@ -545,6 +545,28 @@ <h2 id="_examples">EXAMPLES</h2>
545545
</div>
546546
</div>
547547
<div class="sect1">
548+
<h2 id="_personal_access_tokens">PERSONAL ACCESS TOKENS</h2>
549+
<div class="sectionbody">
550+
<div class="paragraph">
551+
<p>Some remotes accept personal access tokens, which are randomly
552+
generated and hard to memorise. They typically have a lifetime of weeks
553+
or months.</p>
554+
</div>
555+
<div class="paragraph">
556+
<p>git-credential-cache is inherently unsuitable for persistent storage of
557+
personal access tokens. The credential will be forgotten after the cache
558+
timeout. Even if you configure a long timeout, credentials will be
559+
forgotten if the daemon dies.</p>
560+
</div>
561+
<div class="paragraph">
562+
<p>To avoid frequently regenerating personal access tokens, configure a
563+
credential helper with persistent storage. Alternatively, configure an
564+
OAuth credential helper to generate credentials automatically. See
565+
<a href="gitcredentials.html">gitcredentials(7)</a>, sections "Available helpers" and "OAuth".</p>
566+
</div>
567+
</div>
568+
</div>
569+
<div class="sect1">
548570
<h2 id="_git">GIT</h2>
549571
<div class="sectionbody">
550572
<div class="paragraph">
@@ -555,7 +577,7 @@ <h2 id="_git">GIT</h2>
555577
</div>
556578
<div id="footer">
557579
<div id="footer-text">
558-
Last updated 2023-10-23 14:43:46 -0700
580+
Last updated 2025-01-24 09:50:22 -0800
559581
</div>
560582
</div>
561583
</body>

‎git-credential-cache.txt

+17
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,23 @@ variable (this example increases the cache time to 1 hour):
7878
$ git config credential.helper 'cache --timeout=3600'
7979
-------------------------------------------------------
8080

81+
PERSONAL ACCESS TOKENS
82+
----------------------
83+
84+
Some remotes accept personal access tokens, which are randomly
85+
generated and hard to memorise. They typically have a lifetime of weeks
86+
or months.
87+
88+
git-credential-cache is inherently unsuitable for persistent storage of
89+
personal access tokens. The credential will be forgotten after the cache
90+
timeout. Even if you configure a long timeout, credentials will be
91+
forgotten if the daemon dies.
92+
93+
To avoid frequently regenerating personal access tokens, configure a
94+
credential helper with persistent storage. Alternatively, configure an
95+
OAuth credential helper to generate credentials automatically. See
96+
linkgit:gitcredentials[7], sections "Available helpers" and "OAuth".
97+
8198
GIT
8299
---
83100
Part of the linkgit:git[1] suite

‎gitcli.html

+19-1
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,24 @@ <h3 id="_negating_options">Negating options</h3>
646646
</div>
647647
</div>
648648
<div class="sect2">
649+
<h3 id="_options_trump_configuration_and_environment">Options trump configuration and environment</h3>
650+
<div class="paragraph">
651+
<p>When there is a configuration variable or an environment variable
652+
that tweak the behaviour of an aspect of a Git command, and also a
653+
command line option that tweaks the same, the command line option
654+
overrides what the configuration and/or environment variable say.</p>
655+
</div>
656+
<div class="paragraph">
657+
<p>For example, the <code>user.name</code> configuration variable is used to
658+
specify the human-readable name used by the <code>git</code> <code>commit</code> command to
659+
record the author and the committer name in a newly created commit.
660+
The <code>GIT_AUTHOR_NAME</code> environment variable, if set, takes precedence
661+
when deciding what author name to record. The <code>--author=</code><em>&lt;author&gt;</em>
662+
command line option of the <code>git</code> <code>commit</code> command, when given, takes
663+
precedence over these two sources of information.</p>
664+
</div>
665+
</div>
666+
<div class="sect2">
649667
<h3 id="_aggregating_short_options">Aggregating short options</h3>
650668
<div class="paragraph">
651669
<p>Commands that support the enhanced option parser allow you to aggregate short
@@ -770,7 +788,7 @@ <h2 id="_git">GIT</h2>
770788
</div>
771789
<div id="footer">
772790
<div id="footer-text">
773-
Last updated 2025-01-06 10:22:55 -0800
791+
Last updated 2025-01-24 09:50:22 -0800
774792
</div>
775793
</div>
776794
</body>

‎gitcli.txt

+17
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,23 @@ can use `--no-track` to override that behaviour. The same goes for `--color`
161161
and `--no-color`.
162162

163163

164+
Options trump configuration and environment
165+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166+
167+
When there is a configuration variable or an environment variable
168+
that tweak the behaviour of an aspect of a Git command, and also a
169+
command line option that tweaks the same, the command line option
170+
overrides what the configuration and/or environment variable say.
171+
172+
For example, the `user.name` configuration variable is used to
173+
specify the human-readable name used by the `git commit` command to
174+
record the author and the committer name in a newly created commit.
175+
The `GIT_AUTHOR_NAME` environment variable, if set, takes precedence
176+
when deciding what author name to record. The `--author=<author>`
177+
command line option of the `git commit` command, when given, takes
178+
precedence over these two sources of information.
179+
180+
164181
Aggregating short options
165182
~~~~~~~~~~~~~~~~~~~~~~~~~
166183
Commands that support the enhanced option parser allow you to aggregate short

‎gitcredentials.html

+51-17
Original file line numberDiff line numberDiff line change
@@ -537,22 +537,7 @@ <h2 id="_avoiding_repetition">AVOIDING REPETITION</h2>
537537
some API.</p>
538538
</div>
539539
<div class="paragraph">
540-
<p>To use a helper, you must first select one to use. Git currently
541-
includes the following helpers:</p>
542-
</div>
543-
<div class="dlist">
544-
<dl>
545-
<dt class="hdlist1">cache</dt>
546-
<dd>
547-
<p>Cache credentials in memory for a short period of time. See
548-
<a href="git-credential-cache.html">git-credential-cache(1)</a> for details.</p>
549-
</dd>
550-
<dt class="hdlist1">store</dt>
551-
<dd>
552-
<p>Store credentials indefinitely on disk. See
553-
<a href="git-credential-store.html">git-credential-store(1)</a> for details.</p>
554-
</dd>
555-
</dl>
540+
<p>To use a helper, you must first select one to use (see below for a list).</p>
556541
</div>
557542
<div class="paragraph">
558543
<p>You may also have third-party helpers installed; search for
@@ -593,6 +578,42 @@ <h2 id="_avoiding_repetition">AVOIDING REPETITION</h2>
593578
<div class="sect2">
594579
<h3 id="_available_helpers">Available helpers</h3>
595580
<div class="paragraph">
581+
<p>Git currently includes the following helpers:</p>
582+
</div>
583+
<div class="dlist">
584+
<dl>
585+
<dt class="hdlist1">cache</dt>
586+
<dd>
587+
<p>Cache credentials in memory for a short period of time. See
588+
<a href="git-credential-cache.html">git-credential-cache(1)</a> for details.</p>
589+
</dd>
590+
<dt class="hdlist1">store</dt>
591+
<dd>
592+
<p>Store credentials indefinitely on disk. See
593+
<a href="git-credential-store.html">git-credential-store(1)</a> for details.</p>
594+
</dd>
595+
</dl>
596+
</div>
597+
<div class="paragraph">
598+
<p>Popular helpers with secure persistent storage include:</p>
599+
</div>
600+
<div class="ulist">
601+
<ul>
602+
<li>
603+
<p>git-credential-libsecret (Linux)</p>
604+
</li>
605+
<li>
606+
<p>git-credential-osxkeychain (macOS)</p>
607+
</li>
608+
<li>
609+
<p>git-credential-wincred (Windows)</p>
610+
</li>
611+
<li>
612+
<p><a href="https://github.com/git-ecosystem/git-credential-manager">Git Credential Manager</a> (cross platform, included in Git for Windows)</p>
613+
</li>
614+
</ul>
615+
</div>
616+
<div class="paragraph">
596617
<p>The community maintains a comprehensive list of Git credential helpers at
597618
<a href="https://git-scm.com/doc/credential-helpers" class="bare">https://git-scm.com/doc/credential-helpers</a>.</p>
598619
</div>
@@ -605,6 +626,19 @@ <h3 id="_oauth">OAuth</h3>
605626
host. Subsequent authentication happens in the background. Many popular Git
606627
hosts support OAuth.</p>
607628
</div>
629+
<div class="paragraph">
630+
<p>Popular helpers with OAuth support include:</p>
631+
</div>
632+
<div class="ulist">
633+
<ul>
634+
<li>
635+
<p><a href="https://github.com/git-ecosystem/git-credential-manager">Git Credential Manager</a> (cross platform, included in Git for Windows)</p>
636+
</li>
637+
<li>
638+
<p><a href="https://github.com/hickford/git-credential-oauth">git-credential-oauth</a> (cross platform, included in many Linux distributions)</p>
639+
</li>
640+
</ul>
641+
</div>
608642
</div>
609643
</div>
610644
</div>
@@ -864,7 +898,7 @@ <h2 id="_git">GIT</h2>
864898
</div>
865899
<div id="footer">
866900
<div id="footer-text">
867-
Last updated 2024-12-10 04:07:44 -0800
901+
Last updated 2025-01-24 09:50:22 -0800
868902
</div>
869903
</div>
870904
</body>

‎gitcredentials.txt

+29-12
Original file line numberDiff line numberDiff line change
@@ -66,18 +66,7 @@ storage provided by the OS or other programs. Alternatively, a
6666
credential-generating helper might generate credentials for certain servers via
6767
some API.
6868

69-
To use a helper, you must first select one to use. Git currently
70-
includes the following helpers:
71-
72-
cache::
73-
74-
Cache credentials in memory for a short period of time. See
75-
linkgit:git-credential-cache[1] for details.
76-
77-
store::
78-
79-
Store credentials indefinitely on disk. See
80-
linkgit:git-credential-store[1] for details.
69+
To use a helper, you must first select one to use (see below for a list).
8170

8271
You may also have third-party helpers installed; search for
8372
`credential-*` in the output of `git help -a`, and consult the
@@ -106,6 +95,28 @@ $ git config --global credential.helper foo
10695

10796
=== Available helpers
10897

98+
Git currently includes the following helpers:
99+
100+
cache::
101+
102+
Cache credentials in memory for a short period of time. See
103+
linkgit:git-credential-cache[1] for details.
104+
105+
store::
106+
107+
Store credentials indefinitely on disk. See
108+
linkgit:git-credential-store[1] for details.
109+
110+
Popular helpers with secure persistent storage include:
111+
112+
- git-credential-libsecret (Linux)
113+
114+
- git-credential-osxkeychain (macOS)
115+
116+
- git-credential-wincred (Windows)
117+
118+
- https://github.com/git-ecosystem/git-credential-manager[Git Credential Manager] (cross platform, included in Git for Windows)
119+
109120
The community maintains a comprehensive list of Git credential helpers at
110121
https://git-scm.com/doc/credential-helpers.
111122

@@ -116,6 +127,12 @@ OAuth credential helper. Initial authentication opens a browser window to the
116127
host. Subsequent authentication happens in the background. Many popular Git
117128
hosts support OAuth.
118129

130+
Popular helpers with OAuth support include:
131+
132+
- https://github.com/git-ecosystem/git-credential-manager[Git Credential Manager] (cross platform, included in Git for Windows)
133+
134+
- https://github.com/hickford/git-credential-oauth[git-credential-oauth] (cross platform, included in many Linux distributions)
135+
119136
CREDENTIAL CONTEXTS
120137
-------------------
121138

0 commit comments

Comments
 (0)