diff options
| author | Andreas Rumpf <rumpf_a@web.de> | 2018-04-13 23:48:56 +0200 |
|---|---|---|
| committer | Andreas Rumpf <rumpf_a@web.de> | 2018-04-13 23:48:56 +0200 |
| commit | 9e884c31dd7a937f5d69b5303d5fc0a9e6b4c8f2 (patch) | |
| tree | 3ec40c853ce7f1b484bc134d4ebb7f1db941740a /doc | |
| parent | d7cc9016f3a457b0980259973f4b0089d25cd6bc (diff) | |
| download | Nim-9e884c31dd7a937f5d69b5303d5fc0a9e6b4c8f2.tar.gz | |
the new feature's name is hotCodeReloading
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/advopt.txt | 3 | ||||
| -rw-r--r-- | doc/nimc.rst | 6 |
2 files changed, 5 insertions, 4 deletions
diff --git a/doc/advopt.txt b/doc/advopt.txt index 7d8d81c4f..345e20fe4 100644 --- a/doc/advopt.txt +++ b/doc/advopt.txt @@ -60,7 +60,8 @@ Advanced options: --implicitStatic:on|off turn implicit compile time evaluation on|off --patterns:on|off turn pattern matching on|off --memTracker:on|off turn memory tracker on|off - --hotReloading:on|off turn support for hot code reloading on|off + --hotCodeReloading:on|off + turn support for hot code reloading on|off --excessiveStackTrace:on|off stack traces use full file paths --oldNewlines:on|off turn on|off the old behaviour of "\n" diff --git a/doc/nimc.rst b/doc/nimc.rst index fe414b643..b275438ea 100644 --- a/doc/nimc.rst +++ b/doc/nimc.rst @@ -330,13 +330,13 @@ Hot code reloading **Note:** At the moment hot code reloading is supported only in JavaScript projects. -The `hotReloading` option enables special compilation mode where changes in +The `hotCodeReloading`:idx: option enables special compilation mode where changes in the code can be applied automatically to a running program. The code reloading happens at the granularity of an individual module. When a module is reloaded, Nim will preserve the state of all global variables which are initialized with a standard variable declaration in the code. All other top level code will be executed repeatedly on each reload. If you want to prevent this behavior, you -can guard a block of code with the `once` construct: +can guard a block of code with the ``once`` construct: .. code-block:: Nim var settings = initTable[string, string]() @@ -357,7 +357,7 @@ re-assign a value anywhere within the top-level code: resetProgramState() **Known limitations:** In the JavaScript target, global variables using the -`codegenDecl` pragma will be re-initialized on each reload. Please guard the +``codegenDecl`` pragma will be re-initialized on each reload. Please guard the initialization with a `once` block to work-around this. **Usage in JavaScript projects:** |