mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-04-19 05:50:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

better docs; undocument sinkInference as it doesn't work (#22089)

Browse Source
This commit is contained in:
Andreas Rumpf
2023-06-13 13:44:41 +02:00
committed by GitHub
parent cca5e5ffb9
commit 606e9941d0
2 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/advopt.txt
View File

@@ -133,9 +133,9 @@ Advanced options:
select which memory management to use; default is 'orc'
--exceptions:setjmp|cpp|goto|quirky
select the exception handling implementation
--index:on|off|only docgen: turn index file generation? (`only` means
--index:on|off|only docgen: turn index file generation on|off (`only` means
not generate output files like HTML)
--noImportdoc:on|off disable loading documentation ``.idx`` files?
--noImportdoc:on|off turn loading documentation ``.idx`` files on|off
--putenv:key=value set an environment variable
--NimblePath:PATH add a path for Nimble support
--noNimblePath deactivate the Nimble path
@@ -171,8 +171,7 @@ Advanced options:
enable obsolete/legacy language feature
--benchmarkVM:on|off turn benchmarking of VM code with cpuTime() on|off
--profileVM:on|off turn compile time VM profiler on|off
--sinkInference:on|off turn sink parameter inference on|off (default: off)
--panics:on|off turn panics into process terminations (default: off)
--deepcopy:on|off enable 'system.deepCopy' for ``--mm:arc|orc``
--jsbigint64:on|off toggle the use of [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt)
for 64-bit integers on the JavaScript backend (default: on)
--jsbigint64:on|off toggle the use of BigInt for 64-bit integers for
the JavaScript backend (default: on)

9
doc/tools.md
View File

@@ -7,6 +7,10 @@ Tools available with Nim
The standard distribution ships with the following tools:
- | [atlas](atlas.html)
| `atlas`:cmd: is a simple package cloner tool. It manages an isolated workspace that
contains projects and dependencies.
- | [Hot code reloading](hcr.html)
| The "Hot code reloading" feature is built into the compiler but has its own
document explaining how it works.
@@ -37,10 +41,5 @@ The standard distribution ships with the following tools:
| `testament`:cmd: is an advanced automatic *unittests runner* for Nim tests,
is used for the development of Nim itself, offers process isolation for your tests,
it can generate statistics about test cases, supports multiple targets (C, JS, etc),
[simulated Dry-Runs](https://en.wikipedia.org/wiki/Dry_run_(testing)),
has logging, can generate HTML reports, skip tests from a file, and more,
so can be useful to run your tests, even the most complex ones.
- | [atlas](atlas.html)
| `atlas`:cmd: is a simple package cloner tool. It manages an isolated workspace that
contains projects and dependencies.