Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix documentation build of EscapeAnalysis.jl #44257

Merged
merged 1 commit into from
Feb 20, 2022
Merged

fix documentation build of EscapeAnalysis.jl #44257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ else
analytics = "UA-28835595-6",
collapselevel = 1,
sidebar_sitename = false,
ansicolor = true,
)
end

Expand Down
5 changes: 3 additions & 2 deletions doc/src/devdocs/EscapeAnalysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `EscapeAnalysis`

`Core.Compiler.EscapeAnalysis` is a compiler utility module that aims to analyze
escape information of [Julia's SSA-form IR](@ref Julia-SSA-form-IR) a.k.a. `IRCode`.

Expand All @@ -18,8 +20,7 @@ This escape analysis aims to:
You can give a try to the escape analysis by loading the `EAUtils.jl` utility script that
define the convenience entries `code_escapes` and `@code_escapes` for testing and debugging purposes:
```@repl EAUtils
include(normpath(Sys.BINDIR::String, "..", "share", "julia", "test", "testhelpers", "EAUtils.jl"))
using EAUtils
include(normpath(Sys.BINDIR, "..", "share", "julia", "test", "compiler", "EscapeAnalysis", "EAUtils.jl")); using .EAUtils
mutable struct SafeRef{T}
x::T
Expand Down
2 changes: 1 addition & 1 deletion doc/src/manual/multi-threading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ specified, then `-t`/`--threads` takes precedence.

The number of threads can either be specified as an integer (`--threads=4`) or as `auto`
(`--threads=auto`), where `auto` tries to infer a useful default number of threads to use
(see [Command-line Options](@id command-line-options) for more details).
(see [Command-line Options](@ref command-line-options) for more details).

!!! compat "Julia 1.5"
The `-t`/`--threads` command line argument requires at least Julia 1.5.
Expand Down