Skip to content

Commit

Permalink
Copy editing in "Environment variables" docs (#30330)
Browse files Browse the repository at this point in the history
  • Loading branch information
donm authored and JeffBezanson committed Dec 12, 2018
1 parent ee5e9a0 commit 99b7b75
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions doc/src/manual/environment-variables.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
# Environment Variables

Julia may be configured with a number of environment variables, either in the
usual way of the operating system, or in a portable way from within Julia.
Suppose you want to set the environment variable `JULIA_EDITOR` to
`vim`, then either type `ENV["JULIA_EDITOR"] = "vim"` for instance in the REPL
to make this change on a case by case basis, or add the same to the user
configuration file `~/.julia/config/startup.jl` in the user's home directory to have
a permanent effect. The current value of the same environment variable is
Julia can be configured with a number of environment variables, set either in
the usual way for each operating system, or in a portable way from within Julia.
Supposing that you want to set the environment variable `JULIA_EDITOR` to `vim`,
you can type `ENV["JULIA_EDITOR"] = "vim"` (for instance, in the REPL) to make
this change on a case by case basis, or add the same to the user configuration
file `~/.julia/config/startup.jl` in the user's home directory to have a
permanent effect. The current value of the same environment variable can be
determined by evaluating `ENV["JULIA_EDITOR"]`.

The environment variables that Julia uses generally start with `JULIA`. If
[`InteractiveUtils.versioninfo`](@ref) is called with `verbose` equal to `true`, then the
[`InteractiveUtils.versioninfo`](@ref) is called with the keyword `verbose=true`, then the
output will list defined environment variables relevant for Julia, including
those for which `JULIA` appears in the name.

!!! note

Some variables, such as `JULIA_NUM_THREADS` and `JULIA_PROJECT` need to be set before Julia
Some variables, such as `JULIA_NUM_THREADS` and `JULIA_PROJECT`, need to be set before Julia
starts, therefore adding these to `~/.julia/config/startup.jl` is too late in the startup process.
These must either be set manually before launching Julia through bash with
`export JULIA_NUM_THREADS=4` etc. or added to `-/.bashrc` and/or `~/.bash_profile` to achieve persistence.
In Bash, environment variables can either be set manually by running, e.g.,
`export JULIA_NUM_THREADS=4` before starting Julia, or by adding the same command to
`-/.bashrc` or `~/.bash_profile` to set the variable each time Bash is started.

## File locations

Expand Down Expand Up @@ -76,7 +77,7 @@ and a global configuration search path of

A directory path that points to the current Julia project. Setting this
environment variable has the same effect as specifying the `--project` start-up
option, but `--project` has higher precedence. If the variable is set to `@.`,
option, but `--project` has higher precedence. If the variable is set to `@.` then
Julia tries to find a project directory that contains `Project.toml` or
`JuliaProject.toml` file from the current directory and its parents. See also
the chapter on [Code Loading](@ref).
Expand All @@ -88,8 +89,8 @@ the chapter on [Code Loading](@ref).
### `JULIA_LOAD_PATH`

A separated list of absolute paths that are to be appended to the variable
[`LOAD_PATH`](@ref). (In Unix-like systems, the path separator is `:`; in
Windows systems, the path separator is `;`.) The `LOAD_PATH` variable is where
[`LOAD_PATH`](@ref). (In Unix-like systems, `:` is the path separator; in
Windows systems, `;` is the path separator.) The `LOAD_PATH` variable is where
[`Base.require`](@ref) and `Base.load_in_path()` look for code; it defaults to
the absolute path
`$JULIA_HOME/../share/julia/stdlib/v$(VERSION.major).$(VERSION.minor)` so that,
Expand Down Expand Up @@ -185,7 +186,7 @@ affinitized. Otherwise, Julia lets the operating system handle thread policy.
Environment variables that determine how REPL output should be formatted at the
terminal. Generally, these variables should be set to [ANSI terminal escape
sequences](http://ascii-table.com/ansi-escape-sequences.php). Julia provides
a high-level interface with much of the same functionality: see the section on
a high-level interface with much of the same functionality; see the section on
[The Julia REPL](@ref).

### `JULIA_ERROR_COLOR`
Expand Down Expand Up @@ -283,11 +284,10 @@ event listener for just-in-time (JIT) profiling.

This environment variable only has an effect if Julia was compiled with JIT
profiling support, using either

* Intel's [VTune™ Amplifier](https://software.intel.com/en-us/intel-vtune-amplifier-xe)
(`USE_INTEL_JITEVENTS` set to `1` in the build configuration), or
* [OProfile](http://oprofile.sourceforge.net/news/) (`USE_OPROFILE_JITEVENTS` set to `1`
in the build configuration).
* Intel's [VTune™ Amplifier](https://software.intel.com/en-us/intel-vtune-amplifier-xe)
(`USE_INTEL_JITEVENTS` set to `1` in the build configuration), or
* [OProfile](http://oprofile.sourceforge.net/news/) (`USE_OPROFILE_JITEVENTS` set to `1`
in the build configuration).

### `JULIA_LLVM_ARGS`

Expand Down

2 comments on commit 99b7b75

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Executing the daily benchmark build, I will reply here when finished:

@nanosoldier runbenchmarks(ALL, isdaily = true)

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your benchmark job has completed - possible performance regressions were detected. A full report can be found here. cc @ararslan

Please sign in to comment.