Skip to content

Commit

Permalink
Document --heap-size-hint and be more clear about addprocs not passin…
Browse files Browse the repository at this point in the history
…g any command line args.
  • Loading branch information
evetion committed Aug 8, 2023
1 parent aca081d commit 01e91e2
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/src/manual/arrays.md
Original file line number Diff line number Diff line change
Expand Up @@ -881,7 +881,7 @@ in their implementations, other arrays — like [`Diagonal`](@ref) — need the
full set of cartesian indices to do their lookup (see [`IndexStyle`](@ref) to
introspect which is which).

!!! warnings
!!! warning

When iterating over all the indices for an array, it is
better to iterate over [`eachindex(A)`](@ref) instead of `1:length(A)`.
Expand Down
1 change: 1 addition & 0 deletions doc/src/manual/command-line-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ The following is a complete list of command-line switches available when launchi
|`--track-allocation[={none*\|user\|all}]` |Count bytes allocated by each source line (omitting setting is equivalent to "user")|
|`--track-allocation=@<path>` |Count bytes but only in files that fall under the given file path/directory. The `@` prefix is required to select this option. A `@` with no path will track the current directory.|
|`--bug-report=KIND` |Launch a bug report session. It can be used to start a REPL, run a script, or evaluate expressions. It first tries to use BugReporting.jl installed in current environment and falls back to the latest compatible BugReporting.jl if not. For more information, see `--bug-report=help`.|
|`--heap-size-hint=<size>` |Forces garbage collection if memory usage is higher than that value. The memory hint might be specified in megabytes(500M) or gigabytes(1G)."
|`--compile={yes*\|no\|all\|min}` |Enable or disable JIT compiler, or request exhaustive or minimal compilation|
|`--output-o <name>` |Generate an object file (including system image data)|
|`--output-ji <name>` |Generate a system image data file (.ji)|
Expand Down
9 changes: 5 additions & 4 deletions doc/src/manual/distributed-computing.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,10 +270,11 @@ julia> addprocs(2)
Module [`Distributed`](@ref man-distributed) must be explicitly loaded on the master process before invoking [`addprocs`](@ref).
It is automatically made available on the worker processes.

Note that workers do not run a `~/.julia/config/startup.jl` startup script, nor do they synchronize
their global state (such as global variables, new method definitions, and loaded modules) with any
of the other running processes. You may use `addprocs(exeflags="--project")` to initialize a worker with
a particular environment, and then `@everywhere using <modulename>` or `@everywhere include("file.jl")`.
!!! note
Note that workers do not run a `~/.julia/config/startup.jl` startup script, nor do they synchronize
their global state (such as command-line switches, global variables, new method definitions, and loaded modules) with any
of the other running processes. You may use `addprocs(exeflags="--project")` to initialize a worker with
a particular environment, and then `@everywhere using <modulename>` or `@everywhere include("file.jl")`.

Other types of clusters can be supported by writing your own custom `ClusterManager`, as described
below in the [ClusterManagers](@ref) section.
Expand Down
3 changes: 3 additions & 0 deletions stdlib/Distributed/src/managers.jl
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,9 @@ Launch `np` workers on the local host using the in-built `LocalManager`.
Local workers inherit the current package environment (i.e., active project,
[`LOAD_PATH`](@ref), and [`DEPOT_PATH`](@ref)) from the main process.
!!! warning
Local workers do not run a `~/.julia/config/startup.jl` startup script, nor do they synchronize their global state.
**Keyword arguments**:
- `restrict::Bool`: if `true` (default) binding is restricted to `127.0.0.1`.
- `dir`, `exename`, `exeflags`, `env`, `topology`, `lazy`, `enable_threaded_blas`: same effect
Expand Down

0 comments on commit 01e91e2

Please sign in to comment.