Filling in docs.

[git-central.git] / server / post-receive-commitnumbers

diff --git a/server/post-receive-commitnumbers b/server/post-receive-commitnumbers
index 364618b..7bd130a 100644 (file)
--- a/server/post-receive-commitnumbers
+++ b/server/post-receive-commitnumbers
@@ -1,4 +1,20 @@
 #!/bin/sh
+#
+# Creates commitnumbers as lightweight tags named "r/X" where X increases
+# monotonically.
+#
+# Works by creating a GIT_DIR/commitnumbers file that is a list of all
+# commit SHA1s where the commitnumber == the line number of the SHA1 in the
+# file.
+#
+# If you're adding commitnumbers to an existing repo, you can jump start it
+# (without the tags, but so you don't start at 0), by:
+#
+#     git rev-list --all > $GIT_DIR/commitnumbers
+#
+# There is no real reason the tags are named "r/X"--feel free to substitute your
+# own prefix or drop it all together. That should probably be a config variable.
+#
 
 . $(dirname $0)/functions