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

Syntax (RST) fix Internals of the Compiler #16341

Merged
merged 1 commit into from
Dec 15, 2020
Merged

Syntax (RST) fix Internals of the Compiler #16341

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
12 changes: 6 additions & 6 deletions doc/intern.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,20 +118,22 @@ Rebuilding the compiler

After an initial build via `sh build_all.sh` on posix or `build_all.bat` on windows,
you can rebuild the compiler as follows:

* `nim c koch` if you need to rebuild koch
* `./koch boot -d:release` this ensures the compiler can rebuild itself
(use `koch` instead of `./koch` on windows), which builds the compiler 3 times.

A faster approach if you don't need to run the full bootstrapping implied by `koch boot`,
is the following:

* `pathto/nim c --lib:lib -d:release -o:bin/nim_temp compiler/nim.nim`

Where `pathto/nim` is any nim binary sufficiently recent (e.g. `bin/nim_cources`
built during bootstrap or `$HOME/.nimble/bin/nim` installed by `choosenim 1.2.0`)

You can pass any additional options such as `-d:leanCompiler` if you don't need
certain features or `-d:debug --stacktrace:on --excessiveStackTrace --stackTraceMsgs`
for debugging the compiler. See also
[Debugging the compiler](intern.html#debugging-the-compiler).
for debugging the compiler. See also `Debugging the compiler`_.

Debugging the compiler
======================
Expand Down Expand Up @@ -174,8 +176,7 @@ To create a new compiler for each run, use ``koch temp``::

``koch temp`` creates a debug build of the compiler, which is useful
to create stacktraces for compiler debugging. See also
[Rebuilding the compiler](intern.html#rebuilding-the-compiler) if you need
more control.
`Rebuilding the compiler`_ if you need more control.

Bisecting for regressions
=========================
Expand All @@ -189,8 +190,7 @@ current commit.::

You can also bisect using custom options to build the compiler, for example if
you don't need a debug version of the compiler (which runs slower), you can replace
`./koch temp` by explicit compilation command, see
[Rebuilding the compiler](intern.html#rebuilding-the-compiler).
`./koch temp` by explicit compilation command, see `Rebuilding the compiler`_.

The compiler's architecture
===========================
Expand Down