summary refs log tree commit diff stats
path: root/compiler/options.nim
Commit message (Expand)AuthorAgeFilesLines
...
* implements experimental new config system based on NimScriptAraq2015-08-161-3/+3
* Added absolute path support to options.findFileAnatoly Galiulin2015-07-211-5/+8
* Turn optPrintSurroundingSrc into hintSourceAdam Strzelecki2015-07-031-3/+0
* fixed indentationAraq2015-06-211-1/+1
* renamed writeln to writeLine in compilerpatrick dw2015-06-191-1/+1
* Merge branch 'devel' into gogcStefan Talpalaru2015-06-151-2/+9
|\
| * Introduce gPrefixDir for nimsuggest.Dominik Picheta2015-06-141-2/+8
| * Colors!Ryan Gonzalez2015-06-021-0/+1
* | the Go GC - initial implementationStefan Talpalaru2015-05-311-1/+1
|/
* Use gProjectIsStdin insteaddef2015-05-171-0/+1
* merged devel into epcSimon Hafner2015-05-081-1/+1
|\
| * fixes 'echo nil' codegen bugAraq2015-05-031-1/+1
* | removed a few consts and rewired to IdeCmdSimon Hafner2015-04-261-2/+17
|/
* doc updates; fixes 'inc' for 'char'Araq2015-03-291-35/+35
* don't use stdout for nimsuggest server modeAraq2015-02-271-4/+4
* nimsuggest: sane dirty buffer handlingAraq2015-01-291-6/+0
* nimsuggest: first versionAraq2015-01-271-5/+8
* implemented 'experimental' switchAraq2014-12-051-0/+1
* fixes a recently introduced regressionAraq2014-09-161-3/+2
* fixes documentation generatorAraq2014-09-141-2/+3
* nimfix supports specialized '.nimfix' modulesAraq2014-09-081-0/+10
* nimfix handles helloworldAraq2014-09-061-1/+0
* babel is now nimbleAraq2014-08-301-0/+3
* renamed babelcmd to nimblecmd; config files are now nim.cfg; other renamingsAraq2014-08-291-2/+2
* Nimrod renamed to NimAraq2014-08-281-2/+2
* renamefestAraq2014-08-231-1/+1
* fixes 'gcsafe'Araq2014-08-121-1/+1
* Merge pull request #1118 from gradha/pr_show_boot_optionsVarriount2014-04-211-1/+1
|\
| * Version switch displays options used during `koch boot`Grzegorz Adam Hankiewicz2014-04-201-1/+1
* | reintroduce thread analysis but disable it for backwards compatibilityAraq2014-04-201-0/+1
* | removed flawed thread analysis passAraq2014-04-201-2/+1
|/
* Adds option to exclude nimcache dirs from time machine backups.Grzegorz Adam Hankiewicz2014-04-161-1/+26
* merged better html links #850Araq2014-04-081-0/+2
* the compiler is now aware of packagesAraq2014-03-021-19/+9
* better handling of packages, still incompleteAraq2014-03-021-13/+44
* resolved conflicts with masterAraq2014-01-181-0/+1
|\
| * Added --noBabelPath override.Dominik Picheta2013-12-251-0/+1
* | clean-up some obsolete code; close #602Zahary Karadjov2013-12-311-2/+0
* | case consistency: cs:partial bootstraps on windowsAraq2013-12-291-4/+4
* | case consistency: next stepsAraq2013-12-291-6/+6
* | case consistency part 4Araq2013-12-271-7/+7
* | case consistency part 1Araq2013-12-271-1/+1
|/
* Added jsondoc compiler switchErik O'Leary2013-12-121-0/+1
* bugfix: package names should not contain '.'Araq2013-10-071-2/+4
* the compiler can now deal with multiple modules of the same nameAraq2013-09-261-4/+9
* JS codegen: supports more builtinsAraq2013-09-241-10/+19
* support for multiple modules of the same name; niminst supports 'platforms'; ...Araq2013-09-241-1/+13
* -d:nocaas mode for easier bootstrapping on exotic OSes (Haiku)Araq2013-09-011-0/+1
* pass-through of static int generic params to arrays when late instantiation i...Zahary Karadjov2013-08-231-1/+1
* Experimental support for delayed instantiation of genericsZahary Karadjov2013-08-231-0/+2
/commit/doc/koch.rst?h=devel&id=7e21218a07f919d56cd0974c657aefb11574da26'>7e21218a0 ^
bab41babe ^
83ae70cb5 ^
635c0b6cb ^





c4ba4f06f ^
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
                               
                         

                               
                      
 

                          

             
                                                                   




            
                                                                        
                                                                              
                                                                               
                                                                    











                                                                         
                                                                             

                                                                     

                                                                     


                                                                       
 
                                                                    

                                                                     

      



                                                                            

                                                         
 


            
                                                                        
                                                                            

                                                                              



            


                                                                                


                                                                       


           
                                                                        
                                                                             
                                                             
                     
 

                                                                            
                                                                              
                                                                                 
                                                                           
                          





                                                                        
                                                                 
===============================
   Nim maintenance script
===============================

:Version: |nimversion|

.. default-role:: code
.. include:: rstcommon.rst
.. contents::

> "A great chef is an artist that I truly respect" -- Robert Stack.


Introduction
============

The `koch`:idx: program is Nim's maintenance script. It is a replacement
for make and shell scripting with the advantage that it is much more portable.
The word *koch* means *cook* in German. `koch`:cmd: is used mainly to build the
Nim compiler, but it can also be used for other tasks. This document
describes the supported commands and their options.


Commands
========

boot command
------------

The `boot`:idx: command bootstraps the compiler, and it accepts different
options:

-d:release    By default a debug version is created, passing this option will
  force a release build, which is much faster and should be preferred
  unless you are debugging the compiler.
-d:nimUseLinenoise     Use the linenoise library for interactive mode
                       (not needed on Windows).
-d:leanCompiler        Produce a compiler without JS codegen or
                       documentation generator in order to use less RAM
                       for bootstrapping.

After compilation is finished you will hopefully end up with the nim
compiler in the `bin` directory. You can add Nim's `bin` directory to
your `$PATH` or use the install command to place it where it will be
found.

csource command
---------------

The `csource`:idx: command builds the C sources for installation. It accepts
the same options as you would pass to the [boot command](
#commands-boot-command).

temp command
------------

The temp command builds the Nim compiler but with a different final name
(`nim_temp`:cmd:), so it doesn't overwrite your normal compiler. You can use
this command to test different options, the same you would issue for the [boot
command](#commands-boot-command).

test command
------------

The `test`:idx: command can also be invoked with the alias `tests`:option:. This
command will compile and run ``testament/tester.nim``, which is the main
driver of Nim's test suite. You can pass options to the `test`:option: command,
they will be forwarded to the tester. See its source code for available
options.

web command
-----------

The `web`:idx: command converts the documentation in the `doc` directory
from rst to HTML. It also repeats the same operation but places the result in
the ``web/upload`` which can be used to update the website at
https://nim-lang.org.

By default, the documentation will be built in parallel using the number of
available CPU cores. If any documentation build sub-commands fail, they will
be rerun in serial fashion so that meaningful error output can be gathered for
inspection. The `--parallelBuild:n`:option: switch or configuration option can be
used to force a specific number of parallel jobs or run everything serially
from the start (`n == 1`).

pdf command
-----------

The `pdf`:idx: command builds PDF versions of Nim documentation: Manual,
Tutorial and a few other documents. To run it one needs to
[install Latex/xelatex](https://www.latex-project.org/get) first.