Skip to content

Commit

Permalink
Remove contrib/build_sysimg.jl (#30225)
Browse files Browse the repository at this point in the history
* Remove contrib/build_sysimg.jl

Users should instead use [PackageCompiler.jl](https://github.com/JuliaLang/PackageCompiler.jl) as it is more fully-featured and better maintained.

* Modify `devdocs/sysimg.md` to just forward users to `PackageCompiler`.

* Remove `build_sysimg()` invocation from `doc/make.jl`
  • Loading branch information
staticfloat authored Dec 11, 2018
1 parent 5b2e3e7 commit 2bbb5fc
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 237 deletions.
210 changes: 0 additions & 210 deletions contrib/build_sysimg.jl

This file was deleted.

5 changes: 0 additions & 5 deletions doc/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ Pkg.instantiate()

using Documenter, DocumenterLaTeX

# Include the `build_sysimg` file.

baremodule GenStdLib end
@isdefined(build_sysimg) || @eval module BuildSysImg
include(joinpath(@__DIR__, "..", "contrib", "build_sysimg.jl"))
end

# Documenter Setup.

Expand Down
24 changes: 2 additions & 22 deletions doc/src/devdocs/sysimg.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,8 @@ This operation is useful for multiple reasons. A user may:
* Include a `userimg.jl` file that includes packages into the system image, thereby creating a system
image that has packages embedded into the startup environment.

Julia now ships with a script that automates the tasks of building the system image, wittingly
named `build_sysimg.jl` that lives in `DATAROOTDIR/julia/`. That is, to include it into a current
Julia session, type:

```julia
include(joinpath(Sys.BINDIR, Base.DATAROOTDIR, "julia", "build_sysimg.jl"))
```

This will include a `build_sysimg` function:

```@docs
BuildSysImg.build_sysimg
```

Note that this file can also be run as a script itself, with command line arguments taking the
place of arguments passed to the `build_sysimg` function. For example, to build a system image
in `/tmp/sys.{so,dll,dylib}`, with the `core2` CPU instruction set, a user image of `~/userimg.jl`
and `force` set to `true`, one would execute:

```
julia build_sysimg.jl /tmp/sys core2 ~/userimg.jl --force
```
The [`PackageCompiler.jl` package](https://github.com/JuliaLang/PackageCompiler.jl) contains convenient
wrapper functions to automate this process.

## System image optimized for multiple microarchitectures

Expand Down

0 comments on commit 2bbb5fc

Please sign in to comment.