NixOS / NixOS/nix.dev

Confusion Between File System Paths and Store Paths

Open
#1,206 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

site
Dominant language
Nix
Stars
4k
Forks
339
Avg merge
2d 11h
Merged PRs (30d)
7

Description

Observations

Section https://nix.dev/tutorials/nix-language#file-system-paths describes what Eelco's thesis https://edolstra.github.io/pubs/phd-thesis.pdf Section 5.2.2 store paths as file system paths. While learning nix, I was confused by this idea, since I assumed store paths would always point to my file system. What I eventually learned was that store paths as described in the nix language are, at least in my head, "many-faced paths".

I didn't understand that nix translates paths into store derivations, and therefore I didn't know why my xmonad.hs couldn't find a wallpaper.jpg located on my filesystem.

Problem

I was confused why paths were treated as primitive types in the nix language, and I didn't understand that nix maps these to store paths.

Approaches

Instead of calling these "File system paths", call these "Store paths" instead. Explain that these point to the filesystem when you're declaring the configuration, but that they get translated to store paths when derivations are built.

Willing to help?

Yes.

Priorities

Add 👍 to issues you find important.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “File system paths” section in the Nix language tutorial and compare its wording with Section 5.2.2 of Eelco’s thesis. Revise the explanation so it distinguishes paths during configuration from store paths used when derivations are built, and confirm the xmonad.hs and wallpaper.jpg example is understandable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.