jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Syntax (RST) fix Internals of the Compiler (#16341)

Browse source 
'Rebuilding the Compiler' and a few other sections required syntax fixes:
* new lines before and after lists to fix rendering
* use internal reference instead of Markdown style link
This commit is contained in:
Saem Ghani 2020-12-15 05:57:11 -08:00 • committed by GitHub
commit 9ef7c01820
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/intern.rst
View file

@ -118,20 +118,22 @@ Rebuilding the compiler
After an initial build via `sh build_all.sh` on posix or `build_all.bat` on windows, After an initial build via `sh build_all.sh` on posix or `build_all.bat` on windows,
you can rebuild the compiler as follows: you can rebuild the compiler as follows:
* `nim c koch` if you need to rebuild koch * `nim c koch` if you need to rebuild koch
* `./koch boot -d:release` this ensures the compiler can rebuild itself * `./koch boot -d:release` this ensures the compiler can rebuild itself
(use `koch` instead of `./koch` on windows), which builds the compiler 3 times. (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`, A faster approach if you don't need to run the full bootstrapping implied by `koch boot`,
is the following: is the following:
* `pathto/nim c --lib:lib -d:release -o:bin/nim_temp compiler/nim.nim` * `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` 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`) 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 You can pass any additional options such as `-d:leanCompiler` if you don't need
certain features or `-d:debug --stacktrace:on --excessiveStackTrace --stackTraceMsgs` certain features or `-d:debug --stacktrace:on --excessiveStackTrace --stackTraceMsgs`
for debugging the compiler. See also for debugging the compiler. See also `Debugging the compiler`_.
[Debugging the compiler](intern.html#debugging-the-compiler).
Debugging the compiler Debugging the compiler
====================== ======================
@ -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 ``koch temp`` creates a debug build of the compiler, which is useful
to create stacktraces for compiler debugging. See also to create stacktraces for compiler debugging. See also
[Rebuilding the compiler](intern.html#rebuilding-the-compiler) if you need `Rebuilding the compiler`_ if you need more control.
more control.
Bisecting for regressions Bisecting for regressions
========================= =========================
@ -189,8 +190,7 @@ current commit.::
You can also bisect using custom options to build the compiler, for example if 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 you don't need a debug version of the compiler (which runs slower), you can replace
`./koch temp` by explicit compilation command, see `./koch temp` by explicit compilation command, see `Rebuilding the compiler`_.
[Rebuilding the compiler](intern.html#rebuilding-the-compiler).
The compiler's architecture The compiler's architecture
=========================== ===========================