From: Simon Oosthoek <s.oosthoek@xs4all.nl>
To: git@vger.kernel.org
Cc: gitster@pobox.com, git@drmicha.warpmail.net, spearce@spearce.org,
artagnon@gmail.com, schwab@linux-m68k.org,
soosthoek@nieuwland.nl
Subject: [PATCH 1/2] Allow __git_ps1 to be used in PROMPT_COMMAND
Date: Wed, 10 Oct 2012 21:31:58 +0200 [thread overview]
Message-ID: <20121010193158.GA6454@simaj.xs4all.nl> (raw)
In-Reply-To: <7v7gr0k6jv.fsf@alter.siamese.dyndns.org>
Changes __git_ps1 to allow its use as PROMPT_COMMAND in bash
in addition to setting PS1 with __git_ps1 in a command substitution.
PROMPT_COMMAND has advantages for using color without running
into prompt-wrapping issues. Only by assigning \[ and \] to PS1
directly can bash know that these and the enclosed zero-width codes in
between don't count in the length of the prompt.
Signed-off-by: Simon Oosthoek <s.oosthoek@xs4all.nl>
---
contrib/completion/git-prompt.sh | 51 +++++++++++++++++++++++++++++++++-----
1 file changed, 45 insertions(+), 6 deletions(-)
diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index 29b1ec9..4fbc1e6 100644
--- a/contrib/completion/git-prompt.sh
+++ b/contrib/completion/git-prompt.sh
@@ -10,9 +10,14 @@
# 1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
# 2) Add the following line to your .bashrc/.zshrc:
# source ~/.git-prompt.sh
-# 3) Change your PS1 to also show the current branch:
-# Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
-# ZSH: PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ '
+# 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
+# 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 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
@@ -194,11 +199,39 @@ __git_ps1_show_upstream ()
# __git_ps1 accepts 0 or 1 arguments (i.e., format string)
-# returns text to add to bash PS1 prompt (includes branch name)
+# when called from PS1 using command substitution
+# in this mode it prints text to add to bash PS1 prompt (includes branch name)
+#
+# __git_ps1 requires 2 arguments when called from PROMPT_COMMAND (pc)
+# in that case it _sets_ PS1. The arguments are parts of a PS1 string.
+# when both arguments are given, the first is prepended and the second appended
+# to the state string when assigned to PS1.
__git_ps1 ()
{
+ local pcmode=no
+ #defaults/examples:
+ local ps1pc_start='\u@\h:\w '
+ local ps1pc_end='\$ '
+ local printf_format='(%s)'
+
+ case "$#" in
+ 2) pcmode=yes
+ ps1pc_start="$1"
+ ps1pc_end="$2"
+ ;;
+ 0|1) printf_format="${1:-$printf_format}"
+ ;;
+ *) return
+ ;;
+ esac
+
local g="$(__gitdir)"
- if [ -n "$g" ]; then
+ if [ -z "$g" ]; then
+ if [ $pcmode = yes ]; then
+ #In PC mode PS1 always needs to be set
+ PS1="$ps1pc_start$ps1pc_end"
+ fi
+ else
local r=""
local b=""
if [ -f "$g/rebase-merge/interactive" ]; then
@@ -284,6 +317,12 @@ __git_ps1 ()
fi
local f="$w$i$s$u"
- printf -- "${1:- (%s)}" "$c${b##refs/heads/}${f:+ $f}$r$p"
+ if [ $pcmode = yes ]; then
+ PS1="$ps1pc_start("
+ PS1="$PS1$c${b##refs/heads/}${f:+ $f}$r$p"
+ PS1="$PS1)$ps1pc_end"
+ else
+ printf -- "$printf_format" "$c${b##refs/heads/}${f:+ $f}$r$p"
+ fi
fi
}
--
1.7.9.5
next prev parent reply other threads:[~2012-10-10 19:32 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-26 15:00 bash completion with colour hints Simon Oosthoek
2012-09-26 15:24 ` Ramkumar Ramachandra
2012-09-26 19:25 ` Simon Oosthoek
2012-09-27 6:53 ` Junio C Hamano
2012-09-27 8:53 ` Michael J Gruber
2012-09-27 8:55 ` Michael J Gruber
2012-09-27 9:16 ` Simon Oosthoek
2012-09-27 10:05 ` Andreas Schwab
2012-09-27 11:57 ` Simon Oosthoek
2012-09-28 11:40 ` [PATCH] Add __git_ps1_pc to use as PROMPT_COMMAND Simon Oosthoek
2012-09-28 17:58 ` Junio C Hamano
2012-10-01 9:13 ` Simon Oosthoek
2012-10-01 17:16 ` Junio C Hamano
2012-10-01 18:42 ` Simon Oosthoek
2012-10-01 19:13 ` Junio C Hamano
2012-10-01 19:27 ` Simon Oosthoek
2012-10-01 19:54 ` Junio C Hamano
2012-10-01 20:56 ` Simon Oosthoek
2012-10-01 21:09 ` Junio C Hamano
2012-10-02 7:38 ` Michael J Gruber
2012-10-02 8:01 ` Simon Oosthoek
2012-10-02 17:01 ` Junio C Hamano
2012-10-02 19:50 ` Simon Oosthoek
2012-10-02 20:18 ` Junio C Hamano
2012-10-05 21:09 ` [PATCH 1/2] Allow __git_ps1 to be used in PROMPT_COMMAND Simon Oosthoek
2012-10-08 18:12 ` Junio C Hamano
2012-10-08 19:50 ` Simon Oosthoek
2012-10-08 21:17 ` Junio C Hamano
2012-10-10 19:31 ` Simon Oosthoek [this message]
2012-10-10 23:00 ` Junio C Hamano
2012-10-10 19:32 ` [PATCH 2/2] show color hints based on state of the git tree Simon Oosthoek
2012-10-10 19:37 ` [PATCH 1/2] Allow __git_ps1 to be used in PROMPT_COMMAND Simon Oosthoek
2012-10-10 19:38 ` [PATCH 2/2] show color hints based on state of the git tree Simon Oosthoek
2012-10-05 21:10 ` Simon Oosthoek
2012-10-15 8:23 ` Michael J Gruber
2012-10-15 9:01 ` Simon Oosthoek
2012-10-15 9:13 ` Michael J Gruber
2012-10-15 10:34 ` Simon Oosthoek
2012-10-15 13:20 ` Simon Oosthoek
2012-10-15 15:19 ` Michael J Gruber
[not found] ` <CAPc5daVUyAuznmrT+-yqvPR0gd38oiWmi2k+BFVV1s9ouMUt0Q@mail.gmail.com>
2012-10-15 15:15 ` Simon Oosthoek
2012-10-15 18:10 ` Junio C Hamano
2012-10-16 5:32 ` [PATCH 3/3] Change colors to be based on git status -sb in color mode Simon Oosthoek
2012-10-16 15:58 ` Junio C Hamano
2012-10-16 19:34 ` Simon Oosthoek
2012-10-16 21:30 ` Junio C Hamano
2012-10-16 22:04 ` Junio C Hamano
2012-10-17 7:17 ` Simon Oosthoek
2012-10-08 15:00 ` [PATCH] Add __git_ps1_pc to use as PROMPT_COMMAND Simon Oosthoek
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=20121010193158.GA6454@simaj.xs4all.nl \
--to=s.oosthoek@xs4all.nl \
--cc=artagnon@gmail.com \
--cc=git@drmicha.warpmail.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=schwab@linux-m68k.org \
--cc=soosthoek@nieuwland.nl \
--cc=spearce@spearce.org \
/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).