Commit 89c3c67b24da7bf5364338accaaea129b49097eb

Stefan Sperling 2020-03-20T16:40:24

document what got-index-pack does

diff --git a/got/got.1 b/got/got.1
index 2b7971b..5621370 100644
--- a/got/got.1
+++ b/got/got.1
@@ -177,6 +177,14 @@ to use:
 Short alias for git+ssh.
 .El
 .Pp
+Objects in the cloned repository are stored in a pack file which is downloaded
+from the server.
+This pack file will then be indexed to facilitate access to the objects stored
+within.
+If any objects in the pack file are stored in deltified form, all deltas will
+be fully resolved in order to compute the ID of such objects.
+This can take some time.
+.Pp
 .Cm got clone
 creates a remote repository entry in the
 .Pa config
@@ -252,6 +260,10 @@ The remote repository's URL is obtained from the corresponding entry in the
 file of the repository, as created by
 .Cm got clone .
 .Pp
+New changes will be stored in a separate pack file downloaded from the server.
+Optionally, separate pack files stored in the repository can be combined with
+.Xr git-repack 1 .
+.Pp
 Branch references in the
 .Dq refs/remotes/
 reference namespace will be updated to point at the newly fetched commits,