Mention that the = part of --project is optional. Add to regular …

…Julia docs as well. (#29731)
JuliaLang · Oct 20, 2018 · 44dd917 · 44dd917
1 parent 2885b62
commit 44dd917
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/doc/man/julia.1 b/doc/man/julia.1
@@ -64,9 +64,10 @@ Display version information
 Print help message
 
 .TP
---project=<dir>/@.
-Set <dir> as the home project/environment. The @. option will search through
-parent directories until a Project.toml or JuliaProject.toml file is found.
+--project[=<dir>/@.]
+Set <dir> as the home project/environment. The default @. option will search
+through parent directories until a Project.toml or JuliaProject.toml file is
+found.
 
 .TP
 -J, --sysimage <file>

diff --git a/doc/src/manual/getting-started.md b/doc/src/manual/getting-started.md
@@ -95,6 +95,7 @@ julia [switches] -- [programfile] [args...]
 |:---                                   |:---|
 |`-v`, `--version`                      |Display version information|
 |`-h`, `--help`                         |Print this message|
+|`--project[={<dir>|@.}]`               |Set <dir> as the home project/environment. The default @. option will search through parent directories until a Project.toml or JuliaProject.toml file is found.
 |`-J`, `--sysimage <file>`              |Start up with the given system image file|
 |`-H`, `--home <dir>`                   |Set location of `julia` executable|
 |`--startup-file={yes\|no}`             |Load `~/.julia/config/startup.jl`|

diff --git a/src/jloptions.c b/src/jloptions.c
@@ -78,7 +78,7 @@ static const char opts[]  =
     " -h, --help                Print this message\n\n"
 
     // startup options
-    " --project=<dir>/@.        Set <dir> as the home project/environment\n"
+    " --project[={<dir>|@.}]    Set <dir> as the home project/environment\n"
     " -J, --sysimage <file>     Start up with the given system image file\n"
     " -H, --home <dir>          Set location of `julia` executable\n"
     " --startup-file={yes|no}   Load `~/.julia/config/startup.jl`\n"