| 11 Apr 2024 |
@fractivore:cyberia.club | Here: https://wiki.nixos.org/wiki/FAQ#What_does_it_mean_to_say_that_NixOS_is_%22immutable%22? | 01:56:50 |
@fractivore:cyberia.club | * Here: https://wiki.nixos.org/wiki/FAQ#What_does_it_mean_to_say_that_NixOS_is_%22immutable%22 | 01:58:02 |
| pxc joined the room. | 18:11:47 |
| @andi:kack.it left the room. | 19:52:14 |
@olafklingt:matrix.org | When i make a pr on a file i am the codeowner. Do you still get notifications to review the pr? (#940) | 21:40:01 |
| Anthony Rsl set a profile picture. | 21:59:13 |
fricklerhandwerk | In reply to @olafklingt:matrix.org When i make a pr on a file i am the codeowner. Do you still get notifications to review the pr? (#940) No, but I saw the PR and itโs in my queue. The article is quite long now. Do you think it makes sense to split it up? If so, we can also do it afterwards | 22:08:17 |
| Anthony Rsl removed their profile picture. | 22:12:49 |
@olafklingt:matrix.org | In reply to @fricklerhandwerk:matrix.org No, but I saw the PR and itโs in my queue. The article is quite long now. Do you think it makes sense to split it up? If so, we can also do it afterwards I don't really see a point where splitting would make sense. - the Wayland part is debatable if it is necessary ... but i think it is good because it points at qemu pitfalls. | 22:17:00 |
| 12 Apr 2024 |
wamirez | In reply to@infinisil:matrix.org wamirez: I think you might have gotten update emails in the past, could you check that you don't anymore? ^ I did get an update. I was sifting through and deleting some emails before getting here so I can't say for sure when, but maybe it was this Monday. Let me know if I can do anything to sort that out! | 17:28:08 |
@terru:raccoon.college | hey all, i recently got it into my head to write a little tool which automatically edits nix files without messing them up, and got it to a point where it can remove e.g. all mentions of lib.mdDoc from nixpkgs. I have a changeset of it applied to master or ~an hour ago here: https://github.com/NixOS/nixpkgs/compare/5d401f9ed627a869fd231f63e4f8380022dcded5...stuebinm:nixpkgs:remove-mdDoc
i have not opened a pull request with it because that'd just ping a lot of people and i'm not sure if it would be accepted or people here would even be interested, so I thought I'd ask here beforehand
| 18:54:15 |
@terru:raccoon.college | * hey all, i recently got it into my head to write a little tool which automatically edits nix files without messing them up, and got it to a point where it can remove e.g. all mentions of lib.mdDoc from nixpkgs. I have a changeset of it applied to master or ~an hour ago here: https://github.com/NixOS/nixpkgs/compare/5d401f9ed627a869fd231f63e4f8380022dcded5...stuebinm:nixpkgs:remove-mdDoc
i have not opened a pull request with it because that'd just ping a lot of people and i'm not sure if it would be accepted or people here would even be interested, so I thought I'd ask here beforehand
| 18:57:21 |
@terru:raccoon.college | (the manual built afterwards & is identical to the manual before the change; i haven't done documentation work on nixpkgs before and am a little unsure how to do further testing/qa on this) | 19:18:45 |
| @me:indeednotjames.com joined the room. | 19:21:51 |
fricklerhandwerk | Nice! I think we should not just rip out the mdDoc definition but rather throw with an informative error message for another release.
infinisil, guardian of architectural sanity, please give your blessing.
| 20:12:40 |
@terru:raccoon.college | fair ennough (should it be an outright error or just a trace for now?). if nothing else comes up i'd open a PR with this built on then-current master sometime tomorrow | 21:09:05 |
@terru:raccoon.college | * fair enough (should it be an outright error or just a trace for now?). if nothing else comes up i'd open a PR with this built on then-current master sometime tomorrow | 21:09:17 |
| 13 Apr 2024 |
djacu | Hey all
I could use some help with understanding how NRD works and how to document library files properly.
For reference, I am working on this PR that adds network functions to the nixpkgs library. https://github.com/NixOS/nixpkgs/pull/299409
The manual is failing to build and when I try to build it locally I see this:
RuntimeError: failed to render manual manual.md
error:
failed to render manual manual.md
caused by:
rendering lib.md
caused by:
rendering functions.md
caused by:
rendering functions/library.md
caused by:
rendering /nix/store/b94j5fg7rf3m7w6s76by60jd7hb1avry-nixpkgs-lib-docs/network.md
caused by:
bad local reference, id #function-library-lib.network.ipv4.fromCidrString not known
which i've determine to be caused by this line in the default.nix doc comment
- [`lib.network.ipv4.fromCidrString`](#function-library-lib.network.ipv4.fromCidrString):
This makes sense that it can't find it because if I remove the line, it does build, but there is no documentation for the functions I have created in the manual.
Any advice?
| 04:10:04 |
djacu | okay more info I found out.
If i change the reference from
#function-library-lib.network.ipv4.fromCidrString
to
#function-library-lib.network.ipv4
it builds and renders fine
but ipv4 is just a namespace for all my functions inside of the network library. Can we not access functions inside of an attrset or do I need to write things differently so it works?
| 04:16:10 |
tomberek | Not sure if that much nesting is ok: https://github.com/NixOS/nixpkgs/blob/master/doc/doc-support/lib-function-locations.nix#L25-L31 | 04:16:49 |
tomberek | If I remove the "ipv4" layer of nesting and adjust the reference, it builds okay. So it seems like the doc infra doesn't allow that much? | 04:18:49 |
djacu | Well that is unfortunate. Thanks for verifying my results tomberek | 04:24:09 |
@olafklingt:matrix.org | is your use of doc comment inentional? Starting with "/**"?
https://github.com/nix-community/nixdoc | 10:48:13 |
@olafklingt:matrix.org | Sorry yes obviously it's intentional ๐ sorry for the noise | 10:50:16 |
@terru:raccoon.college | * hey all, i recently got it into my head to write a little tool which automatically edits nix files without messing them up, and got it to a point where it can remove e.g. all mentions of lib.mdDoc from nixpkgs. I have a changeset of it applied to master or ~an hour ago here: https://github.com/NixOS/nixpkgs/compare/5d401f9ed627a869fd231f63e4f8380022dcded5...stuebinm:nixpkgs:eed6c7c5de883d78d8185adaf4949c0fb7f8f44f
i have not opened a pull request with it because that'd just ping a lot of people and i'm not sure if it would be accepted or people here would even be interested, so I thought I'd ask here beforehand
| 13:13:37 |
infinisil | In reply to @terru:raccoon.college fair enough (should it be an outright error or just a trace for now?). if nothing else comes up i'd open a PR with this built on then-current master sometime tomorrow You can use lib.warn (which gives a trace) :) | 13:36:52 |
@terru:raccoon.college | i know. my question was more: should it give a trace, or should it give a hard (failing) error directly? | 13:38:22 |
@terru:raccoon.college | but i'll use lib.warn if that's preferred (just be a second, I was literally just writing the PR message for this ๐) | 13:39:15 |
infinisil | Answered on GitHub: https://github.com/NixOS/nixpkgs/pull/299409#issuecomment-2053650225 | 13:41:19 |
infinisil | (it can work) | 13:41:35 |