[PATCH v2 1/2] git-prompt: make __git_eread intended use explicit
- From
Robert Abel <rabel@robertabel.eu>
- Date
- Dec 1, 2017, 23:31 UTC
- Message-ID
- <20171201233133.30011-1-rabel@robertabel.eu>
- In-Reply-To
- <alpine.DEB.2.21.1.1712011143320.98586@virtualbox>
__git_eread is used to read a single line of a given file (if it exists) into a variable without the EOL. All six current users of __git_eread use it that way and don't expect multi-line content.
Thus, add a comment and explicitly use $2 instead of shifting the args down and using $@.
Signed-off-by: Robert Abel <rabel@robertabel.eu> --- contrib/completion/git-prompt.sh | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh index c6cbef38c..41a471957 100644 --- a/contrib/completion/git-prompt.sh +++ b/contrib/completion/git-prompt.sh @@ -278,11 +278,12 @@ __git_ps1_colorize_gitstring () r="$c_clear$r" } +# Helper function to read the first line of a file into a variable. +# __git_eread requires 2 arguments, the file path and the name of the +# variable, in that order. __git_eread () { - local f="$1" - shift - test -r "$f" && read "$@" <"$f" + test -r "$1" && read "$2" <"$1" } # __git_ps1 accepts 0 or 1 arguments (i.e., format string)
-- 2.15.1