!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

439 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
17 Jul 2023
@infinisil:matrix.orginfinisilBtw this is using the repository-as-RFC approach proposed in https://github.com/NixOS/rfcs/pull/13818:47:27
@raitobezarius:matrix.orgraitobezarius
In reply to @brian:bmcgee.ie
I lean more Domen Kožar's direction on this one for the simple reason that the majority of my 2 years with Nix has been flake-oriented. The only time I write a shell.nix is to make a project compatible for non flake users. There are valid concerns about flakes and a need to stabilise them. Maybe I'm putting effort in the wrong place and should be helping to stabilise flakes like you said infinisil rather than putting effort into documenting a workflow I choose not to use on a daily basis (and I say this without any kind of snark or ill feeling).

Just to provide another datapoint: I have spent my last years removing Flakes from project (latest example in mind is bcachefs with an impossible Flake setup…), dealing with people who tries to shoehorn Flakes into the wrong project because it is not fit for it, dealing with a lot of kind of footguns generated by deep dependency management brought by Flakes, etc.

While I do understand the value of Flakes and use them sparringly or have projects with them, I am not excited to see documentation team having to focus on that, especially given that most people does not know how to do things the vanilla way (sometimes people do say the "legacy" which irks me the wrong way, because Flakes does not supplement the vanilla usecases yet, for example, try to repair your remote store with the "nix-command" CLI :))

19:10:16
@nerves:bark.lgbt@nerves:bark.lgbt joined the room.20:29:45
@infinisil:matrix.orginfinisilWould like to have some opinions on this: https://github.com/NixOS/nixpkgs/issues/24405621:36:53
18 Jul 2023
@nbp:mozilla.orgnbpFrom my point of view, is was kind of part of it, as this was the natural evolution of extending Nixpkgs with a new set of packages. This point was probably more true before the addition of overlays … :/14:42:53
@nbp:mozilla.orgnbp * infinisil: From my point of view, is was kind of part of it, as this was the natural evolution of extending Nixpkgs with a new set of packages.
This point was probably more true before the addition of overlays … :/
14:43:18
@nbp:mozilla.orgnbpMaybe a work-around would be to index the Markdown files, saying that the everything related to submitting patches upstream, in Nixpkgs, would be describe in a set of files which are part of the distributed sources.14:44:44
@mikecm:matrix.orgmikecm joined the room.15:39:24
@infinisil:matrix.orginfinisil proofconstruction: Interesting coincidence: https://www.reddit.com/r/NixOS/comments/1531nyc/installing_nixos_on_raspberry_pi_4/, in that blog post GUI works, but they're using an older NixOS version. There's also an appendix that links to failed attempts. Maybe you could contact the author to work together on improving the nix.dev tutorial for that even more (ideally encourage them to contribute the docs upstream) 20:59:53
@proofconstruction:matrix.orgproofconstruction
In reply to @infinisil:matrix.org
proofconstruction: Interesting coincidence: https://www.reddit.com/r/NixOS/comments/1531nyc/installing_nixos_on_raspberry_pi_4/, in that blog post GUI works, but they're using an older NixOS version. There's also an appendix that links to failed attempts. Maybe you could contact the author to work together on improving the nix.dev tutorial for that even more (ideally encourage them to contribute the docs upstream)
I have already been in contact with this person since last week, and have of course encouraged contribution upstream 🙂
21:00:52
@proofconstruction:matrix.orgproofconstruction Seems that there's some relatively recent issue in nixos-hardware which is preventing X11 rendering. I have very little time to chase after that, though, and no personal interest: my pi4 is a headless router. We discussed this briefly in a previous meeting, but unless someone wanted to own this documentation (and really, it should be whoever is working on rpi support in nixos-hardware), I would actually prefer to just remove the existing tutorial and let people find the wiki page, or the post by that user, etc 21:05:18
@infinisil:matrix.orginfinisil proofconstruction: Sounds good! 21:07:09
20 Jul 2023
@alejandrosame:matrix.orgalejandrosameI won't be able to join today's meeting.04:59:02
@brian:bmcgee.ie@brian:bmcgee.ieCan't make it today, just got pulled into a client call 12:29:12
@proofconstruction:matrix.orgproofconstruction Me either for the LJWG. Only update is PR #650 in progress, making edits based on @fricklerhandwerk's review and will have them pushed before tomorrow. Feel free to add comments to that one. In particular I'd like to have one or two more packages to write increasingly complex derivations for, to demonstrate things like NIX_LD_PATH and pkg-config includes. I also don't have a good story for how to determine where a dependency lives (in the tutorial, we need X11/Xlib.h from xorg.libX11.dev but I don't know a nice way to actually find these things beyond googling and knowing something about packaging conventions in other projects. Suggestions welcome 13:12:19
@rigille:matrix.orgRígille S. B. Menezes joined the room.17:14:12
@infinisil:matrix.orginfinisil pennae: asymmetric: I fixed the line indentation bug in nixdoc :D https://github.com/nix-community/nixdoc/pull/62 18:33:18
@pennae:matrix.eno.spacepennae
In reply to @infinisil:matrix.org
pennae: asymmetric: I fixed the line indentation bug in nixdoc :D https://github.com/nix-community/nixdoc/pull/62
it looks like you reinvented textwrap::dedent?
18:44:50
@infinisil:matrix.orginfinisil pennae: I did apparently! Although there's some special handling for the first line 18:45:29
@pennae:matrix.eno.spacepennaenot sure the first line should be handled specially18:50:28
@pennae:matrix.eno.spacepennaedo you have an example where dedent would misbehave?18:50:39
@infinisil:matrix.orginfinisil

pennae: For cases like

/* This is some docs
For a function
*/
18:50:55
@pennae:matrix.eno.spacepennae that would be handled by dedent(...).trim() 18:51:36
@infinisil:matrix.orginfinisil

Also:

/*
  Type: foo :: {
    x :: Int;
    y :: Bool;
  }
*/ 
18:52:00
@infinisil:matrix.orginfinisil
In reply to @pennae:matrix.eno.space
that would be handled by dedent(...).trim()
Ahh 🤔
18:52:19
@infinisil:matrix.orginfinisilYeah lemme try dedent then :)18:52:30
@pennae:matrix.eno.spacepennae
In reply to @infinisil:matrix.org

Also:

/*
  Type: foo :: {
    x :: Int;
    y :: Bool;
  }
*/ 
that too? dedent ignores the first line, the rest is dedented by two spaces
18:52:31
@infinisil:matrix.orginfinisil pennae: Are you sure? The docs don't mention anything of that 18:53:43
@infinisil:matrix.orginfinisilAnyways, I'll just try it out18:53:47
@infinisil:matrix.orginfinisilYeah it doesn't treat the first line differently19:01:12

Show newer messages


Back to Room ListRoom Version: 6