checkout: update synopsys and documentation on detaching HEAD
commit26776c9737a6b5b0e7aab142aef6ba856d8b46ca
authorJunio C Hamano <gitster@pobox.com>
Wed, 11 Sep 2013 17:05:17 +0000 (11 10:05 -0700)
committerJunio C Hamano <gitster@pobox.com>
Wed, 11 Sep 2013 19:32:01 +0000 (11 12:32 -0700)
tree0dcaed754439b23774bb63fa500edc77eaceb0de
parent2ea3df68e881405940596b8c299921f681f8c22c
checkout: update synopsys and documentation on detaching HEAD

In the synopsis, the second form to detach HEAD at the named commit
labelled the argument as '<commit>'.  While this is technically more
correct, because the feature to detach is not limited to the tip of
a named branch, it was found confusing and did not express the fact
that you have to give `--detach` if you are naming the commit you
want to detach HEAD at with a branch name.

Separate this case into two syntactical forms, mimicking the way how
the DESCRIPTION section shows this usage.  Also update the text that
explains the syntax to name the commit to detach HEAD at to clarify.

Suggested-by: Benjamin Bergman <ben@benbergman.ca>
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-checkout.txt