Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make example path for NixOS install consistent #13

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make example path for NixOS install consistent #13

wants to merge 1 commit into from

Conversation

ThibaultLemaire
Copy link

Yeah I'm the kind of guy that copy-pastes stuff. And this one didn't work :(

@ThibaultLemaire ThibaultLemaire changed the title Make example path for NixOS install consistent WIP: Make example path for NixOS install consistent Dec 18, 2020
@ThibaultLemaire ThibaultLemaire changed the title WIP: Make example path for NixOS install consistent Make example path for NixOS install consistent Dec 18, 2020
@lf-
Copy link
Owner

lf- commented Dec 19, 2020

Hi! I'm not sure if I understand the full context of this change. It looks like it's moving the code to the parent directory of the programs directory. I'm unfamiliar as to the implications of such though (this section of the readme was contributed, and I don't personally use home-manager). Can you clarify how the directory layout works?

Do we still need to provide that style of install information now that nix-doc is in nixpkgs and is otherwise in maintenance mode, from my end (I don't have any planned features and don't know of any bugs; it just works)?

Thanks for your contribution!

@ThibaultLemaire
Copy link
Author

ThibaultLemaire commented Dec 19, 2020

nix-doc is in nixpkgs

Oh it is 😮 ? Silly me I found your project here and didn't check 🤦‍♂️

If you're okay with removing that part of the documentation, I can change this PR to replace it with an example of using it from nixpkgs (i.e. nix-shell --packages nix-doc --run "nix-doc callPackage"). (Although that command doesn't work on my end, but I've opened #14 about that)

Can you clarify how the directory layout works?

There's no convention here. It's just that the previous section of the README says to put a derivation file in /etc/nixos/program/nix-doc/default.nix (where the program/nix-doc/ part is just arbitrary). But then the following section gives example code of how to call this custom derivation from the /etc/nixos/configuration.nix (note that this is the system configuration, nothing to do with home-manager here, although it would work the same). This is where the inconsistency was: the system configuration was trying to call a package located at /etc/nixos/../program/nix-doc/ == /etc/program/nix-doc/ and I got an error that it couldn't find the file.

But if it's in nixpkgs anyway I vote we just delete that part.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants