summary refs log tree commit diff stats
path: root/lib
Commit message (Collapse)AuthorAgeFilesLines
* docgen: implement cross-document links (#20990)Andrey Makarov2023-01-0415-178/+473
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* minor code cleanups (#21215)Andreas Rumpf2023-01-026-36/+32
|
* avoiding unnecessary allocation for dollar IpAddress (#21199)rockcavera2022-12-301-2/+2
| | | | | | | | | | | | | | | * avoiding allocating an unnecessary byte for IPv4 The inet.h file uses 16 as the string in C needs the last null byte https://github.com/torvalds/linux/blob/1b929c02afd37871d5afb9d498426f83432e71c2/include/linux/inet.h#L49 However, strings in Nim do not need this. So one byte is being allocated unnecessary and will never be used. * avoid unnecessary allocation in IPv6 dollar It is currently allocating 48 bytes. However, the Nim implementation for IPv6 will print a maximum of 39 characters. Nim does not implement IPv6 "0000:0000:0000:0000:0000:ffff:255.255.255.255" (45 characters) nor "0000:0000:0000:0000:0000:ffff:255.255.255.255%3" (47 characters). The indication in inet.h for 48 is due to the maximum use of 47 characters of a C string that needs a null byte at the end. So 48. https://github.com/torvalds/linux/blob/1b929c02afd37871d5afb9d498426f83432e71c2/include/linux/inet.h#L50
* fixes #21195; `std/assertions` continue to use `sysFatal` when ↵ringabout2022-12-293-26/+38
| | | | | | | | | | | | | `nimPreviewSlimSystem` is not defined (#21196) * fixes #21195; `std/assertions` continue to use `sysFatal` * try includes * make `std/assertions` self-contained * fixes tests * fixes tests
* fixes #21171; dynamic acyclic refs need to use dyn decRef (#21184)ringabout2022-12-281-0/+13
| | | | | | | * fixes #21171; dyn destructors for acyclic inherited refs * add a test * Update compiler/liftdestructors.nim
* std/encodings: Fix open() documentation in regard to exception raised (#21187)Phil Krylov2022-12-281-1/+1
|
* remove legacy code (#21134)ringabout2022-12-2618-981/+401
| | | | | * remove legacy code * fixes
* re and nre now link to regex and tinyre (#21161)ringabout2022-12-232-3/+9
|
* fix #20997 calling system.card[T](x: set[T]) with T of int8 or uint8 … ↵Bung2022-12-231-3/+5
| | | | | | | (#21010) * fix #20997 calling system.card[T](x: set[T]) with T of int8 or uint8 uses mismatched C array sizes * fullfil set variant
* fix socket send for string types (#21155)Jaremy Creechley2022-12-221-9/+30
| | | | | | | * fix socket send for string types * include windows version Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com>
* remove misleading slimsystem deprecated warnings (#21156)metagn2022-12-222-5/+0
| | | refs #20967
* add link to setutils in system module docs (#21130)Peder Bergebakken Sundt2022-12-221-0/+1
|
* Feature/xmltree additions (#20988)Michael Voronin2022-12-221-3/+150
| | | | | | | * [change] add/insert/delete family of xmltree expanded with several variations. Added replace methods family * [change] Lifted child limitations on insert methods (consulted with @araq) * [tests] add/insert/replace/delete of xmltree XmlNodes tests added
* fixes #20244; fixes castSizes warnings (#21102)ringabout2022-12-221-2/+14
| | | | | | | | | | | | | | | | | * fixes #20244; fixes castSizes warnings * fixes js * fixes js * fixes js * fixes * typo * extend using uint64 * Update lib/std/syncio.nim
* Implement setLineInfo (#21153)Peter Munch-Ellingsen2022-12-221-0/+16
| | | | | * Implement setLineInfo * Add tests
* fixes #19292; fixes #21122; fixes putEnv and setEnv with vcc (#21143)ringabout2022-12-202-15/+19
| | | | | * fixes #19292; fixes 21122; fixes putEnv and setEnv with vcc * add a test
* remove unused imports (#21126)ringabout2022-12-171-2/+0
|
* Bump the devel version to 1.9.1 (#21117)ringabout2022-12-161-2/+2
|
* fix #12122 (#21096)Bung2022-12-1620-134/+134
|
* Make async stacktraces less verbose (#21091)Jake Leahy2022-12-152-18/+14
| | | | | | | | | | | | | | | | | | | | | | | * Name iterators something human readable Remove intermediate async procs from stacktraces Clean async traceback message from reraises message * Remove unused import/variable * Fix failing tests Don't add {.stackTrace: off.} to anonymous procs (They already don't appear in stacktrace) * Fix failing tests in pragma category Now check that the nim is a routine type first so we don't run into any assertion defects * Hide stack trace pragma in docs and update doc tests User doesn't need to know if something won't appear so this more becomes verbose noise If this is a bad idea we can always add a `when defined(nimdoc)` switch so we don't add {.stackTrace: off.} to the Future[T] returning proc for docs
* fix #19580; add warning for bare except: clause (#21099)ringabout2022-12-153-5/+7
| | | | | | | | | | | | | | | | | | | | | * fix #19580; add warning for bare except: clause * fixes some easy ones * Update doc/manual.md * fixes docs * Update changelog.md * addition * Apply suggestions from code review Co-authored-by: Jacek Sieka <arnetheduck@gmail.com> * Update doc/tut2.md Co-authored-by: Jacek Sieka <arnetheduck@gmail.com>
* Document that system:pop() may raise IndexDefect (#21070)Xavier Noria2022-12-132-3/+5
| | | | | * Document system:pop() may raise IndexDefect * Add backticks to KeyError
* alternative, much simpler algorithm for strict func checking (#21066)Andreas Rumpf2022-12-116-33/+31
| | | | | | | | | | | | | * alternative, much simpler algorithm for strict func checking * forgot to git add new compiler module * new spec is incredibly simple to describe * fixes bigints regression * typos * closes #16305; closes #17387; closes #20863
* `multisync` now allows tuples in return type (#21074)Jake Leahy2022-12-111-2/+2
| | | | | | | * Add test case * Use .toStrLit() on param node first This means that more complex types are fully rendered
* fix #21045; getTime with vmopsDanger is broken; alternative to #21054 (#21056)ringabout2022-12-101-19/+25
| | | | | * fix #21045 getTime with vmopsDanger is broken; alternative to #21054 * typo
* clean up the documentation of threads (#21067)ringabout2022-12-101-6/+0
| | | | | * clean up the documentation of threads * cleanup
* fixes #21062 (#21068)Andreas Rumpf2022-12-101-2/+3
|
* Use a unique name for template in async macro return (#21058)Jake Leahy2022-12-101-3/+3
| | | Use unique template name
* Implicit return working for async proc (#20933)Jake Leahy2022-12-091-2/+11
| | | | | | | | | | | | | * Implicit return working for asyncdispatch proc Closes #11558 * Test case * Test that return value is actually used * Update tests/async/t11558.nim Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Remove deprecated rightSize (#21011)Juan Carlos2022-12-081-10/+0
| | | | | * Remove deprecated rightSize nop * Remove deprecated rightSize nop
* macros.customPragmaNode: walk brackets on brackets (#21040)Emery Hemingway2022-12-081-5/+3
|
* build the documentation of official packages (#20986)ringabout2022-12-0612-5675/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * remove db stuffs * remove punycode * remove * fixes script * add cloner * patches * disable * patch * fixes external packages * disable two packages * preview documentation build * try again * fixes URL * fixes a bug * simplify * fixes documentaion * fixes * Apply suggestions from code review
* stdlib organization & documentation improvements (#20971)metagn2022-12-0623-12/+32
| | | | | | | | | | | | | | | | | * stdlib organization & documentation improvements * fix CI * Update doc/lib.md Co-authored-by: Juan Carlos <juancarlospaco@gmail.com> * fix ci, remove jshttpcore, export in jsfetch instead * fix alphabetical order violations * add cmdline, db_odbc Co-authored-by: Juan Carlos <juancarlospaco@gmail.com>
* Remove deprecated posix.CLONE_STOPPED (#21012)Juan Carlos2022-12-051-1/+1
| | | | | * Remove deprecated CLONE_STOPPED * Remove deprecated CLONE_STOPPED
* unpublic `arrayWith` and rename it to `nimArrayWith` (#21006)ringabout2022-12-041-1/+1
| | | | | * unpublic arrayWith * unindent
* Update prelude example (#21005)Michal Maršálek2022-12-031-1/+1
| | | comment to match what's actually being imported.
* minor cleanup; correct the module name (#21001)ringabout2022-12-021-2/+2
| | | | | | | | | | | * minor cleanup follow up https://github.com/nim-lang/Nim/pull/20946 * Update lib/std/cmdline.nim * Update lib/std/cmdline.nim Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>
* [unittest] remove unnecessay export for testing (#20868)ringabout2022-12-011-2/+0
|
* tyInt tyUint fit target int bit width (#20829)Bung2022-12-0113-244/+247
|
* Add HPPA and sparc64 architectures (#20934)Federico Ceratto2022-12-011-0/+2
| | | | | | | | | | | * Add comments on CPU arch detection * Support HPPA/hppa/parisc64 CPU architecture * Support sparc64 CPU architecture * Update tools/niminst/makefile.nimf Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* move `smtp` to nimble packages (#20953)ringabout2022-11-301-361/+0
| | | | | | | | | * move `smtp` to nimble packages * fixes * install smtp * yes
* Move command line parameter code (#20946)IgorDeepakM2022-11-303-272/+318
| | | | | Command line paramater code moved from os.nim to cmdparam.nim Co-authored-by: IgorDeepakM <IgorDeepak@noreply.com>
* dom: remove X* = ref XObj [backport] (#20910)metagn2022-11-291-76/+37
| | | dom: remove X* = ref XObj
* fix #20969 - making vcc work again with cpp backend (#20970)rockcavera2022-11-291-2/+2
| | | Update sysatomics.nim
* move `asyncftpclient` to nimble packages (#20952)ringabout2022-11-281-524/+0
|
* Improve jsformdata (#20929)Juan Carlos2022-11-281-6/+10
| | | | | * jsformdata now accepts Blob data type similar to JS * jsformdata now accepts Blob data type similar to JS
* Support IBM Z architecture (#20943)Federico Ceratto2022-11-281-1/+3
|
* Fix several memory leaks in the Postgres wrapper. (#20940)jfilby2022-11-271-11/+18
|
* fixes documentation regression (#20925)ringabout2022-11-261-2/+2
| | | follow up https://github.com/nim-lang/Nim/pull/17004
* fixes #20873; rework vcc with arc/orc (#20913)ringabout2022-11-251-21/+49
| | | | | * fixes #20873; arc/orc is broken for vcc * fixes signature
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-05-30 16:55:16 +0000