lib, treewide: introduce repoRevToName and use it to cleanup most fetch* functions
#316668
Conversation
github-actions
bot
added
6.topic: fetch
6.topic: lib
oxij
changed the title
repoRevToName and use to cleanup most fetch* functionsrepoRevToName and use it to cleanup most fetch* functions
| @@ -254,6 +254,64 @@ let | |||
| outPath = builtins.path { inherit filter name; path = origSrc; }; | |||
| }; | |||
|
|
|||
| # urlToName : (URL | Path | String) -> String | |||
| # | |||
| # Transform a URL (or path, or string) into a clean package name. | |||
There was a problem hiding this comment.
Maybe I can be wrong, but the general term is URI.
There was a problem hiding this comment.
As a thing more general than a URL? Yes. But here it is literally "a URL, or a path, or a string (a package name, usually)".
| # /nix/store paths. | ||
| # | ||
| # This uses a different implementation depending on the `pretty` argument: | ||
| # false -> name everything as "source" |
There was a problem hiding this comment.
To be honest I do not like dual-type attributes. This is a serious footgun in a duck-typed language.
And let's remember Nix is not stellar on the error report department:
https://discourse.nixos.org/t/rant-finding-errors-in-module-configs-after-incompatible-upgrades-is-dreadful/46375
Either is everything a string, say format ? "short", "medium", "long" or we stick to only two options (and then we can use a Boolean).
There was a problem hiding this comment.
But it is not checked by Nix but by the config.nix and NixOS typing infra, and the errors it generates are pretty nice, e.g. with nameSourcesPrettily = "error":
$ nix-instantiate ./default.nix -A xlife
error: A definition for option `nameSourcesPrettily' is not of type `boolean or value "full" (singular enum)'. Definition values:
- In `nixpkgs.config': "error"
(use '--show-trace' to show detailed location information)
There was a problem hiding this comment.
Hum, less bad.
Nonetheless, semantically it is a clear case for an enumeration with three possible states, instead of a weird Boolean-plus-an-extra.
| @@ -50,6 +50,39 @@ let | |||
| default = false; | |||
| }; | |||
|
|
|||
| nameSourcesPrettily = mkOption { | |||
There was a problem hiding this comment.
| nameSourcesPrettily = mkOption { | |
| usePrettierSourceNames = mkOption { |
There was a problem hiding this comment.
Hm, but why? nameSourcesPrettily is shorter and means the same thing.
There was a problem hiding this comment.
It's shorter because it is more obscure.
verb-adjective-name is clearer than name-name-adverb.
On the other hand, it depends on the previous tristate vs boolean-plus-state discussion.
…ctions This patch adds `lib.repoRevToName` function that generalizes away most of the code used for derivation name generation by `fetch*` functions (`fetchzip`, `fetchFromGitHub`, etc, except those which are delayed until latter commits for mass-rebuild reasons). It's first argument controls how the resulting name will look (see below). Since `lib` has no equivalent of Nixpkgs' `config`, this patch adds `config.nameSourcesPrettily` option to Nixpkgs and then re-exposes `lib.repoRevToName config.nameSourcesPrettily` expression as `pkgs.repoRevToNameMaybe` which is then used in `fetch*` derivations. The result is that different values of `config.nameSourcesPrettily` now control how the `src` derivations produced by `fetch*` functions are to be named, e.g.: - `nameSourcesPrettily = false` (the default): ``` $ nix-instantiate -A fuse.src /nix/store/<hash>-source.drv ``` - `nameSourcesPrettily = true`: ``` $ nix-instantiate -A fuse.src /nix/store/<hash>-libfuse-2.9.9-source.drv ``` - `nameSourcesPrettily = "full"`: ``` $ nix-instantiate -A fuse.src /nix/store/<hash>-libfuse-2.9.9-github-source.drv ``` See documentation of `config.nameSourcesPrettily` for more info.
This is slightly more efficient.
oxij
force-pushed
the
tree/repo-to-name-part-1
branch
from
38ffa76
to
a09a1e7
Compare
This a first half of #49862. Basically, this is a noop cleanup that keeps all the
fetch*names as they are now, while introducing the newconfig.nameSourcesPrettilyoption.Changes
lib, treewide: introduce
repoRevToName, use it in mostfetch*functionsThis patch adds
lib.repoRevToNamefunction that generalizes away most of the code used for derivation name generation byfetch*functions (fetchzip,fetchFromGitHub, etc, except those which are delayed until latter commits for mass-rebuild reasons).It's first argument controls how the resulting name will look (see below).
Since
libhas no equivalent of Nixpkgs'config, this patch addsconfig.nameSourcesPrettilyoption to Nixpkgs and then re-exposeslib.repoRevToName config.nameSourcesPrettilyexpression aspkgs.repoRevToNameMaybewhich is then used infetch*derivations.The result is that different values of
config.nameSourcesPrettilynow control how thesrcderivations produced byfetch*functions are to be named, e.g.:nameSourcesPrettily = false(the default):nameSourcesPrettily = true:nameSourcesPrettily = "full":See documentation of
config.nameSourcesPrettilyfor more info.fetchsvn: move the name generator outside of the thunk
This is slightly more efficient.