Re: [PATCH] glossary: extend "detached HEAD" description

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



W dniu 10.04.2013 16:45, Junio C Hamano pisze:
> Jakub Narębski <jnareb@xxxxxxxxx> writes:
> 
>> Junio C Hamano wrote:
>>
>>> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
>>> index f928b57..69c90d1 100644
>>> --- a/Documentation/glossary-content.txt
>>> +++ b/Documentation/glossary-content.txt
>>> @@ -100,9 +100,22 @@ to point at the new commit.
>>>  
>>>  [[def_detached_HEAD]]detached HEAD::
>>>  	Normally the <<def_HEAD,HEAD>> stores the name of a
>>> -	<<def_branch,branch>>.  However, git also allows you to <<def_checkout,check out>>
>>> -	an arbitrary <<def_commit,commit>> that isn't necessarily the tip of any
>>> -	particular branch.  In this case HEAD is said to be "detached".
>>> +	<<def_branch,branch>>, and commands that operate on the
>>> +	history HEAD represents operate on the history leading to the
>>> +	tip of the branch the HEAD points at.  However, Git also
>>> +	allows you to <<def_checkout,check out>> an arbitrary
>>> +	<<def_commit,commit>> that isn't necessarily the tip of any
>>> +	particular branch.  The HEAD in such a state is called
>>> +	"detached".
>>
>> Should we also add that "git branch" output shows this situation
>> as "(no branch)"?
>>
>> Nb. this is not documented in git-branch(1) manpage either...
> 
> Sounds good. Please make it so, perhaps for both.

Err... I can try to add such documentation in git-branch(1), but
shouldn't I wait for your changes to glossary before adding info
about "(no branch)"?

P.S. From some StackOverflow questions the connection between "(no
branch)" and detached HEAD is not clear for git newbies...
-- 
Jakub Narębski
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]