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

Jump to bottom

Add some comments to Make.inc that explicitly define what we mean when we say "assert build of Julia" #43732

Merged
merged 3 commits into from
Jan 12, 2022
Merged

Add some comments to Make.inc that explicitly define what we mean when we say "assert build of Julia" #43732

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1b626d
Add some comments to `Make.inc` that explicitly define what we mean w…
DilumAluthge Jan 10, 2022
c4541b9
Add a brief note to the devdocs with instructions on how to build an …
DilumAluthge Jan 11, 2022
d1bfa09
Recommend putting the variables into the `Make.user` file instead
DilumAluthge Jan 11, 2022
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
Prev Previous commit
Next Next commit
Add a brief note to the devdocs with instructions on how to build an … 
…"assert build" of Julia
  • Loading branch information
@DilumAluthge
DilumAluthge committed Jan 11, 2022
commit c4541b988cfc878832e695dd517feeab964da327
13 changes: 13 additions & 0 deletions doc/src/devdocs/build/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,3 +269,16 @@ If you need to build Julia from source with a Git checkout of a stdlib, then use
For example, if you need to build Julia from source with a Git checkout of Pkg, then use `make DEPS_GIT=Pkg` when building Julia. The `Pkg` repo is in `stdlib/Pkg`, and created initially with a detached `HEAD`. If you're doing this from a pre-existing Julia repository, you may need to `make clean` beforehand.

If you need to build Julia from source with Git checkouts of more than one stdlib, then `DEPS_GIT` should be a space-separated list of the stdlib names. For example, if you need to build Julia from source with a Git checkout of Pkg, Tar, and Downloads, then use `make DEPS_GIT='Pkg Tar Downloads'` when building Julia.

## Building an "assert build" of Julia

An "assert build" of Julia has both `FORCE_ASSERTIONS=1` and `LLVM_ASSERTIONS=1`. To build
an assert build, you can run the following commands:

```
git clone https://github.com/JuliaLang/julia.git
cd julia
make FORCE_ASSERTIONS=1 LLVM_ASSERTIONS=1
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

I normally recommend setting them in Make.user so that when you recompile you don't suddenly lose the assert nature.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good call. I'll make that change.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done! @vchuravy can you double check that the syntax is correct?

```

Please note that assert builds of Julia will be slower than regular (non-assert) builds.