!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

401 Members
Discussion about documentation improvements around the Nix ecosystem80 Servers

Load older messages


SenderMessageTime
16 Mar 2024
@ryantm:matrix.orgryantm

Oh wait, I don't think that time is apples to apples:

[ryantm@replit1:~/p/nixpkgs]$ /run/current-system/sw/bin/time nix-build --check pkgs/top-level/release.nix -A manual.inputDerivation
trace: warning: lib.zipWithNames is a deprecated alias of lib.zipAttrsWithNames.
this derivation will be built:
  /nix/store/j622rlm0k013mmspbzgkqgd4zl12vvvd-nixpkgs-manual.drv
error: some outputs of '/nix/store/j622rlm0k013mmspbzgkqgd4zl12vvvd-nixpkgs-manual.drv' are not valid, so checking is not possible
Command exited with non-zero status 1
0.59user 0.18system 0:01.53elapsed 50%CPU (0avgtext+0avgdata 174980maxresident)k
0inputs+0outputs (0major+39908minor)pagefaults 0swaps

[ryantm@replit1:~/p/nixpkgs]$ nix path-info --recursive --closure-size --human-readable ./result
/nix/store/m94bxwbilm1hh0dzk53qs7zvdr1vwsps-nixpkgs-manual     2.0M
05:22:56
@ryantm:matrix.orgryantmThe manual is already built as the inputDerivation to that derivation.05:23:37
@ryantm:matrix.orgryantmNix is so hard to benchmark with the all the caching and indirection.05:24:40
@infinisil:matrix.orginfinisil ryantm: Not sure what you mean, I'm pretty sure nix-build --check pkgs/top-level/release.nix -A manual is the actual build, it's not just a dependency 05:25:23
@infinisil:matrix.orginfinisilAnd the command you pasted failed05:25:33
@ryantm:matrix.orgryantmAh yeah, oops. Okay.05:25:53
@infinisil:matrix.orginfinisil (gotta build without --check first.. yeah not a great interface) 05:25:58
@ryantm:matrix.orgryantmRedacted or Malformed Event05:26:59
@ryantm:matrix.orgryantmUpdated the gist again. Looks like the nixpkgs closure is bigger, but the nixpkgs closure matters less.05:28:28
@infinisil:matrix.orginfinisilCould you post the results in the github issue? I'm overall not very convinced that this is worth it though ๐Ÿ˜…05:29:31
@infinisil:matrix.orginfinisil * Could you post the results in the github issue (ideally a nice markdown table with the numbers)? I'm overall not very convinced that this is worth it though ๐Ÿ˜…05:29:46
@ryantm:matrix.orgryantmYeah there's a lot of hate for C.05:30:00
@ryantm:matrix.orgryantmand your thing is already working mostly, though not multipage.05:30:23
@ryantm:matrix.orgryantmSeems reasonable not to switch.05:30:26
@infinisil:matrix.orginfinisilI feel kind of bad, you worked on this for so long ๐Ÿ˜…05:31:07
@ryantm:matrix.orgryantmI'll take down my multipage manual when we publish official ones.05:31:08
@ryantm:matrix.orgryantmNo big deal, I still love the project independent of Nix accepting it.05:31:34
@ryantm:matrix.orgryantmI use it for all my projects and blogs and stuff.05:31:44
@ryantm:matrix.orgryantmI love the easy interface with no config I came up with.05:31:59
@jade_:matrix.org@jade_:matrix.org
In reply to @ryantm:matrix.org
and your thing is already working mostly, though not multipage.
I've been told the code is literally there for it, though. so we seem to need to do some wiring.ย 
07:41:14
@pennae:matrix.eno.space@pennae:matrix.eno.space joined the room.09:23:50
@pennae:matrix.eno.space@pennae:matrix.eno.space(infinisil requested our presence :D)09:24:07
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @rina/:matrix.org
i am starting to see that. though, i do not mind pitching in where i can :)

What would you be interested in taking a closer look at? It would also help knowing what you may have had experience with already, to find something that wonโ€™t overwhelm or frustrate you too quickly. Feel free to DM me if you donโ€™t want this public.

Not everything needed to get started is written down nicely yet, so I can offer a brief guided tour of the various construction sites.

14:06:41
@rina/:matrix.orgkaithm off the top of my head, there are gaps around the trivial script writers - both in terms of documentation and the options they provide14:12:30
@rina/:matrix.orgkaiti mainly use nix outside nixos, and much of my packaging experience is with C/C++ and cmake. maybe more documentation on dealing with cmake external projects would be useful too14:14:06
@rina/:matrix.orgkaitbut these are just items i have had the need for in the past, I can try to help out elsewhere if able14:24:07
@rina/:matrix.orgkaitI'm actually heading to sleep now (in Australia), but I will read any replies tomorrow14:24:28
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @rina/:matrix.org
i mainly use nix outside nixos, and much of my packaging experience is with C/C++ and cmake. maybe more documentation on dealing with cmake external projects would be useful too

There is a wealth of information here: https://nixos.wiki/wiki/C

Mostly written by @Mic92 in past years AFAIK. Would be great to have that closer to the code, because all of that is Nixpkgs material.

We still haven't really figured out how to organise troubleshooting tips and other guide-like material across the ecosystem though. The last state of affairs was that we converged on the idea that it should be a bit like what Johannes Kirschbauer @hsjobeki proposes for function documentation, but for guides: have a uniform format used across Nix, Nixpkgs, and NixOS, and present that in one place, annotated with tags and searchable. But that is a lot of "should", and will require thinking about the structure of the manuals, and moving around lots of text.

15:27:15
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @rina/:matrix.org
hm off the top of my head, there are gaps around the trivial script writers - both in terms of documentation and the options they provide

Those were recently improved:

  • https://github.com/NixOS/nixpkgs/pull/280592
  • https://github.com/NixOS/nixpkgs/pull/277534

But there's definitely still work to do. Ideally we'd also render that stuff directly from the source. At least there is no duplication any more. I can imagine danielsidhion could help with reviews.

15:31:48
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @rina/:matrix.org
i mainly use nix outside nixos, and much of my packaging experience is with C/C++ and cmake. maybe more documentation on dealing with cmake external projects would be useful too
*

There is a wealth of information here: https://nixos.wiki/wiki/C

Mostly written by @Mic92 in past years AFAIK. Would be great to have that closer to the code, because all of that is Nixpkgs material.

We still haven't really figured out how to organise troubleshooting tips and other guide-like material across the ecosystem though. The last state of affairs was that we converged on the idea that it should be a bit like what Johannes Kirschbauer @hsjobeki proposes for function documentation, but for guides: have a uniform format used across Nix, Nixpkgs, and NixOS, and present that in one place, annotated with tags and searchable. But that is a lot of "should", and will require thinking about the structure of the manuals, moving around lots of text, and building automation for presenting the result.

15:32:40

Show newer messages


Back to Room ListRoom Version: 6