Skip to content

Commit 00d3e8d

Browse files
avargitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5db9210 commit 00d3e8d

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

Documentation/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ MAN1_TXT += gitweb.txt
2626
MAN5_TXT += gitattributes.txt
2727
MAN5_TXT += gitformat-bundle.txt
2828
MAN5_TXT += gitformat-commit-graph.txt
29+
MAN5_TXT += gitformat-index.txt
2930
MAN5_TXT += githooks.txt
3031
MAN5_TXT += gitignore.txt
3132
MAN5_TXT += gitmailmap.txt
@@ -104,7 +105,6 @@ TECH_DOCS += technical/bitmap-format
104105
TECH_DOCS += technical/cruft-packs
105106
TECH_DOCS += technical/hash-function-transition
106107
TECH_DOCS += technical/http-protocol
107-
TECH_DOCS += technical/index-format
108108
TECH_DOCS += technical/long-running-process-protocol
109109
TECH_DOCS += technical/multi-pack-index
110110
TECH_DOCS += technical/pack-format

Documentation/technical/index-format.txt renamed to Documentation/gitformat-index.txt

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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+
116
Git index format
2-
================
317

418
== The Git index file has the following format
519

@@ -404,3 +418,7 @@ The remaining data of each directory block is grouped by type:
404418
with signature { 's', 'd', 'i', 'r' }. Like the split-index extension,
405419
tools should avoid interacting with a sparse index unless they understand
406420
this extension.
421+
422+
GIT
423+
---
424+
Part of the linkgit:git[1] suite

command-list.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ giteveryday guide
211211
gitfaq guide
212212
gitformat-bundle developerinterfaces
213213
gitformat-commit-graph developerinterfaces
214+
gitformat-index developerinterfaces
214215
gitglossary guide
215216
githooks userinterfaces
216217
gitignore userinterfaces

0 commit comments

Comments
 (0)