Skip to content

Commit 1bfbb6c

Browse files
gitstergitster
committed
Autogenerated HTML docs for v2.45.1-313-g3a57a
1 parent d414f4c commit 1bfbb6c

Some content is hidden

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

59 files changed

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

‎RelNotes/2.46.0.txt

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ UI, Workflows & Features
4242

4343
* The trailer API has been reshuffled a bit.
4444

45+
* Terminology to call various ref-like things are getting
46+
straightened out.
47+
48+
* The command line completion script (in contrib/) has been adjusted
49+
to the recent update to "git config" that adopted subcommand based
50+
UI.
51+
4552

4653
Performance, Internal Implementation, Development Support etc.
4754

@@ -76,6 +83,19 @@ Performance, Internal Implementation, Development Support etc.
7683
primary ref_store by forcing the callers to pass a ref_store as an
7784
argument.
7885

86+
* Code clean-up to reduce inter-function communication inside
87+
builtin/config.c done via the use of global variables.
88+
89+
* The pack bitmap code saw some clean-up to prepare for a follow-up topic.
90+
(merge 85f360fee5 tb/pack-bitmap-write-cleanups later to maint).
91+
92+
* Preliminary code clean-up for "git send-email".
93+
(merge c02dc38570 ds/send-email-per-message-block later to maint).
94+
95+
* The default "creation-factor" used by "git format-patch" has been
96+
raised to make it more aggressively find matching commits.
97+
(merge c22d41d641 jc/format-patch-more-aggressive-range-diff later to maint).
98+
7999

80100
Fixes since v2.45
81101
-----------------
@@ -147,6 +167,19 @@ Fixes since v2.45
147167
"git fetch".
148168
(merge 9339fca23e it/refs-name-conflict later to maint).
149169

170+
* The SubmittingPatches document now refers folks to manpages
171+
translation project.
172+
(merge 558a5b8cd0 jc/doc-manpages-l10n later to maint).
173+
174+
* The documentation for "git diff --name-only" has been clarified
175+
that it is about showing the names in the post-image tree.
176+
(merge 4986662cbc jc/doc-diff-name-only later to maint).
177+
178+
* The credential helper that talks with osx keychain learned to avoid
179+
storing back the authentication material it just got received from
180+
the keychain.
181+
(merge e1ab45b2da kn/osxkeychain-skip-idempotent-store later to maint).
182+
150183
* Other code cleanup, docfix, build fix, etc.
151184
(merge 4cf6e7bf5e jt/doc-submitting-rerolled-series later to maint).
152185
(merge a5a4cb7b27 rs/diff-parseopts-cleanup later to maint).
@@ -157,3 +190,5 @@ Fixes since v2.45
157190
(merge b64b0df9da ds/scalar-reconfigure-all-fix later to maint).
158191
(merge c81ffcff83 dm/update-index-doc-fix later to maint).
159192
(merge fc0202b0e9 dg/fetch-pack-code-cleanup later to maint).
193+
(merge 7150f140f9 mt/t0211-typofix later to maint).
194+
(merge d424488901 jc/rev-parse-fatal-doc 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-05-23</span>
738+
<span id="revdate">2024-05-28</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">

‎SubmittingPatches.html

Lines changed: 120 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-05-23</span>
738+
<span id="revdate">2024-05-28</span>
739739
</div>
740740
<div id="content">
741741
<div class="sect1">
@@ -1422,6 +1422,111 @@ <h4 id="_code_format_patch_code_and_code_send_email_code"><code>format-patch</co
14221422
not a text/plain, it&#8217;s something else.</p></div>
14231423
</div>
14241424
</div>
1425+
<div class="sect2">
1426+
<h3 id="_handling_conflicts_and_iterating_patches">Handling Conflicts and Iterating Patches</h3>
1427+
<div class="paragraph"><p>When revising changes made to your patches, it&#8217;s important to
1428+
acknowledge the possibility of conflicts with other ongoing topics. To
1429+
navigate these potential conflicts effectively, follow the recommended
1430+
steps outlined below:</p></div>
1431+
<div class="olist arabic"><ol class="arabic">
1432+
<li>
1433+
<p>
1434+
Build on a suitable base branch, see the <a href="#choose-starting-point">section above</a>,
1435+
and format-patch the series. If you are doing "rebase -i" in-place to
1436+
update from the previous round, this will reuse the previous base so
1437+
(2) and (3) may become trivial.
1438+
</p>
1439+
</li>
1440+
<li>
1441+
<p>
1442+
Find the base of where the last round was queued
1443+
</p>
1444+
<div class="literalblock">
1445+
<div class="content">
1446+
<pre><code>$ mine='kn/ref-transaction-symref'
1447+
$ git checkout "origin/seen^{/^Merge branch '$mine'}...master"</code></pre>
1448+
</div></div>
1449+
</li>
1450+
<li>
1451+
<p>
1452+
Apply your format-patch result. There are two cases
1453+
</p>
1454+
<div class="olist loweralpha"><ol class="loweralpha">
1455+
<li>
1456+
<p>
1457+
Things apply cleanly and tests fine. Go to (4).
1458+
</p>
1459+
</li>
1460+
<li>
1461+
<p>
1462+
Things apply cleanly but does not build or test fails, or things do
1463+
not apply cleanly.
1464+
</p>
1465+
<div class="paragraph"><p>In the latter case, you have textual or semantic conflicts coming from
1466+
the difference between the old base and the base you used to build in
1467+
(1). Identify what caused the breakages (e.g., a topic or two may have
1468+
merged since the base used by (2) until the base used by (1)).</p></div>
1469+
<div class="paragraph"><p>Check out the latest <em>origin/master</em> (which may be newer than the base
1470+
used by (2)), "merge --no-ff" the topics you newly depend on in there,
1471+
and use the result of the merge(s) as the base, rebuild the series and
1472+
test again. Run format-patch from the last such merges to the tip of
1473+
your topic. If you did</p></div>
1474+
<div class="literalblock">
1475+
<div class="content">
1476+
<pre><code>$ git checkout origin/master
1477+
$ git merge --no-ff --into-name kn/ref-transaction-symref fo/obar
1478+
$ git merge --no-ff --into-name kn/ref-transaction-symref ba/zqux
1479+
... rebuild the topic ...</code></pre>
1480+
</div></div>
1481+
<div class="paragraph"><p>Then you&#8217;d just format your topic above these "preparing the ground"
1482+
merges, e.g.</p></div>
1483+
<div class="literalblock">
1484+
<div class="content">
1485+
<pre><code>$ git format-patch "HEAD^{/^Merge branch 'ba/zqux'}"..HEAD</code></pre>
1486+
</div></div>
1487+
<div class="paragraph"><p>Do not forget to write in the cover letter you did this, including the
1488+
topics you have in your base on top of <em>master</em>. Then go to (4).</p></div>
1489+
</li>
1490+
</ol></div>
1491+
</li>
1492+
<li>
1493+
<p>
1494+
Make a trial merge of your topic into <em>next</em> and <em>seen</em>, e.g.
1495+
</p>
1496+
<div class="literalblock">
1497+
<div class="content">
1498+
<pre><code>$ git checkout --detach 'origin/seen'
1499+
$ git revert -m 1 &lt;the merge of the previous iteration into seen&gt;
1500+
$ git merge kn/ref-transaction-symref</code></pre>
1501+
</div></div>
1502+
<div class="paragraph"><p>The "revert" is needed if the previous iteration of your topic is
1503+
already in <em>seen</em> (like in this case). You could choose to rebuild
1504+
master..origin/seen from scratch while excluding your previous
1505+
iteration, which may emulate what happens on the maintainers end more
1506+
closely.</p></div>
1507+
<div class="paragraph"><p>This trial merge may conflict. It is primarily to see what conflicts
1508+
<em>other</em> topics may have with your topic. In other words, you do not
1509+
have to depend on it to make your topic work on <em>master</em>. It may
1510+
become the job of the other topic owners to resolve conflicts if your
1511+
topic goes to <em>next</em> before theirs.</p></div>
1512+
<div class="paragraph"><p>Make a note on what conflict you saw in the cover letter. You do not
1513+
necessarily have to resolve them, but it would be a good opportunity to
1514+
learn what others are doing in related areas.</p></div>
1515+
<div class="literalblock">
1516+
<div class="content">
1517+
<pre><code>$ git checkout --detach 'origin/next'
1518+
$ git merge kn/ref-transaction-symref</code></pre>
1519+
</div></div>
1520+
<div class="paragraph"><p>This is to see what conflicts your topic has with other topics that are
1521+
already cooking. This should not conflict if (3)-2 prepared a base on
1522+
top of updated master plus dependent topics taken from <em>next</em>. Unless
1523+
the context is severe (one way to tell is try the same trial merge with
1524+
your old iteration, which may conflict in a similar way), expect that it
1525+
will be handled on maintainers end (if it gets unmanageable, I&#8217;ll ask to
1526+
rebase when I receive your patches).</p></div>
1527+
</li>
1528+
</ol></div>
1529+
</div>
14251530
</div>
14261531
</div>
14271532
<div class="sect1">
@@ -1464,6 +1569,19 @@ <h2 id="_subsystems_with_dedicated_maintainers">Subsystems with dedicated mainta
14641569
</li>
14651570
</ul></div>
14661571
<div class="paragraph"><p>Patches to these parts should be based on their trees.</p></div>
1572+
<div class="ulist"><ul>
1573+
<li>
1574+
<p>
1575+
The "Git documentation translations" project, led by Jean-Noël
1576+
Avila, translates our documentation pages. Their work products are
1577+
maintained separately from this project, not as part of our tree:
1578+
</p>
1579+
<div class="literalblock">
1580+
<div class="content">
1581+
<pre><code>https://github.com/jnavila/git-manpages-l10n/</code></pre>
1582+
</div></div>
1583+
</li>
1584+
</ul></div>
14671585
</div>
14681586
</div>
14691587
<div class="sect1">
@@ -1590,7 +1708,7 @@ <h3 id="_gnus">Gnus</h3>
15901708
<div id="footer">
15911709
<div id="footer-text">
15921710
Last updated
1593-
2024-05-23 12:14:59 PDT
1711+
2024-05-28 13:39:08 PDT
15941712
</div>
15951713
</div>
15961714
</body>

‎SubmittingPatches.txt

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -608,6 +608,85 @@ patch, format it as "multipart/signed", not a text/plain message
608608
that starts with `-----BEGIN PGP SIGNED MESSAGE-----`. That is
609609
not a text/plain, it's something else.
610610

611+
=== Handling Conflicts and Iterating Patches
612+
613+
When revising changes made to your patches, it's important to
614+
acknowledge the possibility of conflicts with other ongoing topics. To
615+
navigate these potential conflicts effectively, follow the recommended
616+
steps outlined below:
617+
618+
. Build on a suitable base branch, see the <<choose-starting-point, section above>>,
619+
and format-patch the series. If you are doing "rebase -i" in-place to
620+
update from the previous round, this will reuse the previous base so
621+
(2) and (3) may become trivial.
622+
623+
. Find the base of where the last round was queued
624+
+
625+
$ mine='kn/ref-transaction-symref'
626+
$ git checkout "origin/seen^{/^Merge branch '$mine'}...master"
627+
628+
. Apply your format-patch result. There are two cases
629+
.. Things apply cleanly and tests fine. Go to (4).
630+
.. Things apply cleanly but does not build or test fails, or things do
631+
not apply cleanly.
632+
+
633+
In the latter case, you have textual or semantic conflicts coming from
634+
the difference between the old base and the base you used to build in
635+
(1). Identify what caused the breakages (e.g., a topic or two may have
636+
merged since the base used by (2) until the base used by (1)).
637+
+
638+
Check out the latest 'origin/master' (which may be newer than the base
639+
used by (2)), "merge --no-ff" the topics you newly depend on in there,
640+
and use the result of the merge(s) as the base, rebuild the series and
641+
test again. Run format-patch from the last such merges to the tip of
642+
your topic. If you did
643+
+
644+
$ git checkout origin/master
645+
$ git merge --no-ff --into-name kn/ref-transaction-symref fo/obar
646+
$ git merge --no-ff --into-name kn/ref-transaction-symref ba/zqux
647+
... rebuild the topic ...
648+
+
649+
Then you'd just format your topic above these "preparing the ground"
650+
merges, e.g.
651+
+
652+
$ git format-patch "HEAD^{/^Merge branch 'ba/zqux'}"..HEAD
653+
+
654+
Do not forget to write in the cover letter you did this, including the
655+
topics you have in your base on top of 'master'. Then go to (4).
656+
657+
. Make a trial merge of your topic into 'next' and 'seen', e.g.
658+
+
659+
$ git checkout --detach 'origin/seen'
660+
$ git revert -m 1 <the merge of the previous iteration into seen>
661+
$ git merge kn/ref-transaction-symref
662+
+
663+
The "revert" is needed if the previous iteration of your topic is
664+
already in 'seen' (like in this case). You could choose to rebuild
665+
master..origin/seen from scratch while excluding your previous
666+
iteration, which may emulate what happens on the maintainers end more
667+
closely.
668+
+
669+
This trial merge may conflict. It is primarily to see what conflicts
670+
_other_ topics may have with your topic. In other words, you do not
671+
have to depend on it to make your topic work on 'master'. It may
672+
become the job of the other topic owners to resolve conflicts if your
673+
topic goes to 'next' before theirs.
674+
+
675+
Make a note on what conflict you saw in the cover letter. You do not
676+
necessarily have to resolve them, but it would be a good opportunity to
677+
learn what others are doing in related areas.
678+
+
679+
$ git checkout --detach 'origin/next'
680+
$ git merge kn/ref-transaction-symref
681+
+
682+
This is to see what conflicts your topic has with other topics that are
683+
already cooking. This should not conflict if (3)-2 prepared a base on
684+
top of updated master plus dependent topics taken from 'next'. Unless
685+
the context is severe (one way to tell is try the same trial merge with
686+
your old iteration, which may conflict in a similar way), expect that it
687+
will be handled on maintainers end (if it gets unmanageable, I'll ask to
688+
rebase when I receive your patches).
689+
611690
== Subsystems with dedicated maintainers
612691

613692
Some parts of the system have dedicated maintainers with their own
@@ -630,6 +709,13 @@ repositories.
630709

631710
Patches to these parts should be based on their trees.
632711

712+
- The "Git documentation translations" project, led by Jean-Noël
713+
Avila, translates our documentation pages. Their work products are
714+
maintained separately from this project, not as part of our tree:
715+
716+
https://github.com/jnavila/git-manpages-l10n/
717+
718+
633719
== GitHub CI[[GHCI]]
634720

635721
With an account at GitHub, you can use GitHub CI to test your changes

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

‎diff-options.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,12 +329,13 @@ explained for the configuration variable `core.quotePath` (see
329329
linkgit:git-config[1]).
330330

331331
--name-only::
332-
Show only names of changed files. The file names are often encoded in UTF-8.
332+
Show only the name of each changed file in the post-image tree.
333+
The file names are often encoded in UTF-8.
333334
For more information see the discussion about encoding in the linkgit:git-log[1]
334335
manual page.
335336

336337
--name-status::
337-
Show only names and status of changed files. See the description
338+
Show only the name(s) and status of each changed file. See the description
338339
of the `--diff-filter` option on what the status letters mean.
339340
Just like `--name-only` the file names are often encoded in UTF-8.
340341

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

‎git-diff-files.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1145,7 +1145,8 @@ <h2 id="_options">OPTIONS</h2>
11451145
</dt>
11461146
<dd>
11471147
<p>
1148-
Show only names of changed files. The file names are often encoded in UTF-8.
1148+
Show only the name of each changed file in the post-image tree.
1149+
The file names are often encoded in UTF-8.
11491150
For more information see the discussion about encoding in the <a href="git-log.html">git-log(1)</a>
11501151
manual page.
11511152
</p>
@@ -1155,7 +1156,7 @@ <h2 id="_options">OPTIONS</h2>
11551156
</dt>
11561157
<dd>
11571158
<p>
1158-
Show only names and status of changed files. See the description
1159+
Show only the name(s) and status of each changed file. See the description
11591160
of the <code>--diff-filter</code> option on what the status letters mean.
11601161
Just like <code>--name-only</code> the file names are often encoded in UTF-8.
11611162
</p>

0 commit comments

Comments
 (0)