!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

398 Members
Discussion about documentation improvements around the Nix ecosystem79 Servers

Load older messages


SenderMessageTime
16 Mar 2024
@pennae:matrix.eno.space@pennae:matrix.eno.spaceissue number for what?19:02:54
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostI assumed we had an issue for page splitting. Might not be true then?20:52:54
@pennae:matrix.eno.space@pennae:matrix.eno.spaceah. can't remember one immediately at least20:53:50
@pennae:matrix.eno.space@pennae:matrix.eno.spaceyeah, there isn't one we could find either20:57:09
@fricklerhandwerk:matrix.orgfricklerhandwerk

There's some top-level attribute rev being passed through to the manual rendering machinery, which is used to create the source links. It comes from flake.nix, but I just can't find where and how it's set.

Ideas?

21:53:40
@fricklerhandwerk:matrix.orgfricklerhandwerk *

There's some top-level attribute rev being passed through to the Nixpkgs manual rendering machinery, which is used to create the source links. It comes from flake.nix, but I just can't find where and how it's set.

Ideas?

21:53:58
@pennae:matrix.eno.space@pennae:matrix.eno.spaceset by the flake machinery because it's a git repo, probably21:54:42
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @pennae:matrix.eno.space
set by the flake machinery because it's a git repo, probably

Hm no, at least I don't see how a flake would do that. An empty flake like this:

{
  outputs = { self, ... }: {
    foo = self;
  };
}

called with nix eval .#foo doesn't show a rev attribute.

21:59:30
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @pennae:matrix.eno.space
set by the flake machinery because it's a git repo, probably
*

Hm no, at least I don't see how a flake would do that. An empty flake in a Git repo, like this:

{
  outputs = { self, ... }: {
    foo = self;
  };
}

called with nix eval .#foo doesn't show a rev attribute.

21:59:58
@pennae:matrix.eno.space@pennae:matrix.eno.spacecommit it22:03:24
@fricklerhandwerk:matrix.orgfricklerhandwerkI did22:03:31
@pennae:matrix.eno.space@pennae:matrix.eno.spaceshows up having a rev for us22:03:47
@fricklerhandwerk:matrix.orgfricklerhandwerkAh okay, apparently something was weird when using an existing repo. It worked in a clean one.22:04:23
@fricklerhandwerk:matrix.orgfricklerhandwerkThanks. Cursed stuff.22:06:21
@pennae:matrix.eno.space@pennae:matrix.eno.spacethat's flakes for you22:06:28
@fricklerhandwerk:matrix.orgfricklerhandwerk

There is more Nix nature in one line of Nix language than in ten thousand lines of C++

https://www.catb.org/esr/writings/unix-koans/ten-thousand.html

22:08:32
17 Mar 2024
@rina/:matrix.orgkait
In reply to @fricklerhandwerk:matrix.org

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.

indeed, the wiki is useful but I also find it goes into too much detail with flag setting. most of the time, if you set up things correctly, it should "just work". maybe I can add a section here in the meantime
01:00:37
@rina/:matrix.orgkait
In reply to @fricklerhandwerk:matrix.org

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.

that is good to see! I was actually thinking about the writers that live under scripts.nix (confusingly named indeed). these let you write python and many other languages inline and are, afaict not in the manual at all
01:02:20
@rina/:matrix.orgkaitthere is an aged issue about it: https://github.com/NixOS/nixpkgs/issues/8975901:03:11
@rina/:matrix.orgkaitthere is documentation in the source, so maybe it's an issue of making them render in the manual? not sure01:06:41
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @rina/:matrix.org
there is documentation in the source, so maybe it's an issue of making them render in the manual? not sure
Yeah it probably just needs to be wired up
03:16:31
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @rina/:matrix.org
there is documentation in the source, so maybe it's an issue of making them render in the manual? not sure
If you could give a concrete example i can tell you if its a wiring issue or would need to be maintained seperately anyways in the long term. I remembered that the writers because some of them are dynamically created by partial application
15:44:08
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @rina/:matrix.org
there is documentation in the source, so maybe it's an issue of making them render in the manual? not sure
* If you could give a concrete example i can tell you if its a wiring issue or would need to be maintained seperately anyways in the long term. I remembered that the writers because some of them are dynamically created by partial application and callPackages (plural s)
15:44:33
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * If you could give a concrete example i can tell you if its a wiring issue or would need to be maintained seperately anyways. I remembered that the writers have some difficulties. Because some of them are dynamically created by partial application and mapped via callPackages (plural s). 15:48:12
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostDepends which methods we use for wiring them up.15:54:02
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostI am also not sure when it was decided to move reference documentation out of the source it is related to. I think this is a mistake. https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/trivial-builders/default.nix We still have nixdoc to retrieve doc-comments and it was extended recently. So wiring should only be a question of adding more files to the index.16:00:33
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostExpanding it should be question of adding more include blocks like this: https://github.com/NixOS/nixpkgs/blob/178fc9602881340bd8c02c0f9b64c25aedc0eb53/doc/doc-support/lib-function-docs.nix#L32C1-L39C3416:01:45
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * I am also not sure when it was decided to move reference documentation out of the source it is related to. I think this was mistake. https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/trivial-builders/default.nix We still have nixdoc to retrieve doc-comments and it was extended recently. So wiring should only be a question of adding more files to the index.16:02:14
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * I am also not sure when it was decided to move reference documentation out of the source it is related to. I think this was mistake. I just took a look at this file: https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/trivial-builders/default.nix It appears all doc-comments where removed from the code. Regardless we still have nixdoc to retrieve doc-comments and it was extended recently. So wiring should only be a question of adding more files to the index.16:04:32
@infinisil:matrix.orginfinisil Johannes Kirschbauer @hsjobeki: See https://github.com/NixOS/nixpkgs/pull/294944, I wouldn't call it being moved out of the source. Rather it was dedulicated in one place 17:04:42

Show newer messages


Back to Room ListRoom Version: 6