| commit | de29a7ac0ec31d8f5fa91b7d2f0294165787d558 | |
| author | Junio C Hamano <gitster@pobox.com> | |
| Tue, 11 Dec 2012 23:04:36 +0000 (11 15:04 -0800) | ||
| committer | Junio C Hamano <gitster@pobox.com> | |
| Wed, 12 Dec 2012 19:07:48 +0000 (12 11:07 -0800) | ||
| tree | dfb2b25bb78f252265411b1cc47fb612c89f6f9e | treesnapshot (tar.gz zip) |
| parent | 76c36c02ff3fe1571051ce9278248bd269f8341b | commitdiff |
git-prompt.sh: update PROMPT_COMMAND documentation
The description of __git_ps1 function operating in two-arg mode was
not very clear. It said "set PROMPT_COMMAND=__git_ps1" which is not
the right usage for this mode, followed by "To customize the prompt,
do this", giving a false impression that those who do not want to
customize it can get away with no-arg form, which was incorrect.
Make it clear that this mode always takes two arguments, pre and
post, with an example.
The straight-forward one should be listed as the primary usage, and
the confusing one should be an alternate for advanced users. Swap
the order of these two.
Acked-by: Simon Oosthoek <s.oosthoek@xs4all.nl>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
The description of __git_ps1 function operating in two-arg mode was
not very clear. It said "set PROMPT_COMMAND=__git_ps1" which is not
the right usage for this mode, followed by "To customize the prompt,
do this", giving a false impression that those who do not want to
customize it can get away with no-arg form, which was incorrect.
Make it clear that this mode always takes two arguments, pre and
post, with an example.
The straight-forward one should be listed as the primary usage, and
the confusing one should be an alternate for advanced users. Swap
the order of these two.
Acked-by: Simon Oosthoek <s.oosthoek@xs4all.nl>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| contrib/completion/git-prompt.sh | diffblobblamehistory |