summary refs log tree commit diff stats
path: root/doc/advopt.txt
Commit message (Collapse)AuthorAgeFilesLines
* clean up the documentation (#22196)ringabout2023-07-021-1/+1
|
* docs nimBasePattern (#22179)Juan M Gómez2023-06-281-0/+2
|
* better docs; undocument sinkInference as it doesn't work (#22089)Andreas Rumpf2023-06-131-5/+4
|
* int64/uint64 as bigint in JS (#21613)metagn2023-04-111-0/+2
| | | | | | | | | | | * int64/uint64 as bigint in JS * fix CI * convert to compile option * fix lie * smaller diff, changelog entry
* remove useVersion (#21626)metagn2023-04-081-1/+0
| | | test removing useVersion
* fixes sinkinference documentation, which has been disabled (#21470)ringabout2023-03-121-1/+1
| | | since https://github.com/nim-lang/Nim/pull/15105
* add `md2html`, `md2tex` to cmd helpers (#21295)ringabout2023-01-241-0/+3
|
* docgen: implement cross-document links (#20990)Andrey Makarov2023-01-041-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * docgen: implement cross-document links Fully implements https://github.com/nim-lang/RFCs/issues/125 Follow-up of: https://github.com/nim-lang/Nim/pull/18642 (for internal links) and https://github.com/nim-lang/Nim/issues/20127. Overview -------- Explicit import-like directive is required, called `.. importdoc::`. (the syntax is % RST, Markdown will use it for a while). Then one can reference any symbols/headings/anchors, as if they were in the local file (but they will be prefixed with a module name or markup document in link text). It's possible to reference anything from anywhere (any direction in `.nim`/`.md`/`.rst` files). See `doc/docgen.md` for full description. Working is based on `.idx` files, hence one needs to generate all `.idx` beforehand. A dedicated option `--index:only` is introduced (and a separate stage for `--index:only` is added to `kochdocs.nim`). Performance note ---------------- Full run for `./koch docs` now takes 185% of the time before this PR. (After: 315 s, before: 170 s on my PC). All the time seems to be spent on `--index:only` run, which takes almost as much (85%) of normal doc run -- it seems that most time is spent on file parsing, turning off HTML generation phase has not helped much. (One could avoid it by specifying list of files that can be referenced and pre-processing only them. But it can become error-prone and I assume that these linke will be **everywhere** in the repository anyway, especially considering https://github.com/nim-lang/RFCs/issues/478. So every `.nim`/`.md` file is processed for `.idx` first). But that's all without significant part of repository converted to cross-module auto links. To estimate impact I checked the time for `doc`ing a few files (after all indexes have been generated), and everywhere difference was **negligible**. E.g. for `lib/std/private/osfiles.nim` that `importdoc`s large `os.idx` and hence should have been a case with relatively large performance impact, but: * After: 0.59 s. * Before: 0.59 s. So Nim compiler works so slow that doc part basically does not matter :-) Testing ------- 1) added `extlinks` test to `nimdoc/` 2) checked that `theindex.html` is still correct 2) fixed broken auto-links for modules that were derived from `os.nim` by adding appropriate ``importdoc`` Implementation note ------------------- Parsing and formating of `.idx` entries is moved into a dedicated `rstidx.nim` module from `rstgen.nim`. `.idx` file format changed: * fields are not escaped in most cases because we need original strings for referencing, not HTML ones (the exception is linkTitle for titles and headings). Escaping happens later -- on the stage of `rstgen` buildIndex, etc. * all lines have fixed number of columns 6 * added discriminator tag as a first column, it always allows distinguish Nim/markup entries, titles/headings, etc. `rstgen` does not rely any more (in most cases) on ad-hoc logic to determine what type each entry is. * there is now always a title entry added at the first line. * add a line number as 6th column * linkTitle (4th) column has a different format: before it was like `module: funcName()`, now it's `proc funcName()`. (This format is also propagated to `theindex.html` and search results, I kept it that way since I like it more though it's discussible.) This column is what used for Nim symbols resolution. * also changed details on column format for headings and titles: "keyword" is original, "linkTitle" is HTML one * fix paths on Windows + more clear code * Update compiler/docgen.nim Co-authored-by: Andreas Rumpf <rumpf_a@web.de> * Handle .md and .nim paths uniformly in findRefFile * handle titles better + more comments * don't allow markup overwrite index title for .nim files Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* add a changelog and update the document for ORC (#20415)ringabout2022-09-261-2/+1
| | | | | | | | | | | | | | | | | | | | * add a changelog and update the document for ORC * hone * back * Apply suggestions from code review Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> * Update doc/mm.md Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> * Update doc/mm.md Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* 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.
* support useVersion:1.6 (#19601)flywind2022-03-101-1/+1
|
* added --nimMainPrefix switch; fixes #15955; refs #16945 [backport:1.6] (#19235)Andreas Rumpf2021-12-101-0/+2
|
* renamed 'gc' switch to 'mm'; [backport:1.6] (#19187)Andreas Rumpf2021-11-241-3/+4
| | | | * renamed 'gc' switch to 'mm'; [backport:1.6] * better docs
* 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
* update docgen documentation (#18192)Andrey Makarov2021-06-061-1/+2
| | | | | | | | | | | | | * 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>
* fixes #18058 (#18162)Andreas Rumpf2021-06-031-0/+2
|
* change `--hint[X] => --hint:X` in nim repo (avoids shell quoting issues) ↵Timothee Cour2021-05-261-5/+5
| | | | (#18085)
* fixes #15848 [backport:1.2] (#17959)Andreas Rumpf2021-05-071-0/+2
|
* add `--processing:dots|filenames|off` to customize `hintProcessing` (#17817)Timothee Cour2021-04-231-0/+2
|
* `--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
* updated the documentation (#17796)Andreas Rumpf2021-04-201-4/+4
|
* 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
* undocument unsupported advanced options (#17678)Andreas Rumpf2021-04-091-13/+6
|
* Fix entries in nimc advopt (#17576)Danil Yarantsev2021-03-301-3/+5
|
* fix #2844 #3911; add --spellsuggest to suggest symbols in scope with similar ↵Timothee Cour2021-03-161-0/+3
| | | | | | | spellings on undefined symbol error (#16067) * add --spellsuggest to suggest symbols in scope with similar spellings on undefined symbol errors * implement --spellsuggest with 0 arguments
* deprecate newruntime (#17245)flywind2021-03-041-1/+0
| | | | | | * deprecate newruntime * tests * Update compiler/commands.nim
* fix #16731: using deprecated flags triggers a warning (#17225)Timothee Cour2021-03-021-1/+1
| | | | | | * using deprecated flags triggers a warning * cleanups * fixup * address comments
* `--nilseqs` is now a deprecated noop (#17211)Timothee Cour2021-03-011-2/+0
| | | | | * --nilseqs is now a deprecated noop * fix tests; fix: future => sugar
* document `since` (#17048)Timothee Cour2021-02-161-1/+1
| | | | * document `since` * address comment
* `--hintAsError` (#16763)Timothee Cour2021-01-201-2/+2
| | | | | | | * --hintAsError * add test, changelog * condsyms
* Deprecate TaintedString (#15423)Juan Carlos2021-01-151-1/+0
| | | | Co-authored-by: Timothee Cour <timothee.cour2@gmail.com> Co-authored-by: Dominik Picheta <dominikpicheta@googlemail.com>
* remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683)Timothee Cour2020-11-261-2/+2
|
* --declaredlocs => --declaredLocs (#15672)Timothee Cour2020-10-211-1/+1
|
* add --declaredlocs (#15666)Timothee Cour2020-10-211-0/+1
|
* make patchFile more discoverable (#15659)Timothee Cour2020-10-201-0/+1
|
* more "eg" fixesnarimiran2020-10-201-1/+1
|
* fix #15405. deepcopy arc (#15410)cooldome2020-10-011-0/+1
| | | | | | | * fix #15405 * fix tests * deepcopy for ARC has to be enabled via --deepcopy:on Co-authored-by: Araq <rumpf_a@web.de>
* fix #11537, correct parse inline code without surrounding spaces (#15399)Miran2020-09-251-1/+1
|
* fix the indentation in `--help` and `--fullhelp` (#15387)Miran2020-09-231-2/+2
| | | | | * fix the indentation in `--help` and `--fullhelp` * a better way to fix it
* cleanup ARC documentation (#15100)Andreas Rumpf2020-07-281-2/+0
|
* An optimizer for ARC (#14962)Andreas Rumpf2020-07-151-0/+2
| | | | | | | | | | | | | | | | | | | | * WIP: an optimizer for ARC * do not optimize away destructors in 'finally' if unstructured control flow is involved * optimized the optimizer * minor code cleanup * first steps to .cursor inference * cursor inference: big steps to a working solution * baby steps * better .cursor inference * new feature: expandArc for easy inspection of the AST after ARC transformations * added topt_cursor test * adapt tests * cleanups, make tests green * optimize common traversal patterns * moved test case * fixes .cursor inference so that npeg compiles once again * cursor inference: more bugfixes Co-authored-by: Clyybber <darkmine956@gmail.com>
* https://github.com/nim-lang/Nim/pull/14948#issuecomment-656498426 (#14958)Juan Carlos2020-07-111-1/+1
|
* VM profiler (#14833)Ico Doornekamp2020-07-091-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | * Crude VM profiler * Added --profileVM flag, refactoring * fixed FileLine hash * Use TLineInfo instead of own FileLine, updated formatting * Refactoring, moved PStackFrame to vmdefs for cleaner data structure * Moved vmprofiler to separate file * Simplified TLineInfo hash, use toFileLineCol for output * Hash * Moved profile data into Config, dump only once at end of run * Changed profile output header to show '#instr' instead of 'count' * Do not accumulate instrcount for non-top frames Co-authored-by: Ico Doornekamp <git@zevv.nl>
* Clean out oldast (#14837)Juan Carlos2020-06-301-1/+0
| | | | * Clean out old Deprecated CLI switch * Update to remove --oldast CLI option
* Fix some typos (#14843)Danil Yarantsev2020-06-281-1/+1
|
* Deprecated laxStrings for mutating the internal zero terminator on strings ↵Juan Carlos2020-06-231-2/+0
| | | | | and its Deprecated code cleaned out (#14766) Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Deprecate oldNewlines, clean out deprecated code from oldNewlines (#14763)Juan Carlos2020-06-231-1/+0
|
* add arc and orc to gc list (#14653)Andy Davidoff2020-06-141-1/+1
|
* `nim doc --backend:js`, `nim doc --doccmd:-d:foo`, `nim r --backend:js`, ↵Timothee Cour2020-05-111-2/+9
| | | | | | | | | | `--doccmd:skip` + other improvements (#14278) * `nim doc --backend:js|cpp...` `nim doc --doccmd:'-d:foo --threads:on'` `nim r --backend:cpp...` (implies --run --usenimcache) * --usenimcache works with all targets * --docCmd:skip now skips compiling snippets; 50X speedup for doc/manual.rst
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-02-06 08:40:26 +0000