From: Junio C Hamano <gitster@pobox.com>
To: Simon Oosthoek <s.oosthoek@xs4all.nl>
Cc: Piotr Krukowiecki <piotr.krukowiecki@gmail.com>, git@vger.kernel.org
Subject: Re: git-prompt.sh vs leading white space in __git_ps1()::printf_format
Date: Tue, 11 Dec 2012 16:03:36 -0800 [thread overview]
Message-ID: <7vy5h45e7b.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <7v7goo6vi3.fsf@alter.siamese.dyndns.org> (Junio C. Hamano's message of "Tue, 11 Dec 2012 15:04:36 -0800")
Junio C Hamano <gitster@pobox.com> writes:
> Perhaps like this?
OK, this time with a log message.
-- >8 --
Subject: [PATCH] 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.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
contrib/completion/git-prompt.sh | 16 +++++++++++-----
1 file changed, 11 insertions(+), 5 deletions(-)
diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index a8b53ba..9b074e1 100644
--- a/contrib/completion/git-prompt.sh
+++ b/contrib/completion/git-prompt.sh
@@ -10,14 +10,20 @@
# 1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
# 2) Add the following line to your .bashrc/.zshrc:
# source ~/.git-prompt.sh
-# 3a) In ~/.bashrc set PROMPT_COMMAND=__git_ps1
-# To customize the prompt, provide start/end arguments
-# PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
-# 3b) Alternatively change your PS1 to call __git_ps1 as
+# 3a) Change your PS1 to call __git_ps1 as
# command-substitution:
# Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
# ZSH: PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ '
-# the optional argument will be used as format string
+# the optional argument will be used as format string.
+# 3b) Alternatively, if you are using bash, __git_ps1 can be
+# used for PROMPT_COMMAND with two parameters, <pre> and
+# <post>, which are strings you would put in $PS1 before
+# and after the status string generated by the git-prompt
+# machinery. e.g.
+# PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
+# will show username, at-sign, host, colon, cwd, then
+# various status string, followed by dollar and SP, as
+# your prompt.
#
# The argument to __git_ps1 will be displayed only if you are currently
# in a git repository. The %s token will be the name of the current
--
1.8.1.rc1.128.gd8d1528
next prev parent reply other threads:[~2012-12-12 0:03 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <CAA01Cso1E4EC4W667FEU_af2=uGOfPuaWEB3y+zPCpB+bPzoaA@mail.gmail.com>
2012-11-28 13:20 ` git-prompt.sh vs leading white space in __git_ps1()::printf_format Simon Oosthoek
[not found] ` <CAA01CspHAHN7se2oJ2WgcmpuRfoa+9Sx9sUvaPEmQ-Y+kDwHhA@mail.gmail.com>
2012-11-28 18:04 ` Piotr Krukowiecki
2012-11-28 20:08 ` Simon Oosthoek
2012-11-28 20:47 ` Junio C Hamano
2012-11-28 20:58 ` Simon Oosthoek
2012-12-11 22:47 ` Simon Oosthoek
2012-12-11 23:04 ` Junio C Hamano
2012-12-12 0:03 ` Junio C Hamano [this message]
2012-12-12 8:55 ` Simon Oosthoek
2012-12-12 17:50 ` Junio C Hamano
2012-12-12 20:25 ` Simon Oosthoek
2012-12-26 7:47 ` Junio C Hamano
2012-12-26 12:51 ` Simon Oosthoek
2012-12-26 19:15 ` [PATCH] make __git_ps1 accept a third parameter in pcmode Simon Oosthoek
2012-12-26 19:45 ` Junio C Hamano
2012-12-26 20:19 ` Simon Oosthoek
2012-12-26 20:32 ` Junio C Hamano
2012-12-26 20:54 ` Junio C Hamano
2012-12-26 21:03 ` Simon Oosthoek
2012-12-26 20:42 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7vy5h45e7b.fsf@alter.siamese.dyndns.org \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=piotr.krukowiecki@gmail.com \
--cc=s.oosthoek@xs4all.nl \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).