Skip to content

Commit

Permalink
update --gcthreads section in command line options (JuliaLang#52645)
Browse files Browse the repository at this point in the history
Make these consistent with what's shown by `julia --help`.

Fixes JuliaLang/www.julialang.org#1997.
  • Loading branch information
d-netto committed Dec 27, 2023
1 parent 66e9410 commit e7e8b89
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions doc/man/julia.1
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ process affinity is not configured, it uses the number of CPU
threads.

.TP
--gcthreads <n>
Enable n GC threads; If unspecified is set to half of the
compute worker threads.
--gcthreads=N[,M]
Use N threads for the mark phase of GC and M (0 or 1) threads for the concurrent sweeping phase of GC.
N is set to half of the number of compute threads and M is set to 0 if unspecified.

.TP
-p, --procs {N|auto}
Expand Down
2 changes: 1 addition & 1 deletion doc/src/manual/command-line-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ The following is a complete list of command-line switches available when launchi
|`-E`, `--print <expr>` |Evaluate `<expr>` and display the result|
|`-L`, `--load <file>` |Load `<file>` immediately on all processors|
|`-t`, `--threads {N\|auto}` |Enable N threads; `auto` tries to infer a useful default number of threads to use but the exact behavior might change in the future. Currently, `auto` uses the number of CPUs assigned to this julia process based on the OS-specific affinity assignment interface, if supported (Linux and Windows). If this is not supported (macOS) or process affinity is not configured, it uses the number of CPU threads.|
| `--gcthreads {N}` |Enable N GC threads; If unspecified is set to half of the compute worker threads.|
| `--gcthreads=N[,M]` |Use N threads for the mark phase of GC and M (0 or 1) threads for the concurrent sweeping phase of GC. N is set to half of the number of compute threads and M is set to 0 if unspecified.|
|`-p`, `--procs {N\|auto}` |Integer value N launches N additional local worker processes; `auto` launches as many workers as the number of local CPU threads (logical cores)|
|`--machine-file <file>` |Run processes on hosts listed in `<file>`|
|`-i` |Interactive mode; REPL runs and `isinteractive()` is true|
Expand Down

0 comments on commit e7e8b89

Please sign in to comment.