From 44dd917cbaf5b0a13f146e83a292a5f4412679ac Mon Sep 17 00:00:00 2001 From: Simon Byrne Date: Sat, 20 Oct 2018 02:27:35 -0700 Subject: [PATCH] Mention that the `=` part of `--project` is optional. Add to regular Julia docs as well. (#29731) --- doc/man/julia.1 | 7 ++++--- doc/src/manual/getting-started.md | 1 + src/jloptions.c | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/man/julia.1 b/doc/man/julia.1 index 0a5cc2aa49024..ec9435d35340c 100644 --- a/doc/man/julia.1 +++ b/doc/man/julia.1 @@ -64,9 +64,10 @@ Display version information Print help message .TP ---project=/@. -Set as the home project/environment. The @. option will search through -parent directories until a Project.toml or JuliaProject.toml file is found. +--project[=/@.] +Set 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 diff --git a/doc/src/manual/getting-started.md b/doc/src/manual/getting-started.md index 530fe446f603c..7e7ba3c05e5ea 100644 --- 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[={|@.}]` |Set 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 ` |Start up with the given system image file| |`-H`, `--home ` |Set location of `julia` executable| |`--startup-file={yes\|no}` |Load `~/.julia/config/startup.jl`| diff --git a/src/jloptions.c b/src/jloptions.c index 6140bbd5e22a3..42fdafb9d0dcd 100644 --- 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=/@. Set as the home project/environment\n" + " --project[={|@.}] Set as the home project/environment\n" " -J, --sysimage Start up with the given system image file\n" " -H, --home Set location of `julia` executable\n" " --startup-file={yes|no} Load `~/.julia/config/startup.jl`\n"