Doc environment variables (Continuation of #20162) #21480

m-j-w · 2017-04-21T21:22:12Z

This continues the original PR #20162 of @kbdave134.
See the commit message for the changes made.

tkelman · 2017-04-21T21:36:18Z

doc/src/manual/environment-variables.md

+
+The absolute path of the directory containing the Julia executable, which sets
+the global variable [`Base.JULIA_HOME`](@ref). If `$JULIA_HOME` is not set, then
+`Base.JULIA_HOME` defaults to its compile-time value.


so this is still incorrect

In what sense?

the value of Base.JULIA_HOME is determined at run time, not compile time

(and sorry for not taking your comments into account, they didn't show up on the last version...)

github can be weird about when it does or does not show old review comments, no problem

tkelman · 2017-04-21T21:40:48Z

doc/src/manual/environment-variables.md

+
+### `JULIA_PKGDIR`
+
+The path of the parent directory `Dir._pkgroot()` for the version-specific Julia


Pkg.Dir._pkgroot(), since Dir isn't re-exported from Pkg

tkelman · 2017-04-21T21:41:22Z

doc/src/manual/environment-variables.md

+$HOME/.julia
+```
+
+Then the repository location [`Base.Pkg.dir`](@ref) for a given Julia version is


Pkg is exported from Base, so we could leave off Base. here

tkelman · 2017-04-21T21:42:36Z

doc/src/manual/environment-variables.md

+paths
+
+```
+$JULIA_HOME/../local/share/julia/site/v$(Base.VERSION.major).$(Base.VERSION.minor)


we could leave off Base. from VERSION and LOAD_PATH since those are exported from Base

tkelman · 2017-04-21T21:47:29Z

doc/src/manual/environment-variables.md

+### `JULIA_GC_WAIT_FOR_DEBUGGER`
+
+If set to anything besides `0`, then the Julia garbage collector will wait for
+the debugger to attach instead of aborting whenever there's a critical error.


"a debugger" ? #20162 (comment)

tkelman · 2017-04-21T21:48:07Z

doc/src/manual/environment-variables.md

+!!! note
+
+    This environment variable has an effect only if Julia was compiled with
+    `JL_DEBUG_BUILD` set—in particular, the `julia-debug` executable is always


"set - in particular" #20162 (comment)

tkelman · 2017-04-21T22:30:15Z

The previous commit here failed the doc build. Does this build for you locally? Shouldn't do [ci skip] here.

tkelman · 2017-04-21T22:35:33Z

Probably also want to squash together any commits by the same author that failed the whitespace check (or doc build). If you'd prefer, I could do that as long as you enabled "allow edits by maintainers."

m-j-w · 2017-04-21T22:45:47Z

Okay, I squashed my commits and made the documentation building work again (removed a faulty reference at the top introduced by myself)

Rebase didn't work due to conflicts. If possible, I'd prefer if you'd make that squash and take a look at the conflict (it was in io.jl). Not sure which one to pick.

"Allow edits from maintainers" is enabled.

tkelman · 2017-04-21T23:10:51Z

I didn't see a conflict. Rebased though, squashed the original PR content into 4 commits, each of which passes make check-whitespace docs locally, plus your additional commit, and removed [ci skip] and the @ signs from the commit message (that would send these users a notification every time anyone rebases the commit, so is best to avoid)

m-j-w · 2017-04-21T23:16:06Z

Great, thanks. And good to know with the @ signs.

omus · 2017-04-22T03:24:35Z

doc/src/manual/environment-variables.md

+The environment variables that Julia uses generally start with `JULIA`. If
+[`Base.versioninfo`](@ref) is called with `verbose` equal to `true`, then the
+output will list all environment variables for which `JULIA` appears in the
+name.


Change to: "output will list all defined environmental variables"

omus · 2017-04-22T03:28:21Z

doc/src/manual/environment-variables.md

+/home/alice/.julia
+```
+
+and the package repository for version 0.5 of Julia would be


Seems wordy. Maybe change to "for Julia 0.5 would be"

I disagree. It highlights the version being the point why being mentioned as an example, rather than being a specific behaviour of version 0.5

omus · 2017-04-22T03:30:55Z

doc/src/manual/environment-variables.md

+## REPL formatting
+
+Environment variables that determine how REPL output should be formatted at the
+terminal.  Generally, these variables should be set to [ANSI terminal escape


Change to one space after period.

small typo forgot about make.jl Line width to 80 characters; strip trailing spaces; line breaks after h3 added threading/debugging entries and cross-references. Increase text width to 92 columns, cull spurious line breaks, switch to admonition syntax, simplify cross-references, fix title. Trailing whitespace Admonition line breaks; editor envvar heading. clarify integer types, remove outdated notes, whitespace change whitespace No windows shell, English fixes, delete reference to base, clarify 'r', julia-debug.

Please take into account that this file was originally authored by kbdave314. - Explain how to set environment variables (fredrikekre) - Corrected `Base.REPL.find_history_file()` (GregPlowman) - Mentioned editor is a command with vim as example (yuyichao) Also made it stick to 80 character text width. Implemented review comments of tkelman - JULIA_HOME determined at run-time. - added `Pkg` to `Dir...` - removed `Base` from `Base.Pkg....`, `Base.VERSION....` and `Base.LOAD_PATH`. - "a debugger" - whitespace " - " Made 'make docs' work again...by removing the faulty reference to JULIA_HOME introduced by myself. - clarified output of environment variables. - removed a blank Bumped mentioned versions to 0.6 - its a 0.6 documentation after all. Squashed commits to one for each author.

KristofferC · 2017-04-23T07:14:05Z

Really nice to have this merged. Thanks @kbdave314 and @m-j-w

m-j-w · 2017-04-23T07:15:58Z

Indeed, thanks @kbdave314 for the effort. Now I don't have to search the source a little less frequently!

fredrikekre · 2017-04-23T10:11:43Z

Should close #5432, #19988 as noted in the original PR #20162

tkelman reviewed Apr 21, 2017

View reviewed changes

m-j-w force-pushed the doc-environment-variables-continued branch from d6d5381 to f56ff83 Compare April 21, 2017 22:43

tkelman force-pushed the doc-environment-variables-continued branch from f56ff83 to 1c63f27 Compare April 21, 2017 23:08

omus reviewed Apr 22, 2017

View reviewed changes

m-j-w force-pushed the doc-environment-variables-continued branch 2 times, most recently from a789161 to cded04d Compare April 22, 2017 07:07

m-j-w force-pushed the doc-environment-variables-continued branch from cded04d to a8de1ac Compare April 22, 2017 10:59

tkelman merged commit e2a4c32 into JuliaLang:master Apr 23, 2017

m-j-w deleted the doc-environment-variables-continued branch April 23, 2017 10:34

fredrikekre mentioned this pull request May 26, 2017

Setting JULIA_HOME causes an error on start up #18994

Closed


		### `JULIA_PKGDIR`

		The path of the parent directory `Dir._pkgroot()` for the version-specific Julia

Uh oh!

Doc environment variables (Continuation of #20162) #21480

Doc environment variables (Continuation of #20162) #21480

Uh oh!

Conversation

m-j-w commented Apr 21, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tkelman commented Apr 21, 2017

Uh oh!

tkelman commented Apr 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

m-j-w commented Apr 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tkelman commented Apr 21, 2017

Uh oh!

m-j-w commented Apr 21, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KristofferC commented Apr 23, 2017

Uh oh!

m-j-w commented Apr 23, 2017

Uh oh!

fredrikekre commented Apr 23, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

tkelman commented Apr 21, 2017 •

edited

Loading

m-j-w commented Apr 21, 2017 •

edited

Loading