Skip to content

Commit 5a45c6c

Browse files
committed
remembering-renames/sparse-checkout: fix section levels
In 5275100 (doc: add some missing technical documents, 2025-10-02), some documents were added to the default set of files to be rendered. Unfortunately, this led to CI failures since Oct 10 (see https://github.com/git/git/actions/runs/18418984731), the eight most recent pushes of Git's `master` as of time of writing. In the preceding commit, the numbered lists that started at zero (which AsciiDoc cannot handle) were changed, but there are still the following problems: asciidoctor: WARNING: remembering-renames.adoc: line 38: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 94: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 141: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 142: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 184: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 185: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 257: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 288: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 289: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 290: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 397: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 424: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 485: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 486: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: remembering-renames.adoc: line 487: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 17: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 95: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 258: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 303: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 316: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 545: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 612: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 752: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 824: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 895: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 923: section title out of sequence: expected level 1, got level 2 asciidoctor: WARNING: sparse-checkout.adoc: line 1053: section title out of sequence: expected level 1, got level 2 Let's change the level of the sections to fix those warnings, too. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
1 parent 91303f8 commit 5a45c6c

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

Documentation/technical/remembering-renames.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Outline:
3535
"true".
3636

3737

38-
=== 1. Assumptions ===
38+
== 1. Assumptions ==
3939

4040
There are two assumptions that will hold throughout this document:
4141

@@ -91,7 +91,7 @@ this config setting, but we have to discuss a few more cases to show why;
9191
this discussion is deferred until section 8.
9292

9393

94-
=== 2. How rebasing and cherry-picking work ===
94+
== 2. How rebasing and cherry-picking work ==
9595

9696
Consider the following setup (from the git-rebase manpage):
9797

@@ -138,8 +138,8 @@ Conceptually the two statements above are the same as a three-way merge of
138138
B, B', and C, at least the parts before you decide to record a commit.
139139

140140

141-
=== 3. Why the renames on MERGE_SIDE1 in any given pick are always a ===
142-
=== superset of the renames on MERGE_SIDE1 for the next pick. ===
141+
== 3. Why the renames on MERGE_SIDE1 in any given pick are always a ==
142+
== superset of the renames on MERGE_SIDE1 for the next pick. ==
143143

144144
The merge machinery uses the filenames it is fed from MERGE_BASE,
145145
MERGE_SIDE1, and MERGE_SIDE2. It will only move content to a different
@@ -181,8 +181,8 @@ are a subset of those between E and G. Equivalently, all renames between E
181181
and G are a superset of those between A and A'.
182182

183183

184-
=== 4. Why any rename on MERGE_SIDE1 in any given pick is _almost_ ===
185-
=== always also a rename on MERGE_SIDE1 for the next pick. ===
184+
== 4. Why any rename on MERGE_SIDE1 in any given pick is _almost_ ==
185+
== always also a rename on MERGE_SIDE1 for the next pick. ==
186186

187187
Let's again look at the first two picks:
188188

@@ -254,7 +254,7 @@ were detected as renames, A:oldfile and A':newfile should also be
254254
detectable as renames almost always.
255255

256256

257-
=== 5. A detailed description of the counter-examples to #3. ===
257+
== 5. A detailed description of the counter-examples to #3. ==
258258

259259
We already noted in section 3 that rename/rename(1to1) (i.e. both sides
260260
renaming a file the same way) was one counter-example. The more
@@ -285,9 +285,9 @@ E:oldfile -> G:newfile would be detected as a rename, but A:oldfile and
285285
A':newfile would not be.
286286

287287

288-
=== 6. Why the special cases in #4 are still fully reasonable to use to ===
289-
=== pair up files for three-way content merging in the merge machinery, ===
290-
=== and why they do not affect the correctness of the merge. ===
288+
== 6. Why the special cases in #4 are still fully reasonable to use to ==
289+
== pair up files for three-way content merging in the merge machinery, ==
290+
== and why they do not affect the correctness of the merge. ==
291291

292292
In the rename/rename(1to1) case, A:newfile and A':newfile are not renames
293293
since they use the *same* filename. However, files with the same filename
@@ -394,7 +394,7 @@ cases 1 and 3 seem to provide as good or better behavior with the
394394
optimization than without.
395395

396396

397-
=== 7. Interaction with skipping of "irrelevant" renames ===
397+
== 7. Interaction with skipping of "irrelevant" renames ==
398398

399399
Previous optimizations involved skipping rename detection for paths
400400
considered to be "irrelevant". See for example the following commits:
@@ -421,7 +421,7 @@ detection -- though we can limit it to the paths for which we have not
421421
already detected renames.
422422

423423

424-
=== 8. Additional items that need to be cached ===
424+
== 8. Additional items that need to be cached ==
425425

426426
It turns out we have to cache more than just renames; we also cache:
427427

@@ -482,9 +482,9 @@ we store the trees to compare with what we are asked to merge next
482482
time.
483483

484484

485-
=== 9. How directory rename detection interacts with the above and ===
486-
=== why this optimization is still safe even if ===
487-
=== merge.directoryRenames is set to "true". ===
485+
== 9. How directory rename detection interacts with the above and ==
486+
== why this optimization is still safe even if ==
487+
== merge.directoryRenames is set to "true". ==
488488

489489
As noted in the assumptions section:
490490

Documentation/technical/sparse-checkout.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Table of contents:
1414
* Reference Emails
1515

1616

17-
=== Terminology ===
17+
== Terminology ==
1818

1919
cone mode: one of two modes for specifying the desired subset of files
2020
in a sparse-checkout. In cone-mode, the user specifies
@@ -92,7 +92,7 @@ vivifying: When a command restores a tracked file to the working tree (and
9292
file), this is referred to as "vivifying" the file.
9393

9494

95-
=== Purpose of sparse-checkouts ===
95+
== Purpose of sparse-checkouts ==
9696

9797
sparse-checkouts exist to allow users to work with a subset of their
9898
files.
@@ -255,7 +255,7 @@ will perceive the checkout as dense, and commands should thus behave as if
255255
all files are present.
256256

257257

258-
=== Usecases of primary concern ===
258+
== Usecases of primary concern ==
259259

260260
Most of the rest of this document will focus on Behavior A and Behavior
261261
B. Some notes about the other two cases and why we are not focusing on
@@ -300,7 +300,7 @@ Behavior C do not assume they are part of the Behavior B camp and propose
300300
patches that break things for the real Behavior B folks.
301301

302302

303-
=== Oversimplified mental models ===
303+
== Oversimplified mental models ==
304304

305305
An oversimplification of the differences in the above behaviors is:
306306

@@ -313,7 +313,7 @@ An oversimplification of the differences in the above behaviors is:
313313
they can later lazily be populated instead.
314314

315315

316-
=== Desired behavior ===
316+
== Desired behavior ==
317317

318318
As noted previously, despite the simple idea of just working with a subset
319319
of files, there are a range of different behavioral changes that need to be
@@ -542,7 +542,7 @@ understanding these differences can be beneficial.
542542
* gitk?
543543

544544

545-
=== Behavior classes ===
545+
== Behavior classes ==
546546

547547
From the above there are a few classes of behavior:
548548

@@ -609,7 +609,7 @@ From the above there are a few classes of behavior:
609609
specification.
610610

611611

612-
=== Subcommand-dependent defaults ===
612+
== Subcommand-dependent defaults ==
613613

614614
Note that we have different defaults depending on the command for the
615615
desired behavior :
@@ -749,7 +749,7 @@ desired behavior :
749749
implemented.
750750

751751

752-
=== Sparse specification vs. sparsity patterns ===
752+
== Sparse specification vs. sparsity patterns ==
753753

754754
In a well-behaved situation, the sparse specification is given directly
755755
by the $GIT_DIR/info/sparse-checkout file. However, it can transiently
@@ -821,7 +821,7 @@ under behavior B index operations are lumped with history and tend to
821821
operate full-tree.
822822

823823

824-
=== Implementation Questions ===
824+
== Implementation Questions ==
825825

826826
* Do the options --scope={sparse,all} sound good to others? Are there better
827827
options?
@@ -892,7 +892,7 @@ operate full-tree.
892892
is seamless for them.
893893

894894

895-
=== Implementation Goals/Plans ===
895+
== Implementation Goals/Plans ==
896896

897897
* Get buy-in on this document in general.
898898

@@ -920,7 +920,7 @@ operate full-tree.
920920
commands. IMPORTANT: make sure diff machinery changes don't mess with
921921
format-patch, fast-export, etc.
922922

923-
=== Known bugs ===
923+
== Known bugs ==
924924

925925
This list used to be a lot longer (see e.g. [1,2,3,4,5,6,7,8,9]), but we've
926926
been working on it.
@@ -1050,7 +1050,7 @@ been working on it.
10501050
https://lore.kernel.org/git/CABPp-BEkJQoKZsQGCYioyga_uoDQ6iBeW+FKr8JhyuuTMK1RDw@mail.gmail.com/
10511051

10521052

1053-
=== Reference Emails ===
1053+
== Reference Emails ==
10541054

10551055
Emails that detail various bugs we've had in sparse-checkout:
10561056

0 commit comments

Comments
 (0)