git-prompt: make __git_eread intended use explicit

__git_eread is used to read a single line of a given file (if it exists) into a single variable stripping the EOL. This patch removes the unused capability to split file contents into tokens by passing multiple variable names. Add a comment and explicitly use $2 instead of misleading $@ as argument to the read builtin command. Signed-off-by: Robert Abel <rabel@robertabel.eu> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Robert Abel committed Dec 6, 2017 at 00:39 UTC 5501f500b22116166c892d632382c9d497da822c
1 file changed +4 -3
contrib/completion/git-prompt.sh
+4 -3
@@ -278,11 +278,12 @@ __git_ps1_colorize_gitstring ()
278 r="$c_clear$r"
279 }
280
281 +# Helper function to read the first line of a file into a variable.
282 +# __git_eread requires 2 arguments, the file path and the name of the
283 +# variable, in that order.
284 __git_eread ()
285 {
283 - local f="$1"
284 - shift
285 - test -r "$f" && read "$@" <"$f"
286 + test -r "$1" && read "$2" <"$1"
287 }
288
289 # __git_ps1 accepts 0 or 1 arguments (i.e., format string)