!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

377 Members
Discussion about documentation improvements around the Nix ecosystem90 Servers

Load older messages


SenderMessageTime
30 Dec 2024
@dimitarnestorov:matrix.orgDimitar Hey, could I get some guidance on this PR? What should I do next? Can I help somehow or maybe wait for something? https://github.com/NixOS/nixpkgs/pull/363755 10:28:10
@raitobezarius:matrix.orgraitobezarius changed their display name from raitobezarius (DECT: 3538 / EPVPN 2681) to raitobezarius.16:29:44
@matthewcroughan:defenestrate.itmatthewcroughan changed their display name from matthewcroughan (DECT: 56490) to matthewcroughan.17:25:52
31 Dec 2024
@getchoo:matrix.orggetchoo changed their profile picture.12:38:52
@siraben:matrix.orgsiraben left the room.14:51:22
@phaer:matrix.orgphaer changed their display name from phaer (8650 at 38c3) to phaer.19:23:44
@yukiisbored:matrix.orgYuki Langley (they/them) changed their profile picture.19:36:12
@yukiisbored:matrix.orgYuki Langley (they/them) changed their display name from Yuki (they/them) to Yuki Langley (they/them).19:36:25
1 Jan 2025
@mjolnir:nixos.orgNixOS Moderation Botchanged room power levels.14:26:30
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @dimitarnestorov:matrix.org
Hey, could I get some guidance on this PR? What should I do next? Can I help somehow or maybe wait for something? https://github.com/NixOS/nixpkgs/pull/363755
It looks good, nothing to do here really. I'd hit the button, but GitHub doesn't want me to do a rebase for some reason, and I'm not sure if merge commits are desirable. getchoo any idea?
17:11:54
@dimitarnestorov:matrix.orgDimitarRebased on master17:21:06
2 Jan 2025
@hashphoenix:matrix.orgOluwapelumi Adeosun joined the room.10:16:01
@error_pro:matrix.orgerror_pro joined the room.10:44:29
3 Jan 2025
@elikoga:matrix.orgelikoga changed their display name from elikoga (@38c3 📞488{0,1,9}) to elikoga.10:28:01
4 Jan 2025
@kranzes:matrix.org@kranzes:matrix.org left the room.15:30:41
7 Jan 2025
@ruroruro:matrix.orgruro left the room.03:43:11
@allrealmsoflife:matrix.orgallrealmsoflife

Hello,

I'm trying to build the Nix manual following the instructions here:
https://nix.dev/manual/nix/2.25/development/documentation.

I have a few questions about the process:

  1. Where should I run the build command?
    For example, do I need to be in a specific directory for the commands to work correctly?

  2. Issues with nix-build output:
    When I run the following command in the src/nix directory:

    nix-build -E '(import ./.).packages.${builtins.currentSystem}.nix.doc'
    

    It generates a result directory, but it does not contain the expected index.html
    in a path like ./result-doc/share/doc/nix/manual/index.html. Instead, I see several
    subdirectories with their own index.html files. Additionally, there is no
    result-doc directory, only result. Is this the intended behavior?

  3. Error with nix build:
    When I try to use the newer command:

    nix build .#nix^doc
    

    I get the following error:

    error: derivation '/nix/store/91q76nmlb2aharvh227hlgv6xq78610m-nix-2.26.0pre20250102_442a262.drv' 
    does not have wanted outputs 'doc'
    

Could you clarify what might be going wrong or what adjustments I need to make? Thank you for your help!

08:39:56
@allrealmsoflife:matrix.orgallrealmsoflife

Also when I try the third option, enter the development shell, and run:

[nix-shell:~/src/nix]$ make manual-html-open -j $NIX_BUILD_CORES
make: *** No rule to make target 'manual-html-open'.  Stop.
09:15:40
@fricklerhandwerk:matrix.orgfricklerhandwerk Hey allrealmsoflife! Thanks for sharing feedback. 15:07:09
@fricklerhandwerk:matrix.orgfricklerhandwerk
  1. The Nix expression for nix-build is meant relative to the repo root, so you have to run it from there.

How all this works is not optimal, and that’s one reason I have rather strong opinions about the flakes complex…

15:08:45
@fricklerhandwerk:matrix.orgfricklerhandwerk
  1. This is probably an artefact in the documentation prose. The command is expected to produce result. I‘m confused why there’s no obvious entry point and will check when I‘m back at the keyboard
15:10:43
@fricklerhandwerk:matrix.orgfricklerhandwerk
  1. The instructions are outdated, flake.nix has been refactored apparently.

I‘m not even sure there’s a meaningful new-CLI way to do the same thing as with nix-build, but probably I’m wrong and not well-educated on the recently updated build setup and there’s a quick fix to make it nice.

15:15:04
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @allrealmsoflife:matrix.org

Also when I try the third option, enter the development shell, and run:

[nix-shell:~/src/nix]$ make manual-html-open -j $NIX_BUILD_CORES
make: *** No rule to make target 'manual-html-open'.  Stop.
Make has been decommissioned in favor of Meson, that part can be removed from the instructions.
15:16:05
@fricklerhandwerk:matrix.orgfricklerhandwerk I won’t be able to make time to address this myself, so I’d greatly appreciate PRs to iron out these kinks and will review and merge them when I find a few quiet minutes 15:18:21
@fricklerhandwerk:matrix.orgfricklerhandwerk* I won’t be able to make time to address this myself in the next couple of weeks at the very least, so I’d greatly appreciate PRs to iron out these kinks and will review and merge them when I find a few quiet minutes15:18:45
@allrealmsoflife:matrix.orgallrealmsoflife

Okay, I built it. I do nix --version to get the version number and add that to the flake command: nix build nix/2.24.11\#nix^doc. Otherwise just the #nix^doc it won't work. One way to grab the version inside the command: nix build nix/$(nix --version | awk '{print $3}')#nix^doc

Now the flake command builds the result-doc while the nix-build command builds the result directories. Both results do have the index.html within the ./result-doc/share/doc/nix/manual/index.html or ./result/share/doc/nix/manual/index.html.

17:31:05
@allrealmsoflife:matrix.orgallrealmsoflife *

Okay, I built it. I do nix --version to get the version number and add that to the flake command: nix build nix/2.24.11#nix^doc. Otherwise just the #nix^docit won't work. One way to grab the version inside the command:nix build nix/$(nix --version | awk '{print $3}')#nix^doc`

Now the flake command builds the result-doc while the nix-build command builds the result directories. Both results do have the index.html within the ./result-doc/share/doc/nix/manual/index.html or ./result/share/doc/nix/manual/index.html.

17:31:27
@allrealmsoflife:matrix.orgallrealmsoflife *

Okay, I built it. I do nix --version to get the version number and add that to the flake command:

nix build nix/2.24.11#nix^doc

Otherwise just the #nix^docit won't work. One way to grab the version inside the command:

nix build nix/$(nix --version | awk '{print $3}')#nix^doc\

Now the flake command builds the result-doc while the nix-build command builds the result directories. Both results do have the index.html within the ./result-doc/share/doc/nix/manual/index.html or ./result/share/doc/nix/manual/index.html.

17:32:05
@allrealmsoflife:matrix.orgallrealmsoflife *

Okay, I built it. I do nix --version to get the version number and add that to the flake command:

nix build nix/2.24.11#nix^doc

Otherwise just the #nix^docit won't work. One way to grab the version inside the command:

nix build nix/$(nix --version | awk '{print $3}')#nix^doc\

Now the flake command builds the result-doc while the nix-build command builds the result directories. Both results do have the index.html within the ./result-doc/share/doc/nix/manual/index.html or ./result/share/doc/nix/manual/index.html.

17:32:43
@allrealmsoflife:matrix.orgallrealmsoflife *

Okay, I built it. I do nix --version to get the version number and add that to the flake command:

nix build nix/2.24.11#nix^doc

Otherwise just the #nix^docit won't work. One way to grab the version inside the command:

nix build nix/$(nix --version | awk '{print $3}')#nix^doc

Now the flake command builds the result-doc while the nix-build command builds the result directories. Both results do have the index.html within the ./result-doc/share/doc/nix/manual/index.html or ./result/share/doc/nix/manual/index.html.

17:33:18

Show newer messages


Back to Room ListRoom Version: 6