NixOS / NixOS/nix.dev

Confusion between fetchers implemented by builtins and by nixpkgs.

Open
#1,190 2 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
A note in the section on Fetchers in the Chapter Nix Language Basics, refers to the Nixpkgs Manual on Fetchers but doesnt provide the information that these are distinct from the fetchers built into Nix by default and also have considerable differences.

Relevant Section:
https://nix.dev/tutorials/nix-language#fetchers

See:
https://discourse.nixos.org/t/builtins-fetchurl-vs-nixpkgs-fetchurl/24133

Problem
This can cause confusion as to, if the manual describes the builtin Fetchers or describes Fetchers implemented by nixpkgs. (Atleast it did to me)

Approaches
Make it clear in the note that nixpkgs implements their own fetchers and also additional fetchers over the builtin fetchers. Also note that Fetcher implementations differ and they cant be just interchanged.

Willing to help?
I could make the change I suppose. I have not made any opensource contribution yet, but I like Nix and this guide and I am open to it.

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 Fetchers section in the Nix Language Basics tutorial and compare its note with the Nixpkgs Manual and the linked Discourse discussion. Update the note so readers can distinguish built-in Nix fetchers from nixpkgs fetchers, understand that implementations differ, and know they cannot be interchanged directly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.