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@xxxxxxxxx>
---
Documentation/Makefile | 2 +-
.../index-format.txt => gitformat-index.txt} | 20 ++++++++++++++++++-
command-list.txt | 1 +
3 files changed, 21 insertions(+), 2 deletions(-)
rename Documentation/{technical/index-format.txt => gitformat-index.txt} (98%)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index b53f3c12843..029067a77d5 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -26,6 +26,7 @@ MAN1_TXT += gitweb.txt
MAN5_TXT += gitattributes.txt
MAN5_TXT += gitformat-bundle.txt
MAN5_TXT += gitformat-commit-graph.txt
+MAN5_TXT += gitformat-index.txt
MAN5_TXT += githooks.txt
MAN5_TXT += gitignore.txt
MAN5_TXT += gitmailmap.txt
@@ -104,7 +105,6 @@ TECH_DOCS += technical/bitmap-format
TECH_DOCS += technical/cruft-packs
TECH_DOCS += technical/hash-function-transition
TECH_DOCS += technical/http-protocol
-TECH_DOCS += technical/index-format
TECH_DOCS += technical/long-running-process-protocol
TECH_DOCS += technical/multi-pack-index
TECH_DOCS += technical/pack-format
diff --git a/Documentation/technical/index-format.txt b/Documentation/gitformat-index.txt
similarity index 98%
rename from Documentation/technical/index-format.txt
rename to Documentation/gitformat-index.txt
index f691c20ab0a..9c3844298b8 100644
--- a/Documentation/technical/index-format.txt
+++ b/Documentation/gitformat-index.txt
@@ -1,5 +1,19 @@
+gitformat-index(5)
+==================
+
+NAME
+----
+gitformat-index - Git index format
+
+SYNOPSIS
+--------
+[verse]
+$GIT_DIR/index
+
+DESCRIPTION
+-----------
+
Git index format
-================
== The Git index file has the following format
@@ -402,3 +416,7 @@ The remaining data of each directory block is grouped by type:
with signature { 's', 'd', 'i', 'r' }. Like the split-index extension,
tools should avoid interacting with a sparse index unless they understand
this extension.
+
+GIT
+---
+Part of the linkgit:git[1] suite
diff --git a/command-list.txt b/command-list.txt
index ed859fdd798..5e8d8386683 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -211,6 +211,7 @@ giteveryday guide
gitfaq guide
gitformat-bundle developerinterfaces
gitformat-commit-graph developerinterfaces
+gitformat-index developerinterfaces
gitglossary guide
githooks userinterfaces
gitignore userinterfaces
--
2.37.1.1233.g61622908797
