summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>2022-08-04 18:28:37 +0200
committerJunio C Hamano <gitster@pobox.com>2022-08-04 23:12:23 +0200
commit00d3e8d7dd9ece6fe89dafff384ff32444754211 (patch)
treec3a1170e077b9aaa504c7b910e738899615031ef
parentdocs: move protocol-related docs to man section 5 (diff)
downloadgit-00d3e8d7dd9ece6fe89dafff384ff32444754211.tar.xz
git-00d3e8d7dd9ece6fe89dafff384ff32444754211.zip
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>
-rw-r--r--Documentation/Makefile2
-rw-r--r--Documentation/gitformat-index.txt (renamed from Documentation/technical/index-format.txt)20
-rw-r--r--command-list.txt1
3 files changed, 21 insertions, 2 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index b53f3c1284..029067a77d 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
index 65da0daaa5..41491d2a07 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
@@ -404,3 +418,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 ed859fdd79..5e8d838668 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