Add documentation for the scripts.

[git-central.git] / scripts / checkout

diff --git a/scripts/checkout b/scripts/checkout
index e326b38e99f5cff52d0071e84010cf4744df9ee9..8576a7022fa39e290e12684c703206d262f79596 100644 (file)
--- a/scripts/checkout
+++ b/scripts/checkout
@@ -1,4 +1,12 @@
 #!/bin/sh
+#
+# Makes checkout "just work" in terms of checking out the branch whether or not
+# it exists locally or remotely.
+#
+# If the branch exists locally (e.g. foo), then just check it out
+# If the branch exists remotely (e.g. origin/foo), then create a new local branch
+# If the branch does not exist remote, then make a new local branch and push it
+#
 
 branch_name=$1