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

docs: fix devmode for manuals #375194

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

fricklerhandwerk
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk commented Jan 20, 2025

Closes #362850

hard-coding a relative path will use the calling process's working
directory, but we want the path relative to the Nix expression.

this makes devmode in the following shells work again:

nix-shell doc
nix-shell nixos/doc/manual

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

hard-coding a relative path will use the calling process's working
directory, but we want the path relative to the Nix expression.
@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation labels Jan 20, 2025
@github-actions github-actions bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Jan 20, 2025
@fricklerhandwerk
Copy link
Contributor Author

I'm really not sure what ofborg is trying to tell me here...

Cannot nix-instantiate `docs` because:
error: attribute 'docs' in selection path 'docs' not found
       Did you mean one of dcs, doas, aocd, boca or bochs?
Cannot nix-instantiate `docs.passthru.tests` because:
error: attribute 'docs' in selection path 'docs.passthru.tests' not found
       Did you mean one of dcs, doas, aocd, boca or bochs?

Where does it even get docs? I wasn't involved in anything like that here.

@ShamrockLee
Copy link
Contributor

ShamrockLee commented Jan 23, 2025

Thank you for being so patient. I'll test it tomorrow.

Where does it even get docs? I wasn't involved in anything like that here.

I guess it's the PR title. It attempted to build buildPython* and buildPython*.passthru.tests in my recent PRs.

Copy link
Contributor

@ShamrockLee ShamrockLee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change looks reasonable.

Tested devmode command inside nix-shell doc, nix-shell nixos/doc/manual, nix develop -f doc/shell.nix, and nix develop -f doc/shell.nix, all working when CWD is the Nixpkgs project root. I also tried changing the CWD, and it also works.

The redirects command seems fixed before this PR.

@fricklerhandwerk fricklerhandwerk merged commit 61235d4 into NixOS:master Jan 24, 2025
59 of 61 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
2 participants