Skip to content

Commit 29a7ce4

Browse files
authored
Add a note clearifying option parsing (JuliaLang#56285)
To help with JuliaLang#56274
1 parent 9160e04 commit 29a7ce4

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/src/manual/command-line-interface.md

+4
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,10 @@ The following is a complete list of command-line switches available when launchi
222222
|`--permalloc-pkgimg={yes\|no*}` |Copy the data section of package images into memory|
223223
|`--trim={no*\|safe\|unsafe\|unsafe-warn}` |Build a sysimage including only code provably reachable from methods marked by calling `entrypoint`. The three non-default options differ in how they handle dynamic call sites. In safe mode, such sites result in compile-time errors. In unsafe mode, such sites are allowed but the resulting binary might be missing needed code and can throw runtime errors. With unsafe-warn, such sites will trigger warnings at compile-time and might error at runtime.|
224224

225+
Options that have the form `--option={...}` can be specified either as `--option=value` or as `--option value`. For example, `julia --banner=no` is equivalent to `julia --banner no`. This is especially relevant for options that take a filename for output, because forgetting to specifying the argument for (say) `--trace-compile` will cause the option following it to be interpreted as the filename, possibly unintentionally overwriting it.
226+
227+
Note that options of the form `--option[=...]` can **not** be specified as `--option value`, but only as `--option=value` (or simply `--option`, when no argument is provided).
228+
225229
!!! compat "Julia 1.1"
226230
In Julia 1.0, the default `--project=@.` option did not search up from the root
227231
directory of a Git repository for the `Project.toml` file. From Julia 1.1 forward, it

0 commit comments

Comments
 (0)