Re: [PATCH v2 7/8] git-prompt: ta-da! document usage in other shells

[Patrick Steinhardt <ps@pks.im>]

On Thu, Aug 15, 2024 at 01:14:12PM +0000, Avi Halachmi (:avih) via GitGitGadget wrote:
> diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
> index c3dd38f847c..75f272daa21 100644
> --- a/contrib/completion/git-prompt.sh
> +++ b/contrib/completion/git-prompt.sh
> @@ -8,8 +8,8 @@
>  # To enable:
>  #
>  #    1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
> -#    2) Add the following line to your .bashrc/.zshrc:
> -#        source ~/.git-prompt.sh
> +#    2) Add the following line to your .bashrc/.zshrc/.profile:
> +#        . ~/.git-prompt.sh   # dot path/to/this-file
>  #    3a) Change your PS1 to call __git_ps1 as
>  #        command-substitution:
>  #        Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
> @@ -30,6 +30,8 @@
>  #        Optionally, you can supply a third argument with a printf
>  #        format string to finetune the output of the branch status
>  #
> +#    See notes below about compatibility with other shells.
> +#
>  # The repository status will be displayed only if you are currently in a
>  # git repository. The %s token is the placeholder for the shown status.
>  #
> @@ -106,6 +108,33 @@
>  # directory is set up to be ignored by git, then set
>  # GIT_PS1_HIDE_IF_PWD_IGNORED to a nonempty value. Override this on the
>  # repository level by setting bash.hideIfPwdIgnored to "false".
> +#
> +# Conpatibility with other shells (beyond bash/zsh):

s/Conpatibility/Compatibility/

Patrick