aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src
diff options
context:
space:
mode:
authorGravatar Kurtis Rader <krader@skepticism.us>2016-04-06 17:18:06 -0700
committerGravatar Kurtis Rader <krader@skepticism.us>2016-04-06 17:18:06 -0700
commit35e282928ade1b46f9faec8d8bd04c6fe66eafcc (patch)
tree03c4eba552830edbbedbfc3619cf0842be6da2a3 /doc_src
parent02f18cae0aa9c44beade38b1b14c9f59d54b9078 (diff)
clarify documentation for the `source` command
Make it clear that fish 2.3.0 changed how `$argv` is initialized.
Diffstat (limited to 'doc_src')
-rw-r--r--doc_src/source.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc_src/source.txt b/doc_src/source.txt
index dba14045..abb99af5 100644
--- a/doc_src/source.txt
+++ b/doc_src/source.txt
@@ -7,7 +7,7 @@ source FILENAME [ARGUMENTS...]
\subsection source-description Description
-`source` evaluates the commands of the specified file in the current shell. This is different from starting a new process to perform the commands (i.e. `fish < FILENAME`) since the commands will be evaluated by the current shell, which means that changes in shell variables will affect the current shell. If additional arguments are specified after the file name, they will be inserted into the $argv variable.
+`source` evaluates the commands of the specified file in the current shell. This is different from starting a new process to perform the commands (i.e. `fish < FILENAME`) since the commands will be evaluated by the current shell, which means that changes in shell variables will affect the current shell. If additional arguments are specified after the file name, they will be inserted into the `$argv` variable. The `$argv` variable will not include the name of the sourced file.
If no file is specified, or if the file name '`-`' is used, stdin will be read.
@@ -22,3 +22,7 @@ The return status of `source` is the return status of the last job to execute. I
source ~/.config/fish/config.fish
# Causes fish to re-read its initialization file.
\endfish
+
+\subsection Caveats
+
+In fish versions prior to 2.3.0 the `$argv` variable would have a single element (the name of the sourced file) if no arguments are present. Otherwise it would contain arguments without the name of the sourced file. That behavior was very confusing and unlike other shells such as bash and zsh.