summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Extend and document compiler debugging utilities (#19841)quantimnot2022-06-102-38/+185
| | | | | | | | | * Add two debugutils procs that native debuggers can break on use to execute commands when code of interest is being compiled. * Add GDB and LLDB programs to disable and enable breakpoints and watchpoints when code of interest is being compiled. * Extend the `intern.rst` docs regarding debugging the compiler. Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* clarify how to restart CI (#19845)flywind2022-06-081-0/+1
|
* RST: improve simple tables (#19859)Andrey Makarov2022-06-047-28/+34
| | | | | | | * RST: improve simple tables * nim 1.0 gotchas * Still allow legacy boundaries like `----`
* Refactor and doc package handling, module name mangling (#19821)quantimnot2022-05-301-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Refactor and doc package handling, module name mangling * Consolidate, de-duplicate and extend package handling * Alter how duplicate module names of a package are handled * Alter how module names are mangled * Fix crash when another package is named 'stdlib' (test case added) * Doc what defines a package in the manual Modules with duplicate names within a package used to be given 'fake' packages to resolve conflicts. That prevented the ability to discern if a module belonged to the current project package or a foreign package. They now have the proper package owner and the names are mangled in a consistent manner to prevent codegen clashes. All module names are now mangled the same. Stdlib was treated special before, but now it is same as any other package. This fixes a crash when a foreign package is named 'stdlib'. Module mangling is altered for both file paths and symbols used by the backends. Removed an unused module name to package mapping that may have been intended for IC. The mapping was removed because it wasn't being used and was complicating the issue of package modules with duplicate names not having the proper package owner assigned. * Fix some tests * Refactor `packagehandling` * Remove `packagehandling.withPackageName` and its uses * Move module path mangling from `packagehandling` to `modulepaths` * Move `options.toRodFile` to `ic` to break import cycle * Changed import style to match preferred style Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* Doc preferred import style in compiler (#19832)quantimnot2022-05-301-0/+1
| | | | | Doc prefered import style in compiler Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* Fix typo and incorrect pragma name (#19847)Michael New2022-05-301-1/+1
|
* Add link to std/tempfiles in the docs; fix #19155 (#19807)flywind2022-05-241-0/+4
|
* Fix default testament target in docs and cli help (#19796)quantimnot2022-05-231-2/+2
| | | Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* [manual] TLock => Lock (#19785)flywind2022-05-171-3/+7
| | | | | * [manual] TLock => Lock * minor
* varargs example erroneously transformed "abc" to "def" (#19781)Alfred Morgan2022-05-101-1/+1
|
* Fix link to experimental manual in macro pragmas section [skip ci] (#19753)Jake Leahy2022-05-031-1/+1
|
* document localPassC consistently with compiler; fix ANSI capitalization (#19721)tersec2022-04-251-4/+4
|
* Move common Latex code into class nimdoc.cls (#19734)Andrey Makarov2022-04-211-0/+190
|
* fix: Fix introductory macro examples (#19706)Leon2022-04-091-3/+17
| | | Co-authored-by: adigitoleo <adigitoleo@dissimulo.com>
* Fixed description as option in advopt.txt (#19635)Omar Flores2022-03-261-3/+7
| | | | | | | | | | | | * Fixed formatting error in warningAsError. There was only a single space character between the warning and its description, so it shows up as part of the name (in bold) and with no description. Copied the way hotCodeReloading was formatted, with the description in a new line. Also changed descriptions from 'ditto' to what the description it references says. * Fixed typo in advopt.txt Corrected 'hints' to 'warnings' in updated advopt.txt.
* Add more info for {.bycopy.} (#18815)treeform2022-03-241-0/+1
| | | | | | | | | | | * Add more info for {.bycopy.} See confusion here: https://github.com/nim-lang/Nim/issues/18807 I hope this will help people googling to find this. * Update doc/manual.rst Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* support useVersion:1.6 (#19601)flywind2022-03-102-6/+1
|
* Fix typo in Nim Tutorial pt3 (#19579)huantian2022-03-021-1/+1
|
* keep casing of noinit and noreturn pragmas consistently documented (#19535)tersec2022-02-181-2/+2
|
* Documentation: Fix word usage (#19529)Sizhe Zhao2022-02-141-1/+1
|
* move io out of system (#19442)flywind2022-02-021-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | * move io out of system * fix tests * fix tests * next step * rename to syncio * rename * fix nimscript * comma * fix * fix parts of errors * good for now * fix test
* update outdated link (#19465)flywind2022-01-281-1/+1
| | | Ref https://github.com/nim-lang/Nim/issues/19463
* New/better macro pragmas, mark some as experimental (#19406)metagn2022-01-202-17/+83
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * New/better macro pragmas, make some experimental fix #15920, close #18212, close #14781, close #6696, close https://github.com/nim-lang/RFCs/issues/220 Variable macro pragmas have been changed to only take a unary section node. They can now also be applied in sections with multiple variables, as well as `const` sections. They also accept arguments. Templates now support macro pragmas, mirroring other routine types. Type and variable macro pragmas have been made experimental. Symbols without parentheses instatiating nullary macros or templates has also been documented in the experimental manual. A check for a redefinition error based on the left hand side of variable definitions when using variable macro pragmas was disabled. This nerfs `byaddr` specifically, however this has been documented as a consequence of the experimental features `byaddr` uses. Given how simple these changes are I'm worried if I'm missing something. * accomodate compiler boot * allow weird pragmas * add test for #10994 * remove some control flow, try remove some logic
* deprecate unsafeAddr; extend addr (#19373)flywind2022-01-162-11/+6
| | | | | | | | | | | | | | | | | | | | | | | | | * deprecate unsafeAddr; extend addr addr is now available for all addressable locations, unsafeAddr is deprecated and become an alias for addr * follow @Vindaar's advice * change the signature of addr * unsafeAddr => addr (stdlib) * Update changelog.md * unsafeAddr => addr (tests) * Revert "unsafeAddr => addr (stdlib)" This reverts commit ab83c99c507048a8396e636bf22d55fdd84d7d1c. * doc changes; thanks to @konsumlamm Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* move type operation section and remove deepcopy document (#19389)flywind2022-01-152-40/+26
| | | ref #19173; because deepcopy is not fit for ORC/ARC which was used for spawn and spawn will be removed from compiler
* docs: Mention `import foo {.all.}` syntax (#19377)Leon2022-01-131-0/+11
| | | | | | | Mention the `import foo {.all.}` syntax in the manual, with a caveat about private imports. Also link to the experimental importutils module. Co-authored-by: adigitoleo <adigitoleo@dissimulo.com>
* docs: Fix typo in tut1.rst (#19324)Nan Xiao2022-01-041-1/+1
|
* docs: Fix typo in tut1.rst (#19309)Nan Xiao2022-01-031-1/+1
|
* Allow full commands and blocks in type sections (#19181)hlaaftana2022-01-021-2/+3
| | | | | | | * allow full commands and blocks in type sections * update grammar * fix changelog [skip ci] * more tests * even more tests
* Update manual.rst (#19301)rockcavera2022-01-011-1/+1
|
* nep1: make header reflect reality (#19294)Andreas Rumpf2021-12-291-3/+3
|
* fixes grammar typos [backport] (#19289)Andreas Rumpf2021-12-271-3/+3
|
* Fixed typo in manual.rst unsafeAssign->uncheckedAssign. Fixes part 1 of ↵Don-Duong Quach2021-12-171-1/+1
| | | | #19266 (#19267)
* basicopt.txt: Unify the format (#19251)Nan Xiao2021-12-141-2/+2
|
* nimc.rst: fix table markup (#19239)Ștefan Talpalaru2021-12-111-0/+2
|
* added --nimMainPrefix switch; fixes #15955; refs #16945 [backport:1.6] (#19235)Andreas Rumpf2021-12-103-0/+12
|
* nimRawSetjmp: support Windows (#19197)Ștefan Talpalaru2021-12-101-0/+14
| | | | | | | | | | | | * nimRawSetjmp: support Windows Using `_setjmp()` directly is required to avoid some rare (but very annoying) exception-related stack corruption leading to segfaults on Windows, with Mingw-w64 and SEH. More details: https://github.com/status-im/nimbus-eth2/issues/3121 Also add "nimBuiltinSetjmp" - mostly for benchmarking. * fix for Apple's Clang++
* the title of PR should contain a brief description (#19211)flywind2021-12-061-0/+3
| | | In addition to an issue number, the title of a PR should contain a brief description; then users can follow the progress more easily from the title.
* treat do with pragmas but no parens as proc (#19191)hlaaftana2021-12-051-4/+4
| | | fixes #19188
* Improve documentation around func and method (#19207)PMunch2021-12-041-2/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Improve documentation around func and method * Update doc/tut1.rst Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com> * Update doc/tut1.rst Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com> * Rewrite of Zooms suggestion * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com>
* misc bugfixes [backport:1.2] (#19203)Andreas Rumpf2021-12-041-14/+9
|
* renamed 'gc' switch to 'mm'; [backport:1.6] (#19187)Andreas Rumpf2021-11-247-137/+150
| | | | * renamed 'gc' switch to 'mm'; [backport:1.6] * better docs
* `caseStmtMacros` no longer experimental, experimental manual refactor (#19173)hlaaftana2021-11-232-785/+808
| | | | | | | | | | | * `caseStmtMacros` no longer experimental, experimental manual refactor * Update doc/manual.rst * apply review suggestions * apply review Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* implement RST & Markdown quote blocks (#19147)Andrey Makarov2021-11-231-0/+5
| | | | | | | * implement RST & Markdown quote blocks * compile with nim 1.0 * Fix indentation
* Implement threads on Zephyr (#19156)Jaremy Creechley2021-11-231-0/+9
| | | | | | | | | | | | | | | | | | | * pthreads setup for zephyr - enable tweak stack size - update lib/system/threads.nim - Fix int/uint in casting pointer. * add documentation and tweak flag names * add documentation and tweak flag names * fix configuration flag names * fix configuration flag names * cleanup Co-authored-by: Jaremy Creechley <jaremy.creechley@panthalassa.com>
* Accept nnkTypeSection from typedef macro pragmas (#19168)hlaaftana2021-11-221-0/+1
|
* Enable customizing PageShift to set PageSize for embedded targets (#19129)Jaremy Creechley2021-11-161-0/+24
| | | | | | | | | | | | | | | | * Enable customizing PageSize (via PageShift). This enables adjusting PageSize for embedded targets without abusing cpu16. * copy nimPageXYZ settings for mmpaptest * add docs for Nim manual * add docs for Nim manual * docs tweaks Co-authored-by: Jaremy Creechley <jaremy.creechley@panthalassa.com>
* update manual (#19130) [backport]flywind2021-11-121-2/+2
|
* Call {.cursor.} a pragma. (#19116)treeform2021-11-101-8/+8
| | | | | | | | | | * Call {.cursor.} a pragma. Its hard to find .curser annotation while googling because all other things like it are called pragmas. See https://nim-lang.org/docs/manual.html#pragmas Also the . in front of the name makes it hard to find and search for. Can we just call it cursor pragma? * Small fix for comment.
* Deprecate `std/sharedlist` and `std/sharedtables` (#19112)konsumlamm2021-11-091-6/+0
|