nixpkgs/pkgs/by-name
2024-03-09 08:31:50 +08:00
..
_4/_4th
_9/_9base
a4/a4
aa aaaaxy: 1.5.23 -> 1.5.42 2024-03-05 01:09:03 +00:00
ab/aba
ac
ad adalanche: init at 2024.1.11 2024-03-03 23:05:24 +01:00
ae
af
ag/ags ags: init at 1.8.0 2024-03-06 18:16:39 +08:00
ai
al
am Merge pull request from r-ryantm/auto-update/amazon-ssm-agent 2024-03-07 23:54:51 +01:00
an
ao/aocl-utils
ap api-linter: 1.63.6 -> 1.64.0 2024-03-05 00:49:25 +00:00
ar Merge pull request from r-ryantm/auto-update/arduino-ide 2024-03-07 10:05:48 +01:00
as
at
au audiness: 0.2.1 -> 0.3.0 2024-03-06 00:07:41 +01:00
av
aw
ax/axmldec
ay
ba
bc/bc-ur
be
bi
bk/bk
bl
bm/bmake bmake: 20240212 -> 20240301 2024-03-03 03:15:22 +00:00
bn/bngblaster
bo boogie: 3.0.10 -> 3.1.1 2024-03-07 08:07:39 +00:00
bp/bpftop
br bruteforce-salted-openssl: 1.4.2 -> 1.5.0 2024-03-06 15:30:45 +00:00
bs/bsync
bu
by
c2
c-
ca
cb/cbmbasic
cc/ccache
cd
ce
cg/cgl
ch
ci
cl cloudrecon: 1.0.3 -> 1.0.4 2024-03-05 13:27:22 +00:00
cm
cn/cntb
co codeium: 1.8.0 -> 1.8.5 2024-03-06 23:43:49 +01:00
cp
cr crc: 2.32.0 -> 2.33.0 2024-03-04 17:18:04 +00:00
cs
ct/ctx
cu/cursewords
cy
cz/czkawka
da
db/dbus-cpp
dc/dc3dd
dd/ddns-updater
de Merge pull request from chewblacka/update-decent-sampler 2024-03-07 02:56:54 +00:00
di disko: 1.3.0 -> 1.4.0 2024-03-06 16:57:30 +01:00
dj/djent
dm
dn/dns2tcp
do dorion: 4.1.2 -> 4.1.3 2024-03-07 12:34:32 +00:00
dp/dpp
dr/drone-scp
ds
dt/dtcmp
du
dv/dvb-apps
dx
dy
ea/easyeasm
eb
ec
ed
ei Merge pull request from r-ryantm/auto-update/eiwd 2024-03-07 16:36:20 +01:00
ek/eksctl
el
em
en
er
es
eu
ex extest: init at 1.0.2 2024-03-04 19:18:20 +11:00
ez/eza eza: 0.18.5 -> 0.18.6 2024-03-06 06:04:27 +01:00
fa
fb/fbset
fc
fe
ff
fi files-cli: 2.12.39 -> 2.12.40 2024-03-06 07:42:32 +00:00
fl flake-checker: 0.1.16 -> 0.1.17 2024-03-03 09:10:51 +00:00
fm
fn/fnott
fo
fr
fu/fuchsia-cursor
fw/fwupd
fy/fypp
ga galaxis: 1.10 -> 1.11 2024-03-04 10:24:10 -03:00
gb/gbar
gc
ge
gh
gi gitlab-ci-local: init at 4.46.1 2024-03-06 22:07:43 +09:00
gl Merge pull request from Aleksanaa/glide-media-player 2024-03-06 12:37:19 +00:00
gm/gmic
gn/gnucap
go go-critic: 0.11.1 -> 0.11.2 2024-03-05 21:21:39 +00:00
gp gpt4all: 2.7.1 -> 2.7.2 2024-03-06 13:29:28 +01:00
gr
gt
gu
gx/gxml gxml: init at 0.20.3 2024-03-03 18:50:04 +08:00
h8/h8mail
ha haredoc: init at 0.24.0 2024-03-06 11:57:55 -03:00
hd/hdrop
he
hi/hifile
hj/hjson-go
ho
ht
hu/hugo hugo: 0.123.6 -> 0.123.7 2024-03-05 10:46:01 +00:00
hy
i3
ia
ic icewm: 3.4.5 -> 3.4.6 2024-03-08 01:30:31 +00:00
id/idsk
if/ifrextractor-rs
ig
ii
im
in
io/ioq3-scion ioq3-scion: init at unstable-2024-03-03 2024-03-04 14:47:46 +00:00
ip/ipam
ir/ironbar
it/itch
ja jasper: cosmetic reword on meta 2024-03-05 07:50:10 -03:00
jd/jdt-language-server
ji
jj/jj
jn/jnr-posix
jo
js/jsoncons
ju/justbuild
ka
kc
kd/kdsingleapplication
ke Merge pull request from r-ryantm/auto-update/keepass 2024-03-07 10:45:35 +01:00
kg/kgeotag
ki
kl/klog-time-tracker
km/kmsvnc
kn/knossosnet
ko kooha: 2.2.3 -> 2.2.4 2024-03-09 08:31:50 +08:00
kp/kplex
kr/krr krr: fix version name 2024-03-07 15:36:24 +03:00
ks/kseexpr
kt
ku kubo: 0.26.0 -> 0.27.0 2024-03-04 13:12:17 +00:00
kx/kxstitch
la
lc/lcab
le lefthook: 1.6.4 -> 1.6.5 2024-03-04 21:26:51 +00:00
li Merge master into staging-next 2024-03-07 12:01:24 +00:00
ll llama-cpp: 2294 -> 2346 2024-03-05 19:34:21 +00:00
ln/lngen
lo
ls
lt/ltris
lu lubelogger: 1.2.4 -> 1.2.5 2024-03-08 01:52:58 +00:00
lw/lwgrp
lz
m2
ma Merge pull request from bcdarwin/init-margebot 2024-03-05 05:51:36 -05:00
mc
md
me Merge pull request from r-ryantm/auto-update/mev-boost 2024-03-04 08:37:14 -05:00
mf
mg/mgitstatus
mi
mk
ml/mlx42
mo Merge pull request from r-ryantm/auto-update/monophony 2024-03-07 23:04:03 -08:00
mp/mpifileutils
mq mqttui: migrate to by-name 2024-03-05 19:07:08 +04:00
ms
mu
my mystmd: 1.1.44 -> 1.1.45 2024-03-05 07:46:42 +00:00
n2/n2
na namespace-cli: 0.0.345 -> 0.0.346 2024-03-07 03:13:33 +00:00
nb/nbtscan
nc nc4nix: unstable-2023-11-06 -> 0-unstable-2024-03-01 2024-03-04 15:17:52 +01:00
ne
nf/nfft
nh nh: 3.5.2 -> 3.5.3 2024-03-05 20:02:33 +00:00
ni Merge pull request from r-ryantm/auto-update/nitter 2024-03-06 22:56:41 +01:00
nl
nm/nmap-parse
nn/nncp
no nomacs: migrate to by-name 2024-03-07 22:28:19 -03:00
np
nr
ns
nu
nv
nw Merge pull request from r-ryantm/auto-update/nwg-hello 2024-03-07 10:04:11 +01:00
oa
ob
oc
oe/oelint-adv
of/offpunk
oh/oh-my-fish
oi
on Merge pull request from massix/fix/onedriver-systemd 2024-03-04 20:40:54 +01:00
op Merge pull request from SFrijters/openttd-ttf 2024-03-07 21:41:09 +01:00
or
os
ot oterm: relax aiosqlite constraint 2024-03-07 12:44:10 +01:00
ou
ov
ow/owncloud-client
pa pan-bindings: init at unstable-2024-03-03 2024-03-04 14:47:46 +00:00
pd
pe pest: 2.33.4 -> 2.34.1 2024-03-04 23:01:47 +01:00
pf/pfft
pg
ph Merge pull request from eliandoran/dev/photocollage 2024-03-07 22:46:04 +01:00
pi pixi: 0.13.0 -> 0.15.2 2024-03-08 10:52:23 +08:00
pk/pkcrack
pl
pm
pn/pnfft
po
pp/ppsspp
pq pqiv: cleanup 2024-03-08 01:05:37 -05:00
pr Merge pull request from r-ryantm/auto-update/promptfoo 2024-03-07 10:15:00 +01:00
pt Merge pull request from Sascha8a/master 2024-03-07 22:40:56 +01:00
pu
pw
px/pxder
py Merge pull request from dotlambda/spsdk-cryptography 2024-03-05 03:44:00 +00:00
pz/pzip
qa/qadwaitadecorations
qc/qcm
qg/qgrep
qr
qs
qt/qtractor
qu
ra
rc
re renode-unstable: 1.14.0+20240226git732d357b4 -> 1.14.0+20240305gitcec51e561 2024-03-05 15:46:53 +00:00
ri
rl/rl_json rl_json: use finalAttrs 2024-03-06 12:39:08 +01:00
rm/rmg
ro Merge pull request from aikooo7/add-rose-pine-cursor 2024-03-07 22:02:40 +01:00
rp/rpcs3
rq/rqbit
rs Merge pull request from D3vil0p3r/patch-3 2024-03-03 13:27:03 -08:00
rt/rtl-sdr-osmocom
ru
rw/rwpspread
ry/ryujinx ryujinx: remove gtk dependencies 2024-03-04 23:22:11 +00:00
s3
sa
sc Merge master into staging-next 2024-03-05 00:01:58 +00:00
sd
se
sg/sgfutils
sh shopware-cli: 0.4.25 -> 0.4.28 2024-03-08 06:41:38 +00:00
si
sl
sm
sn
so sopwith: 2.3.0 -> 2.4.0 2024-03-05 05:44:22 +01:00
sp spicetify-cli: 2.33.1 -> 2.33.2 2024-03-07 07:12:10 +00:00
sq squirreldisk: add missing desktop item 2024-03-06 01:45:51 +01:00
sr
ss
st steamguard-cli: 0.12.6 -> 0.13.0 2024-03-05 02:42:11 +00:00
su Merge pull request from kugland/subtitlecomposer 2024-03-05 04:07:01 +00:00
sv
sw Merge pull request from r-ryantm/auto-update/swayimg 2024-03-07 11:00:19 +01:00
sx
sy symfony-cli: move to pkgs/by-name 2024-03-06 21:32:37 +01:00
ta tabby: 0.7.0 -> 0.8.3 2024-03-07 06:27:01 -05:00
tc/tcsh
td/tdl tdl: 0.16.0 -> 0.16.1 2024-03-04 02:00:09 +04:00
te tenki: init at 1.4.0 2024-03-06 20:20:39 +08:00
th
ti tigerbeetle: 0.14.181 -> 0.14.183 2024-03-07 18:34:50 +00:00
tk/tkdiff
tl
tm/tmuxifier
to
tp
tr treedome: 0.4 -> 0.4.2 2024-03-07 18:55:42 +07:00
tt/ttop
tu
tx/txr
ty typos-lsp: 0.1.13 -> 0.1.14 2024-03-03 05:13:40 +00:00
uc
ud
ue
ui
um/umpire
un Merge pull request from KamilaBorowska/universal-android-debloater-1.0.2 2024-03-04 08:41:33 -05:00
up
us/usql
ut ut1999: init at 469d 2024-03-04 23:27:59 +02:00
uu/uuu
uv/uv uv: 0.1.15 -> 0.1.16 2024-03-07 04:20:00 +00:00
ux/uxn
va
vc
ve
vg/vgm2x
vi VictoriaMetrics: 1.97.1 -> 1.99.0 () 2024-03-05 10:53:19 +01:00
vl/vlc
vu/vulkan-volk
wa Merge pull request from imadnyc/warp-terminal-initial-linux 2024-03-03 14:06:48 -08:00
wb/wb32-dfu-updater
we
wh
wi wit-bindgen: 0.20.0 -> 0.21.0 2024-03-05 10:07:40 +00:00
wl
wo
wp/wp-cli
ws wslu: install desktop item 2024-03-06 06:13:19 -05:00
wt/wtfis
x1/x16
xa/xarcan
xc
xd xdg-desktop-portal-shana: init at 0.3.9 2024-03-06 15:42:30 +01:00
xf/xfs-undelete
xi
xm
xo
xp/xplr
xr/xr-hardware
xs
xw/xwayland-run
ya
ye
yg/yggdrasil
yj/yj
yo
ys/ysfx
yt
yu/yunfaavatar
za Merge pull request from gador/zabbix-agent2-plugin-postgresql 2024-03-05 00:37:42 +01:00
zb/zbus-xmlgen
zc/zcfan
ze/zesarux
zi
zo/zola
zp
zs/zs
zu/zug
zw/zwave-js-server
zx
README.md

Name-based package directories

The structure of this directory maps almost directly to top-level package attributes. Add new top-level packages to Nixpkgs using this mechanism whenever possible.

Packages found in the name-based structure are automatically included, without needing to be added to all-packages.nix. However if the implicit attribute defaults need to be changed for a package, this must still be declared in all-packages.nix.

Example

The top-level package pkgs.some-package may be declared by setting up this file structure:

pkgs
└── by-name
   ├── so
   ┊  ├── some-package
      ┊  └── package.nix

Where some-package is the package name and so is the lowercased 2-letter prefix of the package name.

The package.nix may look like this:

# A function taking an attribute set as an argument
{
  # Get access to top-level attributes for use as dependencies
  lib,
  stdenv,
  libbar,

  # Make this derivation configurable using `.override { enableBar = true }`
  enableBar ? false,
}:

# The return value must be a derivation
stdenv.mkDerivation {
  # ...
  buildInputs =
    lib.optional enableBar libbar;
}

You can also split up the package definition into more files in the same directory if necessary.

Once defined, the package can be built from the Nixpkgs root directory using:

nix-build -A some-package

See the general package conventions for more information on package definitions.

Changing implicit attribute defaults

The above expression is called using these arguments by default:

{
  lib = pkgs.lib;
  stdenv = pkgs.stdenv;
  libbar = pkgs.libbar;
}

But the package might need pkgs.libbar_2 instead. While the function could be changed to take libbar_2 directly as an argument, this would change the .override interface, breaking code like .override { libbar = ...; }. So instead it is preferable to use the same generic parameter name libbar and override its value in pkgs/top-level/all-packages.nix:

libfoo = callPackage ../by-name/so/some-package/package.nix {
  libbar = libbar_2;
};

Manual migration guidelines

Most packages are still defined in all-packages.nix and the category hierarchy. Please hold off migrating your maintained packages to this directory.

  1. An automated migration for the majority of packages is being worked on. In order to save on contributor and reviewer time, packages should only be migrated manually afterwards if they couldn't be migrated automatically.

  2. Manual migrations should only be lightly encouraged if the relevant code is being worked on anyways. For example with a package update or refactoring.

  3. Manual migrations should not remove definitions from all-packages.nix with custom arguments. That is a backwards-incompatible change because it changes the .override interface. Such packages may still be moved to pkgs/by-name however, while keeping the definition in all-packages.nix. See also changing implicit attribute defaults.

Limitations

There's some limitations as to which packages can be defined using this structure:

  • Only packages defined using pkgs.callPackage. This excludes packages defined using pkgs.python3Packages.callPackage ....

    Instead:

    • Either change the package definition to work with pkgs.callPackage.
    • Or use the category hierarchy.
  • Only top-level packages. This excludes packages for other package sets like pkgs.pythonPackages.*.

    Refer to the definition and documentation of the respective package set to figure out how such packages can be declared.

Validation

CI performs certain checks on the pkgs/by-name structure. This is done using the nixpkgs-check-by-name tool.

You can locally emulate the CI check using

$ ./pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh master

See here for more info.

Recommendation for new packages with multiple versions

These checks of the pkgs/by-name structure can cause problems in combination:

  1. New top-level packages using callPackage must be defined via pkgs/by-name.
  2. Packages in pkgs/by-name cannot refer to files outside their own directory.

This means that outside pkgs/by-name, multiple already-present top-level packages can refer to some common file. If you open a PR to another instance of such a package, CI will fail check 1, but if you try to move the package to pkgs/by-name, it will fail check 2.

This is often the case for packages with multiple versions, such as

  foo_1 = callPackage ../tools/foo/1.nix { };
  foo_2 = callPackage ../tools/foo/2.nix { };

The best way to resolve this is to not use callPackage directly, such that check 1 doesn't trigger. This can be done by using inherit on a local package set:

  inherit
    ({
      foo_1 = callPackage ../tools/foo/1.nix { };
      foo_2 = callPackage ../tools/foo/2.nix { };
    })
    foo_1
    foo_2
    ;

While this may seem pointless, this can in fact help with future package set refactorings, because it establishes a clear connection between related attributes.

Further possible refactorings

This is not required, but the above solution also allows refactoring the definitions into a separate file:

  inherit (import ../tools/foo pkgs)
    foo_1 foo_2;
# pkgs/tools/foo/default.nix
pkgs: {
  foo_1 = callPackage ./1.nix { };
  foo_2 = callPackage ./2.nix { };
}

Alternatively using callPackages if callPackage isn't used underneath and you want the same .override arguments for all attributes:

  inherit (callPackages ../tools/foo { })
    foo_1 foo_2;
# pkgs/tools/foo/default.nix
{
  stdenv
}: {
  foo_1 = stdenv.mkDerivation { /* ... */ };
  foo_2 = stdenv.mkDerivation { /* ... */ };
}

Exposing the package set

This is not required, but the above solution also allows exposing the package set as an attribute:

  foo-versions = import ../tools/foo pkgs;
  # Or using callPackages
  # foo-versions = callPackages ../tools/foo { };

  inherit (foo-versions) foo_1 foo_2;