Skip to content

Commit 2419039

Browse files
avargitster
authored andcommitted
docs: move multi-pack-index docs to man section 5
Continue the move of existing Documentation/technical/* protocol and file-format documentation into our main documentation space by moving the multi-pack-index documentation over. Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 82727f9 commit 2419039

File tree

5 files changed

+27
-5
lines changed

5 files changed

+27
-5
lines changed

Documentation/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ MAN5_TXT += gitformat-bundle.txt
2828
MAN5_TXT += gitformat-chunk.txt
2929
MAN5_TXT += gitformat-commit-graph.txt
3030
MAN5_TXT += gitformat-index.txt
31+
MAN5_TXT += gitformat-multi-pack-index.txt
3132
MAN5_TXT += gitformat-pack-cruft.txt
3233
MAN5_TXT += gitformat-pack.txt
3334
MAN5_TXT += gitformat-signature.txt
@@ -109,7 +110,6 @@ TECH_DOCS += ToolsForGit
109110
TECH_DOCS += technical/bitmap-format
110111
TECH_DOCS += technical/hash-function-transition
111112
TECH_DOCS += technical/long-running-process-protocol
112-
TECH_DOCS += technical/multi-pack-index
113113
TECH_DOCS += technical/pack-heuristics
114114
TECH_DOCS += technical/parallel-checkout
115115
TECH_DOCS += technical/partial-clone

Documentation/git-multi-pack-index.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@ $ git multi-pack-index verify
127127

128128
SEE ALSO
129129
--------
130-
See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
131-
Document] and linkgit:gitformat-pack[5] for more information on the
130+
See linkgit:git-multi-pack-index[1] and
131+
linkgit:gitformat-multi-pack-index[5] for more information on the
132132
multi-pack-index feature and its file format.
133133

134134

Documentation/technical/multi-pack-index.txt renamed to Documentation/gitformat-multi-pack-index.txt

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1-
Multi-Pack-Index (MIDX) Design Notes
2-
====================================
1+
gitformat-multi-pack-index(5)
2+
=============================
3+
4+
NAME
5+
----
6+
gitformat-multi-pack-index - The multi-pack-index file format
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
$GIT_DIR/objects/pack/multi-pack-index
12+
13+
DESCRIPTION
14+
-----------
315

416
The Git object directory contains a 'pack' directory containing
517
packfiles (with suffix ".pack") and pack-indexes (with suffix
@@ -98,3 +110,7 @@ Related Links
98110

99111
[2] https://lore.kernel.org/git/alpine.DEB.2.20.1803091557510.23109@alexmv-linux/
100112
Git Merge 2018 Contributor's summit notes (includes discussion of MIDX)
113+
114+
GIT
115+
---
116+
Part of the linkgit:git[1] suite

Documentation/gitformat-pack.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -507,6 +507,11 @@ packs arranged in MIDX order (with the preferred pack coming first).
507507
The MIDX's reverse index is stored in the optional 'RIDX' chunk within
508508
the MIDX itself.
509509

510+
SEE ALSO
511+
--------
512+
513+
linkgit:gitformat-multi-pack-index[5]
514+
510515
GIT
511516
---
512517
Part of the linkgit:git[1] suite

command-list.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ gitformat-bundle developerinterfaces
213213
gitformat-chunk developerinterfaces
214214
gitformat-commit-graph developerinterfaces
215215
gitformat-index developerinterfaces
216+
gitformat-multi-pack-index developerinterfaces
216217
gitformat-pack developerinterfaces
217218
gitformat-pack-cruft developerinterfaces
218219
gitformat-signature developerinterfaces

0 commit comments

Comments
 (0)