Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2025-01-12 13:08:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

clarify documentation for the source command

Browse source 
Make it clear that fish 2.3.0 changed how `$argv` is initialized.
This commit is contained in:
Kurtis Rader 2016-04-06 17:18:06 -07:00
parent 02f18cae0a
commit 35e282928a
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc_src/source.txt
View file

@ -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.