Skip to content

Commit b6348a9

Browse files
d-nettoKristofferC
authored andcommitted
update --gcthreads section in command line options (#52645)
Make these consistent with what's shown by `julia --help`. Fixes JuliaLang/www.julialang.org#1997. (cherry picked from commit e7e8b89)
1 parent fc1d751 commit b6348a9

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/man/julia.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,9 @@ process affinity is not configured, it uses the number of CPU
119119
threads.
120120

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

126126
.TP
127127
-p, --procs {N|auto}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ The following is a complete list of command-line switches available when launchi
107107
|`-E`, `--print <expr>` |Evaluate `<expr>` and display the result|
108108
|`-L`, `--load <file>` |Load `<file>` immediately on all processors|
109109
|`-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.|
110-
| `--gcthreads {N}` |Enable N GC threads; If unspecified is set to half of the compute worker threads.|
110+
| `--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.|
111111
|`-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)|
112112
|`--machine-file <file>` |Run processes on hosts listed in `<file>`|
113113
|`-i` |Interactive mode; REPL runs and `isinteractive()` is true|

0 commit comments

Comments
 (0)