diff options
| author | Junio C Hamano <gitster@pobox.com> | 2010-01-29 22:03:24 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-01-29 22:11:00 -0800 |
| commit | 13be3e31f1775bd496fc5bc1ab5b745052f4d07d (patch) | |
| tree | 0bce4afc79894645a86c8d8a219b461d57760eb3 /Documentation | |
| parent | b2c2e4c22c6a4fe151f02380d247cf3d9a9d5d1e (diff) | |
| download | git-13be3e31f1775bd496fc5bc1ab5b745052f4d07d.tar.gz | |
Reword "detached HEAD" notification
The old "advice" message explained how to create a branch after going into
a detached HEAD state but didn't make it clear why the user may want to do
so. Also "moving to ... which isn't a local branch" was unclear if it is
complaining, if it is describing the new state, or if it is explaining why
the HEAD is detached (the true reason is the last one).
Give the established phrase 'detached HEAD' first to make it easy for
users to look up the concept in documentation, and briefly describe what
can be done in the state (i.e. play around without having to clean up)
before telling the user how to keep what was done during the temporary
state.
Allow the long description to be hidden by setting advice.detachedHead
configuration to false.
We might want to customize the advice depending on how the commit to check
out was spelled (e.g. instead of "new-branch-name", we way want to say
"topic" when "git checkout origin/topic" triggered this message) in later
updates, but this encapsulates that into a separate function and it should
be a good first step.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/config.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index 17901e244a..fee44d8a4a 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -138,6 +138,11 @@ advice.*:: Advice on how to set your identity configuration when your information is guessed from the system username and domain name. Default: true. + + detachedHead:: + Advice shown when you used linkgit::git-checkout[1] to + move to the detach HEAD state, to instruct how to create + a local branch after the fact. Default: true. -- core.fileMode:: |