summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* added `nimAllocPagesViaMalloc` switch (#18490)Andreas Rumpf2021-07-151-1/+13
| | | | | * added switch * alloc.nim needs page aligned memory blocks
* Improve description of how =trace is used (#18491)GordonBGood2021-07-151-5/+22
| | | | | | | | | | | | | | | | | | | * [skip ci] thamming_orc test created/destroyed counts match The thamming_orc.nim code now counts all created objects being tested, not just the ones following the "first 20" test, and the position of the `destroyed += 1` counter has been adjusted so it counts all the calls that are as a result of `=trace` tracing and not just the original destruction calls. * Improve description of how `=trace` is used The following nuances weren't previously fully explained: 1. That `=trace` is only used by `--gc:orc`. 2. That `=trace` is almost certainly used along with `=destroy` when manual resource allocation has been used, but it is only required if there is a possibility of cyclic references in the wrapped types (ie. generic types). 3. That, currently, a forward definition is required for the second of the pair to avoid an auto compiler generation conflict. The pattern of the use of `=trace` has also been made more extensive, showing how both a custom `=destroy` and `=trace` are used for manual allocation of resources when there is any possibility of a cyclic reference in the resource-wrapped values. * Update doc/destructors.rst Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* ORC: support for custom =trace procs (#18459)Andreas Rumpf2021-07-092-3/+39
| | | | | | | | | | | * ORC: support custom =trace procs (WIP) * Update tests/arc/tcustomtrace.nim Co-authored-by: Clyybber <darkmine956@gmail.com> * =trace is now documented and seems to work * make test green Co-authored-by: Clyybber <darkmine956@gmail.com>
* ORC: use =destroy instead of =dispose (#18440)Andreas Rumpf2021-07-071-1/+1
| | | | | | * ORC refactoring in preparation for further changes (=dispose must die) * ORC: embrace =destroy, avoid =dispose * ORC: no need for =dispose * closes #18421
* Add commas to docs for clarity (#18398)Elliot Waite2021-06-291-1/+1
|
* Peg captures get stack-like behavior (#18369)gemath2021-06-281-3/+7
| | | | | * Implements reverse capture indexing. * Now works for modified backrefs too. * Changed reverse indexing syntax prefix for back-references to '$^'.
* Switch packaging.rst to use makefileFederico Ceratto2021-06-271-3/+4
| | | Minor cleanup
* add multi type exception catching to manual (#18258) (#18323)xioren2021-06-211-4/+2
|
* close #17403; improve docs for tuple (#18312)Timothee Cour2021-06-211-7/+8
|
* followup #17852, disallow all:on for now (#18311)Timothee Cour2021-06-201-1/+2
|
* support `--hint:all:off --hint:x` (ditto with `--warnings` + friends) (#17852)Timothee Cour2021-06-201-7/+8
| | | | | * select all hints via `--hint:all:on|off`, etc * simplify code with setutils * address comment
* move {.injectStmt.} to experimental; add a test (#18300)Timothee Cour2021-06-202-11/+1
| | | | | * move {.injectStmt.} to experimental; add a test * undocument and deprecat `.injectStmt` but keep its implementation until we have a replacement
* Make the existence of high(type) clearer, especially near subranges (#18286)j-james2021-06-181-4/+7
| | | | | * Make the existence of high(type) clearer, especially around subranges * Use a better example and dry up the wording
* merge BuildMode into SuccessX, remove code duplication w drnim, add useful ↵Timothee Cour2021-06-141-1/+0
| | | | | | | | | | | info to successx, add gc to compilesettings (#18252) * merge BuildMode into SuccessX, add more info * refactor duplicated with drnim * fixup * address comment
* view types: spec changes (#18226)Andreas Rumpf2021-06-101-17/+14
| | | | | | | | | | | | | * view types: spec changes * Update doc/manual_experimental.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/manual_experimental.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* Update nims.rst to reflect that -d:release is now allowed in config.nims ↵Kaushal Modi2021-06-101-6/+6
| | | | | (#18221) `-d:release` and `-d:danger` started working in `config.nims` after https://github.com/nim-lang/Nim/commit/df429fa28772e077faa30dd6e3a701abf48c7669 .
* update docgen documentation (#18192)Andrey Makarov2021-06-062-48/+76
| | | | | | | | | | | | | * update docgen documentation * --fullhelp * Update doc/docgen.rst Co-authored-by: Timothee Cour <timothee.cour2@gmail.com> * [skip ci] fix typos Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
* follow-up #18013 - inline syntax highlighting (#18166)Andrey Makarov2021-06-0420-164/+183
|
* fixes #18058 (#18162)Andreas Rumpf2021-06-031-0/+2
|
* close #18092 document elif in case statements (#18105)Timothee Cour2021-05-311-12/+18
| | | | | | | | | * close #18092 [skip ci] document elif in case statements * fixup * clarify spec; mention special rule for string in case statements * address comments
* Minor doc fixes; follow up to 17258 and 17259 (#18123)quantimnot2021-05-293-5/+5
| | | Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* change `--hint[X] => --hint:X` in nim repo (avoids shell quoting issues) ↵Timothee Cour2021-05-263-10/+10
| | | | (#18085)
* docs: make inline markup more compatible with Markdown (#18053)Andrey Makarov2021-05-211-1/+1
| | | fixes https://github.com/timotheecour/Nim/issues/739
* follow-up #17930 - inline syntax highlighting (#18013)Andrey Makarov2021-05-161-13/+22
| | | | | * follow-up #17930 - inline syntax highlighting * make closure->nimcall
* [ci skip] correctly explain how to use `[backport]` tagsnarimiran2021-05-121-3/+3
|
* docs: fix syntax error in hotCodeReloading example (#17999)gavr1234567892021-05-121-1/+1
| | | | | #17998 Co-authored-by: g.maksutenko <g.maksutenko@indevstudio.com>
* fixes #15848 [backport:1.2] (#17959)Andreas Rumpf2021-05-071-0/+2
|
* tiny cleanup (#17957)Andreas Rumpf2021-05-071-10/+10
| | | | | * tiny cleanup * I'm not British
* follow-up #17837: add `Console` for interactive sessions (#17930)Andrey Makarov2021-05-069-139/+194
| | | | | * follow-up #17837: add `Console` for interactive sessions * fix Latex
* small improvements for tut1.rst (#17935)Miran2021-05-052-79/+101
| | | | | | | * small improvements for tut1.rst * remove unneeded paragraph * Update doc/tut1.rst Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* follow-up #17692: more inline syntax highlighting (#17837)Andrey Makarov2021-04-295-181/+287
|
* Implement https://forum.nim-lang.org/t/7848#50018 (#17874)c-blake2021-04-291-0/+1
| | | | | | | | | | | | | | | | | | | | * Implement https://forum.nim-lang.org/t/7848#50018 with just the same `SuccessX` hint category, build mode on a separate, final line, and no change to how the mode is spelled for -d:release/-d:danger. * Change to add a new BuildMode hint category and keep testament in sync as per comment. * Add "--hint:buildmode:off" to `defaultHintsOff`. * Remove as requested. * As requested for tests clean up. * Address code review. * Address code review. * Mirror db456423116a9b19666f551f4d38aded3964c2e2
* move travis, appveyor, ci.yml.disabled to `unmaintained/` (#17828)Timothee Cour2021-04-241-2/+2
| | | | | | | * move travis, appveyor, ci.yml.disabled to unmaintained * update some mentions of travis, appevyor * fix test
* manual: fix rendering of `Identifiers & Keywords` [skip ci] (#17811)Timothee Cour2021-04-231-1/+2
|
* typos (#17824)Andreas Rumpf2021-04-231-5/+5
|
* add `--processing:dots|filenames|off` to customize `hintProcessing` (#17817)Timothee Cour2021-04-231-0/+2
|
* add RST highlighting for command line / shells (also fixes #16858) (#17789)Andrey Makarov2021-04-213-98/+126
|
* `--filenames:abs|canonical|legacyRelProj` for filenames in compiler msgs ↵Timothee Cour2021-04-211-1/+3
| | | | | | | (replaces `--listfullpaths:on|off`) (#17746) * use canonicalImport for filename_magicSauce * --filenames:abs|canonical|magic * rename: magic => legacyRelProj
* close #13373 document `(ref Foo)(a: 1)` (#17804)Timothee Cour2021-04-211-1/+11
|
* updated the documentation (#17796)Andreas Rumpf2021-04-201-4/+4
|
* support skip ci in azure pipelines, and support it properly in github ↵Timothee Cour2021-04-201-3/+4
| | | | | | | | | | | | | | | actions pipelines (#17561) * support skip ci in azure pipelines * [skip ci] example of a commit that skips CI * example of a commit that does not skip CI * fix github actions logic for ci skip handling * [skip ci] example of a commit that skips CI for all pipelines * example of a commit that does not skip CI for any pipeline
* IC: first steps towards 'nim check --def --ic:on' (#17714)Andreas Rumpf2021-04-141-0/+3
| | | | | | | | | * IC: first steps towards 'nim check --def --ic:on' * IC navigator: deduplicate output lines * IC navigator: progress * IC navigator: use a different nimcache entry * IC navigator: special logic for templates/macros * IC navigator: proper error messages * IC navigator: prepare for testing code; document only what currently works somewhat
* iterable[T] (#17196)Timothee Cour2021-04-111-18/+25
| | | | | | | | * fix failing test toSeq in manual which now works * changelog * reject proc fn(a: iterable) * add iterable to spec * remove MCS/UFCS limitation that now works
* turn on syntax highlighting in Manual & Tutorial (#17692)Andrey Makarov2021-04-117-137/+149
| | | | | | | | | * turn on syntax highlighting in Manual & Tutorial * avoid highlighting of "method" * use relative path * 2 more changes
* restyle RST option lists (#17637)Andrey Makarov2021-04-101-0/+27
| | | | | | | | | | | | | * WIP: restyle RST option lists * apply similar style to Latex * fix tests * minor visual tweaks * update tests * remove leftover comments
* nep1: guidelines for getters and setters (#17645)Timothee Cour2021-04-091-0/+9
| | | | * nep1: guidelines for getters and setters * address a comment
* Fix small typos (#17680)konsumlamm2021-04-091-1/+1
|
* undocument unsupported advanced options (#17678)Andreas Rumpf2021-04-091-13/+6
|
* Update `sysrand` documentation (#17676)konsumlamm2021-04-081-4/+4
| | | Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* further progress on rst roles & directives (fix #17646) (#17659)Andrey Makarov2021-04-081-1/+1
| | | | | | | * further progress on rst roles & dir-s (fix #17646) * fix documents according to the messages * fix bug 17 from #17340