Nix Documentation | 431 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 89 Servers |
| Sender | Message | Time |
|---|---|---|
| 15 Jan 2024 | ||
| I've made the changes to https://github.com/NixOS/nixpkgs/pull/277534 that we talked about during today's docs meeting, hopefully mergeable at this point when CI is done. | 16:32:27 | |
| Redacted or Malformed Event | 19:15:50 | |
| * The rebuild impact of https://github.com/NixOS/nixpkgs/pull/275701 (the patch by cwp that fixes Python binary wrappers) is pretty huge. About half of everything depended upon in the devenv examples must be recompiled. Everything works so far, but I can imagine pushing that PR through into nixpkgs master is going to take a good long while due to its impact. I think maybe we should think about using our own makeWrapper in devenv itself that produces fixed Python binary wrappers in the meantime? Basically just kinda copy over the stuff from python/wrapper.nix and use it instead of the stuff in nixpkgs? | 19:16:37 | |
Is there a preferred manpage resource that I can use to link directly to the manpage of a command inside the nixpkgs manual? I did a search on the manual, but only found text like ...can be found in the dyld(1) manpage without any links to any manpage. | 22:01:45 | |
| Arch has e.g. man.archlinux.org which they use a lot in their docs to link to manpages. I'm wondering if there's something similar for nixpkgs/nixos that I can use. Otherwise I'll just keep it without a link | 22:02:41 | |
In reply to @danielsidhion:nixos.devI haven't run into any such thing yet, no. On the Discord people often end up linking to man.archlinux.org, or even wiki.archlinux.org | 22:08:58 | |
| When googling for something in the man pages, there are a variety of hosts that come up | 22:09:30 | |
| are there some out of those that are particularly reputable? | 22:10:14 | |
danielsidhion: bzm3r: https://github.com/NixOS/nixpkgs/tree/master/doc#roles links to manpage-urls.json, seems to be mainly systemd links, I can't see much else | 23:00:35 | |
| So I guess the answer is that there's no default for now :) | 23:00:53 | |
| (though there might be some used in various other parts of the docs) | 23:01:08 | |
Yeah, I didn't really know if there was some kind of default. The nixpkgs manual doesn't use that {manpage} syntax at all. Guess I'll start using it then. | 23:43:43 | |
| My concern isn't in finding some reputable source, but mostly in having a link to the manpages corresponding to the version of the package in nixpkgs | 23:44:34 | |
| Ah yeah that could be a problem. If we want to be fancy and rabbit-holey, we could make Hydra render all manpages from package builds and create some convenient redirects :D | 23:58:48 | |
| 16 Jan 2024 | ||
| I'd have to spend a lot of time to figure this out so I added it to my notes to look into this at some point. I think it would be a good improvement to have access to the manpages from nixpkgs directly | 00:02:44 | |
| proofconstruction: do you usually run the Monday meetings? | 04:36:06 | |
In reply to @infinisil:matrix.orgthis would be awesome to have | 04:40:00 | |
| fricklerhandwerk: from the language reference ("lang-ref", https://github.com/NixOS/nix/tree/master/doc), re: nix:
| 05:06:38 | |
| I think I understand sufficiently now: "sequencing" here refers to sequencing of computing operations. There is no explicit sequencing of computing operations. Only implicit sequencing of computing operations through data dependencies. | 05:26:23 | |
| * I think I understand sufficiently now: "executing sequential steps" here refers to explicit sequencing of computing operations. There is no explicit sequencing of computing operations. Only implicit sequencing of computing operations through specification of data dependencies. | 05:26:55 | |
| * I think I understand sufficiently now: "executing sequential steps" here refers to explicit sequencing of computing operations. There is no explicit sequencing of computing operations. Only implicit sequencing of computing operations through specification of data dependencies is allowed. | 05:45:47 | |
| * I think I understand sufficiently now: "executing sequential steps" here refers to explicit sequencing of computing operations. There is no explicit sequencing of computing operations. Sequencing of computing operations only happens implicitly through specification of data dependencies. | 05:46:09 | |
In reply to @bzzm3r:matrix.orgThat’s right, it’s not exactly right. Of course the evaluator does things in some sequence, you just don’t have much control over it. The “executing sequential steps” is an old fragment I took from something or someone. Feel free to suggest a rewording in a PR | 07:09:49 | |
In reply to @bzzm3r:matrix.org* That’s right, it’s not very precise and, if you think too hard about it, potentially misleading. Of course the evaluator does things in some sequence, you just don’t have much control over it. The “executing sequential steps” is an old fragment I took from something or someone. Feel free to suggest a rewording in a PR | 07:10:20 | |
| Thinking too hard about stuff usually reveals that it’s all a scam… | 07:11:37 | |
| Sounds good. Currently I'm working on a PR to enable auto-formatting of EBNF in the Nix (reference) manual. (Rather than manually formatting the markdown...) | 07:11:38 | |
In reply to @bzzm3r:matrix.orgThat would be cool. Just writing down the EBNF would be way cooler though because the first is cosmetic while the second is essential. | 07:12:48 | |
In reply to @bzzm3r:matrix.org* That would be cool. Just writing down the EBNF in the first place would be way cooler though because the first is cosmetic while the second is essential. | 07:12:58 | |
In reply to @fricklerhandwerk:matrix.org I can do that first quite happily! But then it won't live in the docs "properly", as it won't be formatted per the contributing instructions. Perhaps it can just live in a side branch, where it can still receive reviews? | 07:13:48 | |
| I was not thrilled when I found out how the EBNF had to be formatted. | 07:14:08 | |