Skip to content

Commit 82b343d

Browse files
committed
Autogenerated HTML docs for v2.44.0-478-g7774c
1 parent e990114 commit 82b343d

Some content is hidden

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

57 files changed

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

RelNotes/2.45.0.txt

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ UI, Workflows & Features
6060
* Hints that suggest what to do after resolving conflicts can now be
6161
squelched by disabling advice.mergeConflict.
6262

63+
* Allow git-cherry-pick(1) to automatically drop redundant commits via
64+
a new `--empty` option, similar to the `--empty` options for
65+
git-rebase(1) and git-am(1). Includes a soft deprecation of
66+
`--keep-redundant-commits` as well as some related docs changes and
67+
sequencer code cleanup.
68+
6369

6470
Performance, Internal Implementation, Development Support etc.
6571

@@ -118,6 +124,15 @@ Performance, Internal Implementation, Development Support etc.
118124
outside them, and document the best practice to help future
119125
developers.
120126

127+
* Introduce an experimental protocol for contributors to propose the
128+
topic description to be used in the "What's cooking" report, the
129+
merge commit message for the topic, and in the release notes and
130+
document it in the SubmittingPatches document.
131+
132+
* The t/README file now gives a hint on running individual tests in
133+
the "t/" directory with "make t<num>-*.sh t<num>-*.sh".
134+
(merge 8d383806fc pb/test-scripts-are-build-targets later to maint).
135+
121136

122137
Fixes since v2.44
123138
-----------------
@@ -270,6 +285,16 @@ Fixes since v2.44
270285
files left, which has been corrected.
271286
(merge 0068aa7946 ps/reftable-unit-test-nfs-workaround later to maint).
272287

288+
* The implementation and documentation of "object-format" option
289+
exchange between the Git itself and its remote helpers did not
290+
quite match, which has been corrected.
291+
292+
* The "--pretty=<shortHand>" option of the commands in the "git log"
293+
family, defined as "[pretty] shortHand = <expansion>" should have
294+
been looked up case insensitively, but was not, which has been
295+
corrected.
296+
(merge f999d5188b bl/pretty-shorthand-config-fix later to maint).
297+
273298
* Other code cleanup, docfix, build fix, etc.
274299
(merge f0e578c69c rs/use-xstrncmpz later to maint).
275300
(merge 83e6eb7d7a ba/credential-test-clean-fix later to maint).
@@ -292,3 +317,5 @@ Fixes since v2.44
292317
(merge ad538c61da jc/index-pack-fsck-levels later to maint).
293318
(merge 67471bc704 ja/doc-formatting-fix later to maint).
294319
(merge 86f9ce7dd6 bl/doc-config-fixes later to maint).
320+
(merge 0d527842b7 az/grep-group-error-message-update later to maint).
321+
(merge 7c43bdf07b rs/strbuf-expand-bad-format 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-01</span>
738+
<span id="revdate">2024-04-03</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

SubmittingPatches.html

Lines changed: 11 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>Submitting Patches</h1>
738-
<span id="revdate">2024-04-01</span>
738+
<span id="revdate">2024-04-03</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">
@@ -1259,6 +1259,15 @@ <h3 id="send-patches">Sending your patches.</h3>
12591259
an explanation of changes between each iteration can be kept in
12601260
Git-notes and inserted automatically following the three-dash
12611261
line via <code>git format-patch --notes</code>.</p></div>
1262+
<div class="paragraph" id="the-topic-summary"><p><strong>This is EXPERIMENTAL</strong>.</p></div>
1263+
<div class="paragraph"><p>When sending a topic, you can propose a one-paragraph summary that
1264+
should appear in the "What&#8217;s cooking" report when it is picked up to
1265+
explain the topic. If you choose to do so, please write a 2-5 line
1266+
paragraph that will fit well in our release notes (see many bulleted
1267+
entries in the Documentation/RelNotes/* files for examples), and make
1268+
it the first paragraph of the cover letter. For a single-patch
1269+
series, use the space between the three-dash line and the diffstat, as
1270+
described earlier.</p></div>
12621271
<div class="paragraph" id="attachment"><p>Do not attach the patch as a MIME attachment, compressed or not.
12631272
Do not let your e-mail client send quoted-printable. Do not let
12641273
your e-mail client send format=flowed which would destroy
@@ -1546,7 +1555,7 @@ <h3 id="_gnus">Gnus</h3>
15461555
<div id="footer">
15471556
<div id="footer-text">
15481557
Last updated
1549-
2024-02-23 07:31:12 PST
1558+
2024-04-03 15:35:56 PDT
15501559
</div>
15511560
</div>
15521561
</body>

SubmittingPatches.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,18 @@ an explanation of changes between each iteration can be kept in
459459
Git-notes and inserted automatically following the three-dash
460460
line via `git format-patch --notes`.
461461

462+
[[the-topic-summary]]
463+
*This is EXPERIMENTAL*.
464+
465+
When sending a topic, you can propose a one-paragraph summary that
466+
should appear in the "What's cooking" report when it is picked up to
467+
explain the topic. If you choose to do so, please write a 2-5 line
468+
paragraph that will fit well in our release notes (see many bulleted
469+
entries in the Documentation/RelNotes/* files for examples), and make
470+
it the first paragraph of the cover letter. For a single-patch
471+
series, use the space between the three-dash line and the diffstat, as
472+
described earlier.
473+
462474
[[attachment]]
463475
Do not attach the patch as a MIME attachment, compressed or not.
464476
Do not let your e-mail client send quoted-printable. Do not let

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

git-am.html

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -860,17 +860,43 @@ <h2 id="_options">OPTIONS</h2>
860860
</p>
861861
</dd>
862862
<dt class="hdlist1">
863-
--empty=(stop|drop|keep)
863+
--empty=(drop|keep|stop)
864864
</dt>
865865
<dd>
866866
<p>
867-
By default, or when the option is set to <em>stop</em>, the command
868-
errors out on an input e-mail message lacking a patch
869-
and stops in the middle of the current am session. When this
870-
option is set to <em>drop</em>, skip such an e-mail message instead.
871-
When this option is set to <em>keep</em>, create an empty commit,
872-
recording the contents of the e-mail message as its log.
867+
How to handle an e-mail message lacking a patch:
873868
</p>
869+
<div class="openblock">
870+
<div class="content">
871+
<div class="dlist"><dl>
872+
<dt class="hdlist1">
873+
<code>drop</code>
874+
</dt>
875+
<dd>
876+
<p>
877+
The e-mail message will be skipped.
878+
</p>
879+
</dd>
880+
<dt class="hdlist1">
881+
<code>keep</code>
882+
</dt>
883+
<dd>
884+
<p>
885+
An empty commit will be created, with the contents of the e-mail
886+
message as its log.
887+
</p>
888+
</dd>
889+
<dt class="hdlist1">
890+
<code>stop</code>
891+
</dt>
892+
<dd>
893+
<p>
894+
The command will fail, stopping in the middle of the current <code>am</code>
895+
session. This is the default behavior.
896+
</p>
897+
</dd>
898+
</dl></div>
899+
</div></div>
874900
</dd>
875901
<dt class="hdlist1">
876902
-m
@@ -1291,7 +1317,7 @@ <h2 id="_git">GIT</h2>
12911317
<div id="footer">
12921318
<div id="footer-text">
12931319
Last updated
1294-
2024-02-27 16:31:29 PST
1320+
2024-04-03 15:35:56 PDT
12951321
</div>
12961322
</div>
12971323
</body>

git-am.txt

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,19 @@ OPTIONS
6666
--quoted-cr=<action>::
6767
This flag will be passed down to 'git mailinfo' (see linkgit:git-mailinfo[1]).
6868

69-
--empty=(stop|drop|keep)::
70-
By default, or when the option is set to 'stop', the command
71-
errors out on an input e-mail message lacking a patch
72-
and stops in the middle of the current am session. When this
73-
option is set to 'drop', skip such an e-mail message instead.
74-
When this option is set to 'keep', create an empty commit,
75-
recording the contents of the e-mail message as its log.
69+
--empty=(drop|keep|stop)::
70+
How to handle an e-mail message lacking a patch:
71+
+
72+
--
73+
`drop`;;
74+
The e-mail message will be skipped.
75+
`keep`;;
76+
An empty commit will be created, with the contents of the e-mail
77+
message as its log.
78+
`stop`;;
79+
The command will fail, stopping in the middle of the current `am`
80+
session. This is the default behavior.
81+
--
7682

7783
-m::
7884
--message-id::

git-cherry-pick.html

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -962,8 +962,8 @@ <h2 id="_options">OPTIONS</h2>
962962
even without this option. Note also, that use of this option only
963963
keeps commits that were initially empty (i.e. the commit recorded the
964964
same tree as its parent). Commits which are made empty due to a
965-
previous commit are dropped. To force the inclusion of those commits
966-
use <code>--keep-redundant-commits</code>.
965+
previous commit will cause the cherry-pick to fail. To force the
966+
inclusion of those commits, use <code>--empty=keep</code>.
967967
</p>
968968
</dd>
969969
<dt class="hdlist1">
@@ -977,15 +977,54 @@ <h2 id="_options">OPTIONS</h2>
977977
</p>
978978
</dd>
979979
<dt class="hdlist1">
980+
--empty=(drop|keep|stop)
981+
</dt>
982+
<dd>
983+
<p>
984+
How to handle commits being cherry-picked that are redundant with
985+
changes already in the current history.
986+
</p>
987+
<div class="openblock">
988+
<div class="content">
989+
<div class="dlist"><dl>
990+
<dt class="hdlist1">
991+
<code>drop</code>
992+
</dt>
993+
<dd>
994+
<p>
995+
The commit will be dropped.
996+
</p>
997+
</dd>
998+
<dt class="hdlist1">
999+
<code>keep</code>
1000+
</dt>
1001+
<dd>
1002+
<p>
1003+
The commit will be kept. Implies <code>--allow-empty</code>.
1004+
</p>
1005+
</dd>
1006+
<dt class="hdlist1">
1007+
<code>stop</code>
1008+
</dt>
1009+
<dd>
1010+
<p>
1011+
The cherry-pick will stop when the commit is applied, allowing
1012+
you to examine the commit. This is the default behavior.
1013+
</p>
1014+
</dd>
1015+
</dl></div>
1016+
</div></div>
1017+
<div class="paragraph"><p>Note that <code>--empty=drop</code> and <code>--empty=stop</code> only specify how to handle a
1018+
commit that was not initially empty, but rather became empty due to a previous
1019+
commit. Commits that were initially empty will still cause the cherry-pick to
1020+
fail unless one of <code>--empty=keep</code> or <code>--allow-empty</code> are specified.</p></div>
1021+
</dd>
1022+
<dt class="hdlist1">
9801023
--keep-redundant-commits
9811024
</dt>
9821025
<dd>
9831026
<p>
984-
If a commit being cherry picked duplicates a commit already in the
985-
current history, it will become empty. By default these
986-
redundant commits cause <code>cherry-pick</code> to stop so the user can
987-
examine the commit. This option overrides that behavior and
988-
creates an empty commit object. Implies <code>--allow-empty</code>.
1027+
Deprecated synonym for <code>--empty=keep</code>.
9891028
</p>
9901029
</dd>
9911030
<dt class="hdlist1">
@@ -1217,7 +1256,7 @@ <h2 id="_git">GIT</h2>
12171256
<div id="footer">
12181257
<div id="footer-text">
12191258
Last updated
1220-
2023-01-21 17:52:14 PST
1259+
2024-04-03 15:35:56 PDT
12211260
</div>
12221261
</div>
12231262
</body>

git-cherry-pick.txt

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -131,20 +131,36 @@ effect to your index in a row.
131131
even without this option. Note also, that use of this option only
132132
keeps commits that were initially empty (i.e. the commit recorded the
133133
same tree as its parent). Commits which are made empty due to a
134-
previous commit are dropped. To force the inclusion of those commits
135-
use `--keep-redundant-commits`.
134+
previous commit will cause the cherry-pick to fail. To force the
135+
inclusion of those commits, use `--empty=keep`.
136136

137137
--allow-empty-message::
138138
By default, cherry-picking a commit with an empty message will fail.
139139
This option overrides that behavior, allowing commits with empty
140140
messages to be cherry picked.
141141

142+
--empty=(drop|keep|stop)::
143+
How to handle commits being cherry-picked that are redundant with
144+
changes already in the current history.
145+
+
146+
--
147+
`drop`;;
148+
The commit will be dropped.
149+
`keep`;;
150+
The commit will be kept. Implies `--allow-empty`.
151+
`stop`;;
152+
The cherry-pick will stop when the commit is applied, allowing
153+
you to examine the commit. This is the default behavior.
154+
--
155+
+
156+
Note that `--empty=drop` and `--empty=stop` only specify how to handle a
157+
commit that was not initially empty, but rather became empty due to a previous
158+
commit. Commits that were initially empty will still cause the cherry-pick to
159+
fail unless one of `--empty=keep` or `--allow-empty` are specified.
160+
+
161+
142162
--keep-redundant-commits::
143-
If a commit being cherry picked duplicates a commit already in the
144-
current history, it will become empty. By default these
145-
redundant commits cause `cherry-pick` to stop so the user can
146-
examine the commit. This option overrides that behavior and
147-
creates an empty commit object. Implies `--allow-empty`.
163+
Deprecated synonym for `--empty=keep`.
148164

149165
--strategy=<strategy>::
150166
Use the given merge strategy. Should only be used once.

git-config.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6829,7 +6829,7 @@ <h3 id="_variables">Variables</h3>
68296829
</dt>
68306830
<dd>
68316831
<p>
6832-
If set to true, fall back to git grep --no-index if git grep
6832+
If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
68336833
is executed outside of a git repository. Defaults to false.
68346834
</p>
68356835
</dd>

0 commit comments

Comments
 (0)