docs: move index format 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 index format documentation. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Aug 4, 2022 at 18:28 UTC
00d3e8d7dd9ece6fe89dafff384ff32444754211
3 files changed
+21
-2
Documentation/Makefile
+1
-1
@@ -26,6 +26,7 @@ MAN1_TXT += gitweb.txt
26
MAN5_TXT += gitattributes.txt
27
MAN5_TXT += gitformat-bundle.txt
28
MAN5_TXT += gitformat-commit-graph.txt
29
+MAN5_TXT += gitformat-index.txt
30
MAN5_TXT += githooks.txt
31
MAN5_TXT += gitignore.txt
32
MAN5_TXT += gitmailmap.txt
@@ -104,7 +105,6 @@ TECH_DOCS += technical/bitmap-format
105
TECH_DOCS += technical/cruft-packs
106
TECH_DOCS += technical/hash-function-transition
107
TECH_DOCS += technical/http-protocol
107
-TECH_DOCS += technical/index-format
108
TECH_DOCS += technical/long-running-process-protocol
109
TECH_DOCS += technical/multi-pack-index
110
TECH_DOCS += technical/pack-format
Documentation/gitformat-index.txt
renamed
+19
-1
@@ -1,5 +1,19 @@
1
+gitformat-index(5)
2
+==================
3
+
4
+NAME
5
+----
6
+gitformat-index - Git index format
7
+
8
+SYNOPSIS
9
+--------
10
+[verse]
11
+$GIT_DIR/index
12
+
13
+DESCRIPTION
14
+-----------
15
+
16
Git index format
2
-================
17
18
== The Git index file has the following format
19
@@ -404,3 +418,7 @@ The remaining data of each directory block is grouped by type:
418
with signature { 's', 'd', 'i', 'r' }. Like the split-index extension,
419
tools should avoid interacting with a sparse index unless they understand
420
this extension.
421
+
422
+GIT
423
+---
424
+Part of the linkgit:git[1] suite
command-list.txt
+1
@@ -211,6 +211,7 @@ giteveryday guide
211
gitfaq guide
212
gitformat-bundle developerinterfaces
213
gitformat-commit-graph developerinterfaces
214
+gitformat-index developerinterfaces
215
gitglossary guide
216
githooks userinterfaces
217
gitignore userinterfaces