Skip to content

Commit fd00376

Browse files
committed
Autogenerated HTML docs for v2.44.0-501-g19981d
1 parent 82b343d commit fd00376

Some content is hidden

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

47 files changed

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

RelNotes/2.45.0.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ UI, Workflows & Features
6666
`--keep-redundant-commits` as well as some related docs changes and
6767
sequencer code cleanup.
6868

69+
* "git config" learned "--comment=<message>" option to leave a
70+
comment immediately after the "variable = value" on the same line
71+
in the configuration file.
72+
73+
* core.commentChar used to be limited to a single byte, but has been
74+
updated to allow an arbitrary multi-byte sequence.
75+
6976

7077
Performance, Internal Implementation, Development Support etc.
7178

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

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

git-config.html

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -749,9 +749,9 @@ <h2>NAME</h2>
749749
<h2 id="_synopsis">SYNOPSIS</h2>
750750
<div class="sectionbody">
751751
<div class="verseblock">
752-
<pre class="content"><em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] &lt;name&gt; [&lt;value&gt; [&lt;value-pattern&gt;]]
753-
<em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] --add &lt;name&gt; &lt;value&gt;
754-
<em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--fixed-value] --replace-all &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]
752+
<pre class="content"><em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--comment=&lt;message&gt;] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] &lt;name&gt; [&lt;value&gt; [&lt;value-pattern&gt;]]
753+
<em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--comment=&lt;message&gt;] --add &lt;name&gt; &lt;value&gt;
754+
<em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--comment=&lt;message&gt;] [--fixed-value] --replace-all &lt;name&gt; &lt;value&gt; [&lt;value-pattern&gt;]
755755
<em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get &lt;name&gt; [&lt;value-pattern&gt;]
756756
<em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all &lt;name&gt; [&lt;value-pattern&gt;]
757757
<em>git config</em> [&lt;file-option&gt;] [--type=&lt;type&gt;] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp &lt;name-regex&gt; [&lt;value-pattern&gt;]
@@ -865,6 +865,25 @@ <h2 id="OPTIONS">OPTIONS</h2>
865865
</p>
866866
</dd>
867867
<dt class="hdlist1">
868+
--comment &lt;message&gt;
869+
</dt>
870+
<dd>
871+
<p>
872+
Append a comment at the end of new or modified lines.
873+
</p>
874+
<div class="literalblock">
875+
<div class="content">
876+
<pre><code>If _&lt;message&gt;_ begins with one or more whitespaces followed
877+
by "#", it is used as-is. If it begins with "#", a space is
878+
prepended before it is used. Otherwise, a string " # " (a
879+
space followed by a hash followed by a space) is prepended
880+
to it. And the resulting string is placed immediately after
881+
the value defined for the variable. The _&lt;message&gt;_ must
882+
not contain linefeed characters (no multi-line comments are
883+
permitted).</code></pre>
884+
</div></div>
885+
</dd>
886+
<dt class="hdlist1">
868887
--get
869888
</dt>
870889
<dd>
@@ -4222,15 +4241,33 @@ <h3 id="_variables">Variables</h3>
42224241
<dt class="hdlist1">
42234242
core.commentChar
42244243
</dt>
4244+
<dt class="hdlist1">
4245+
core.commentString
4246+
</dt>
42254247
<dd>
42264248
<p>
42274249
Commands such as <code>commit</code> and <code>tag</code> that let you edit
4228-
messages consider a line that begins with this ASCII character
4250+
messages consider a line that begins with this character
42294251
commented, and removes them after the editor returns
42304252
(default <em>#</em>).
42314253
</p>
42324254
<div class="paragraph"><p>If set to "auto", <code>git-commit</code> would select a character that is not
42334255
the beginning character of any line in existing commit messages.</p></div>
4256+
<div class="paragraph"><p>Note that these two variables are aliases of each other, and in modern
4257+
versions of Git you are free to use a string (e.g., <code>//</code> or <code>⁑⁕⁑</code>) with
4258+
<code>commentChar</code>. Versions of Git prior to v2.45.0 will ignore
4259+
<code>commentString</code> but will reject a value of <code>commentChar</code> that consists
4260+
of more than a single ASCII byte. If you plan to use your config with
4261+
older and newer versions of Git, you may want to specify both:</p></div>
4262+
<div class="literalblock">
4263+
<div class="content">
4264+
<pre><code>[core]
4265+
# single character for older versions
4266+
commentChar = "#"
4267+
# string for newer versions (which will override commentChar
4268+
# because it comes later in the file)
4269+
commentString = "//"</code></pre>
4270+
</div></div>
42344271
</dd>
42354272
<dt class="hdlist1">
42364273
core.filesRefLockTimeout
@@ -11978,7 +12015,7 @@ <h2 id="_git">GIT</h2>
1197812015
<div id="footer">
1197912016
<div id="footer-text">
1198012017
Last updated
11981-
2024-03-25 17:24:49 PDT
12018+
2024-04-05 11:03:41 PDT
1198212019
</div>
1198312020
</div>
1198412021
</body>

git-config.txt

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ git-config - Get and set repository or global options
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]]
13-
'git config' [<file-option>] [--type=<type>] --add <name> <value>
14-
'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all <name> <value> [<value-pattern>]
12+
'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]]
13+
'git config' [<file-option>] [--type=<type>] [--comment=<message>] --add <name> <value>
14+
'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] --replace-all <name> <value> [<value-pattern>]
1515
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get <name> [<value-pattern>]
1616
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all <name> [<value-pattern>]
1717
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp <name-regex> [<value-pattern>]
@@ -87,6 +87,18 @@ OPTIONS
8787
values. This is the same as providing '^$' as the `value-pattern`
8888
in `--replace-all`.
8989

90+
--comment <message>::
91+
Append a comment at the end of new or modified lines.
92+
93+
If _<message>_ begins with one or more whitespaces followed
94+
by "#", it is used as-is. If it begins with "#", a space is
95+
prepended before it is used. Otherwise, a string " # " (a
96+
space followed by a hash followed by a space) is prepended
97+
to it. And the resulting string is placed immediately after
98+
the value defined for the variable. The _<message>_ must
99+
not contain linefeed characters (no multi-line comments are
100+
permitted).
101+
90102
--get::
91103
Get the value for a given key (optionally filtered by a regex
92104
matching the value). Returns error code 1 if the key was not

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-04-03</span>
738+
<span id="revdate">2024-04-05</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-04-03 15:36:18 PDT
1041+
2024-04-05 11:04:44 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-04-03</span>
738+
<span id="revdate">2024-04-05</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-04-03 15:36:18 PDT
942+
2024-04-05 11:04:44 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-04-03</span>
738+
<span id="revdate">2024-04-05</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-04-03 15:36:18 PDT
1482+
2024-04-05 11:04:44 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-04-03</span>
738+
<span id="revdate">2024-04-05</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-04-03 15:36:17 PDT
867+
2024-04-05 11:04:40 PDT
868868
</div>
869869
</div>
870870
</body>

howto/rebase-from-internal-branch.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 rebase from an internal branch</h1>
738-
<span id="revdate">2024-04-03</span>
738+
<span id="revdate">2024-04-05</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -896,7 +896,7 @@ <h1>How to rebase from an internal branch</h1>
896896
<div id="footer">
897897
<div id="footer-text">
898898
Last updated
899-
2024-04-03 15:36:18 PDT
899+
2024-04-05 11:04:44 PDT
900900
</div>
901901
</div>
902902
</body>

howto/rebuild-from-update-hook.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 rebuild from update hook</h1>
738-
<span id="revdate">2024-04-03</span>
738+
<span id="revdate">2024-04-05</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -848,7 +848,7 @@ <h1>How to rebuild from update hook</h1>
848848
<div id="footer">
849849
<div id="footer-text">
850850
Last updated
851-
2024-04-03 15:36:18 PDT
851+
2024-04-05 11:04:43 PDT
852852
</div>
853853
</div>
854854
</body>

howto/recover-corrupted-blob-object.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 recover a corrupted blob object</h1>
738-
<span id="revdate">2024-04-03</span>
738+
<span id="revdate">2024-04-05</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -881,7 +881,7 @@ <h1>How to recover a corrupted blob object</h1>
881881
<div id="footer">
882882
<div id="footer-text">
883883
Last updated
884-
2024-04-03 15:36:18 PDT
884+
2024-04-05 11:04:43 PDT
885885
</div>
886886
</div>
887887
</body>

howto/recover-corrupted-object-harder.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 recover an object from scratch</h1>
738-
<span id="revdate">2024-04-03</span>
738+
<span id="revdate">2024-04-05</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -1190,7 +1190,7 @@ <h2 id="_the_adventure_continues_8230">The adventure continues&#8230;</h2>
11901190
<div id="footer">
11911191
<div id="footer-text">
11921192
Last updated
1193-
2024-04-03 15:36:18 PDT
1193+
2024-04-05 11:04:43 PDT
11941194
</div>
11951195
</div>
11961196
</body>

howto/revert-a-faulty-merge.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 revert a faulty merge</h1>
738-
<span id="revdate">2024-04-03</span>
738+
<span id="revdate">2024-04-05</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -1026,7 +1026,7 @@ <h1>How to revert a faulty merge</h1>
10261026
<div id="footer">
10271027
<div id="footer-text">
10281028
Last updated
1029-
2024-04-03 15:36:18 PDT
1029+
2024-04-05 11:04:43 PDT
10301030
</div>
10311031
</div>
10321032
</body>

howto/revert-branch-rebase.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 revert an existing commit</h1>
738-
<span id="revdate">2024-04-03</span>
738+
<span id="revdate">2024-04-05</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -908,7 +908,7 @@ <h1>How to revert an existing commit</h1>
908908
<div id="footer">
909909
<div id="footer-text">
910910
Last updated
911-
2024-04-03 15:36:17 PDT
911+
2024-04-05 11:04:40 PDT
912912
</div>
913913
</div>
914914
</body>

howto/separating-topic-branches.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 separate topic branches</h1>
738-
<span id="revdate">2024-04-03</span>
738+
<span id="revdate">2024-04-05</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -842,7 +842,7 @@ <h1>How to separate topic branches</h1>
842842
<div id="footer">
843843
<div id="footer-text">
844844
Last updated
845-
2024-04-03 15:36:18 PDT
845+
2024-04-05 11:04:43 PDT
846846
</div>
847847
</div>
848848
</body>

howto/setup-git-server-over-http.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 setup Git server over http</h1>
738-
<span id="revdate">2024-04-03</span>
738+
<span id="revdate">2024-04-05</span>
739739
</div>
740740
<div id="content">
741741
<div id="preamble">
@@ -1072,7 +1072,7 @@ <h2 id="_troubleshooting">Troubleshooting:</h2>
10721072
<div id="footer">
10731073
<div id="footer-text">
10741074
Last updated
1075-
2024-04-03 15:36:17 PDT
1075+
2024-04-05 11:04:42 PDT
10761076
</div>
10771077
</div>
10781078
</body>

0 commit comments

Comments
 (0)