nixpkgs/pkgs/by-name
2023-12-01 15:07:52 +01:00
..
_4/_4th _4th: fix cross compilation by setting AR in makeFlags 2023-09-22 16:28:35 -03:00
_9/_9base _9base: init at unstable-2019-09-11 2023-09-29 10:43:34 +01:00
a4/a4 a4term: rename package to a4 2023-10-06 21:56:23 -03:00
aa/aarch64-esr-decoder aarch64-esr-decoder: init at 0.2.1 2023-09-21 18:41:38 -07:00
ab/aba aba: 0.7.0 -> 0.7.1 2023-11-02 23:46:54 -03:00
ac/action-validator action-validator: 0.5.3 -> 0.5.4 2023-11-25 08:12:23 +00:00
ad/adafruit-nrfutil python3Packages.adafruit-nrfutil: fix tests 2023-11-20 21:19:25 +01:00
af/afterstep afterstep: migrate to by-name 2023-09-26 12:13:10 -03:00
ai airlift: init at 0.3.0 2023-10-30 05:46:38 -06:00
al alsa-utils: fix eval 2023-11-17 00:46:24 +01:00
am/amazon-ssm-agent Merge pull request #258036 from anthonyroussel/fix-ssm-seelog 2023-11-19 18:55:57 -05:00
ao/aocl-utils aocl-utils: init at 4.1 2023-10-06 10:34:01 +02:00
ap apt: 2.7.6 -> 2.7.7 2023-11-24 15:26:43 -03:00
ar Merge staging-next into staging 2023-10-21 18:01:53 +00:00
as ast-grep: fix build with clang 12+ 2023-11-21 15:14:53 +08:00
aw/aws-azure-login aws-azure-login: use fetchYarnDeps 2023-09-30 13:39:56 -07:00
ax/axmldec axmldec: init at 1.2.0 2023-10-31 20:30:27 -03:00
ba Revert "bazecor: init at 1.3.2" 2023-11-21 15:01:37 +01:00
be beekeeper-studio: 3.6.2 -> 4.0.3, refactor 2023-11-23 00:49:16 +01:00
bi Merge pull request #259645 from otavio/bb-lsp 2023-10-11 16:46:11 +01:00
bk/bk bk: init at 0.6.0 2023-11-13 13:53:57 +01:00
bl/bluetility bluetility: init at 1.5.1 2023-11-14 21:48:23 -03:00
bm/bmake treewide: s_targetPlatform_hostPlatform_ in non-compiler packages 2023-11-17 08:07:34 +00:00
bo boogie: 3.0.5 -> 3.0.6 2023-11-22 08:51:32 -08:00
br Merge pull request #268184 from r-ryantm/auto-update/bruno 2023-11-20 16:16:35 +09:00
c2/c2fmzq c2fmzq: 0.4.8 -> 0.4.9 2023-10-27 13:45:00 +00:00
ca cargo-xwin: 0.14.8 -> 0.14.9 2023-10-31 12:20:07 +00:00
cb/cbmbasic cbmbasic: init at unstable-2022-12-18 2023-10-16 06:17:35 +02:00
cd cdk: 5.0-20221025 -> 5.0-20230201 2023-10-09 23:50:05 -03:00
ce Merge pull request #253918 from tie/centrifugo 2023-11-20 08:59:54 -05:00
ch/changelog-d changelog-d: Add shell completions 2023-11-19 13:17:23 +01:00
ci circom: init at 2.1.6 2023-10-30 16:12:01 +01:00
cl clamtk: add ShamrockLee as a maintainer 2023-11-21 20:16:26 +08:00
cm/cmake cmake: fix risc-v build failure 2023-11-22 16:10:35 -03:00
cn/cntb cntb: init at 1.4.6 2023-09-22 12:21:36 +00:00
co Merge pull request #266323 from Nyabinary/cosmic-osd 2023-11-24 08:41:56 -05:00
cp/cpu-x cpu-x: 5.0.0 -> 5.0.1 2023-11-12 01:23:54 +00:00
cr cryptor: init at 1.0.3 2023-11-09 10:58:38 +01:00
ct/ctx ctx: migrate to by-name 2023-10-05 17:53:27 -03:00
cy cyanrip: 0.9.0 -> 0.9.2 2023-11-21 20:29:23 +10:00
da/dark-mode-notify dark-mode-notify: add meta.mainProgram 2023-11-04 08:40:36 +01:00
db/dbus-cpp dbus-cpp: Fix pkg-config file 2023-10-18 23:48:22 +02:00
de Merge pull request #262336 from h7x4/init-devdash 2023-11-18 19:14:23 +01:00
di disarchive: rename from guile-disarchive, fix program 2023-10-28 18:07:35 +02:00
dj/djent djent: init at 1.0 2023-09-14 13:05:29 +02:00
dm/dmenu-bluetooth dmenu-bluetooth: init at unstable-2023-07-16 2023-09-21 18:05:46 +09:00
do doge: patch adding small doge 2023-12-01 15:07:52 +01:00
dt/dtcmp dtcmp: init at 1.1.5 2023-11-10 10:39:51 +01:00
dv/dvb-apps dvb-apps: init at 1.1.1-unstable-2014-03-21 2023-11-08 19:18:13 +01:00
dx dxvk: rely on the cross support in nixpkgs 2023-11-13 17:53:09 -05:00
dy/dyalog dyalog: init at 18.2.45405 2023-09-26 22:36:39 +02:00
ec ecc: 1.0.11 -> 1.0.12 2023-11-03 16:10:04 +00:00
ei/eiwd eiwd: init at 2.8-1 (#208844) 2023-11-03 09:26:41 +02:00
ek/eksctl eksctl: 0.163.0 -> 0.164.0 2023-11-19 03:35:38 +11:00
el/elvish elvish: refactor 2023-09-19 00:02:22 -03:00
em/emocli emocli: init at 1.0.0 2023-11-24 16:53:28 +01:00
en/engage engage: 0.1.3 -> 0.2.0 2023-09-19 20:52:12 -07:00
es/esbuild-config esbuild-config: init at 1.0.1 2023-09-10 20:12:51 -04:00
eu/eudev eudev: refactor 2023-10-09 00:46:25 -03:00
ez/eza eza: 0.16.0 -> 0.16.1 2023-11-23 04:34:56 +01:00
fa fangfrisch: init at 1.6.1 2023-11-22 03:04:20 +00:00
fc fcitx5-nord: init at unstable-2021-07-27 2023-10-26 10:16:55 +08:00
fe/feather feather: init at 2.5.2 2023-11-08 21:43:25 +01:00
fi/firewalk firewalk: init at 5.0 2023-10-20 17:08:27 +02:00
fl flip: init at 1.2 2023-10-20 08:00:10 -06:00
fm/fm-tune fm-tune: migrate to by-name 2023-10-17 15:10:39 +11:00
fo/fortune-kind fortune-kind: 0.1.8 -> 0.1.9 2023-11-16 11:20:37 +01:00
fr free42: 3.0.21 -> 3.1 2023-11-18 05:02:05 -03:00
ga gatus: init at 5.7.0 2023-11-25 01:01:44 +08:00
gb/gbar gbar: init at unstable-2023-09-21 2023-10-05 18:17:38 +08:00
gc/gcp-scanner gcp-scanner: init at 1.3.0 2023-11-20 14:53:15 +01:00
ge gerrit-queue: init at 0.0.1 (#265922) 2023-11-08 12:31:14 +01:00
gh gh-screensaver: init at 2.0.1 2023-09-29 09:23:45 +02:00
gi gitmoji-cli: 8.5.0 -> 9.0.0 2023-11-12 10:27:42 -08:00
gl/glycin-loaders glycin-loaders: 0.1.1 → 0.1.2 2023-11-21 08:42:48 +01:00
gm/gmic gmic: 3.2.6 -> 3.3.1 2023-10-09 19:01:25 -03:00
go Merge pull request #268867 from maolonglong/init-gosimports 2023-11-22 06:10:59 +00:00
gr grun: init at 0.9.3 2023-10-19 03:26:17 +03:00
gu guile-aspell: init at 0.5.0 2023-11-03 07:49:18 +08:00
ha hachimarupop: init at unstable-2022-07-11 2023-11-16 23:46:11 -03:00
he headphones-toolbox: 0.0.4 -> 0.0.5 2023-10-18 10:17:54 -04:00
hi/hifile hifile: 0.9.9.5 -> 0.9.9.6 2023-11-19 00:00:01 +01:00
ho Merge pull request #263683 from jfvillablanca/hof 2023-11-18 16:17:35 +01:00
hy hyprshot: init at 1.2.3 2023-11-19 02:00:43 +08:00
i3/i3bar-river i3bar-river: 0.1.3 -> 0.1.5 2023-11-13 06:33:58 +00:00
ic/icewm icewm: 3.4.3 -> 3.4.4 2023-11-03 10:48:27 -03:00
if/ifrextractor-rs ifrextractor-rs: init at 1.5.1 2023-09-08 16:39:00 +02:00
im impression: 2.1 -> 3.0.1 2023-11-23 13:13:38 -08:00
in inshellisense: init at 0.0.1-rc.4 2023-11-22 14:42:06 -08:00
ir/ironbar ironbar: init at 0.13.0 2023-09-09 20:48:37 +02:00
ja Merge pull request #259774 from surfaceflinger/jazz2-finalattrs 2023-11-22 16:59:46 +01:00
ji jitterentropy-rngd: init at 1.2.8 2023-10-20 10:04:11 +02:00
ju/justbuild protobuf: use new package definition only 2023-10-11 13:20:31 +00:00
ka/katriawm katriawm: fix cross compilation and minor improvement 2023-09-22 16:28:05 -03:00
kc/kconfig-frontends kconfig-frontends: update expression 2023-10-22 07:38:40 -03:00
kd/kdsingleapplication kdsingleapplication: init at 1.0.0 2023-10-28 12:07:24 +03:00
ke keedump: init at 0.1.0 2023-11-19 22:41:26 +01:00
ki/kikit kikit: init at 1.3.0 2023-11-16 21:24:04 +07:00
km/kmsvnc kmsvnc: init at 0.0.5 2023-10-19 10:03:51 -04:00
ko konbucase: init at 4.1.1 2023-10-21 07:35:34 +08:00
kt/ktfmt ktfmt: init at 0.46 2023-09-23 16:42:25 -03:00
ku/kubectl-neat kubectl-neat: init at 2.0.3 2023-10-03 16:48:56 +02:00
la lanzaboote-tool: init at 0.3.0 2023-10-28 21:49:04 +02:00
lc/lcab lcab: init at 1.0b12 2023-11-16 14:18:52 -03:00
le lefthook: migrate to by-name 2023-11-24 19:14:25 -03:00
li libpkgconf: migrate to by-name 2023-11-24 19:14:25 -03:00
ll llama-cpp: 1483 -> 1538 2023-11-19 10:25:46 +01:00
ln/lngen lngen: init at unstable-2023-10-17 2023-11-15 18:44:11 +01:00
lo/loupe loupe: 45.0 → 45.1 2023-11-21 08:42:48 +01:00
lu lunar-client: add mainProgram 2023-11-22 15:54:45 +01:00
lw/lwgrp lwgrp: init at 1.0.5 2023-11-10 10:39:47 +01:00
lx/lxd-to-incus lxd-to-incus: 0.1 -> 0.2 2023-10-27 23:21:18 -04:00
m2 m2-mesoplanet: init at 1.11.0 2023-11-02 18:30:32 -07:00
ma mariadb-connector-java: 3.2.0 -> 3.3.0 2023-11-14 15:15:18 +01:00
mc/mcuboot-imgtool mcuboot-imgtool: fix pname 2023-11-19 16:14:55 -03:00
me treewide: s_targetPlatform_hostPlatform_ in non-compiler packages 2023-11-17 08:07:34 +00:00
mf/mfoc-hardnested mfoc-hardnested: unstable-2021-08-14 -> unstable-2023-03-27 2023-09-13 23:24:14 +08:00
mi Merge pull request #261705 from gepbird/minecraftia-init 2023-10-18 21:12:49 +02:00
mk/mksh mksh: migrate to by-name 2023-09-19 00:02:22 -03:00
ml/mlx42 mlx42: init at 2.3.2 2023-10-01 12:53:05 +02:00
mo monaspace: init at 1.000 2023-11-10 14:19:01 -03:00
mp/mpifileutils mpifileutils: 0.11.1 2023-11-10 10:39:55 +01:00
ms/msolve msolve: init at 0.6.1 2023-11-10 19:23:50 +01:00
my/mystmd mystmd: 1.1.29 -> 1.1.31 2023-11-24 04:20:00 +00:00
n2/n2 n2: init at unstable-2023-10-10 2023-10-18 12:45:52 +02:00
na namespace-cli: 0.0.302 -> 0.0.307 2023-11-18 22:30:34 -05:00
ne newsraft: init at 0.21 2023-11-21 00:41:45 -03:00
nf/nfft nfft: init at 3.5.3 2023-10-03 09:18:14 +02:00
ni nilaway: init at unstable-2023-11-17 2023-11-21 14:04:19 +00:00
nl/nls nls: delete Cargo.lock 2023-10-11 22:20:32 -03:00
nn/nncp nncp: 8.9.0 -> 8.10.0 2023-11-10 11:57:39 +00:00
no nom: 2.0.2 -> 2.0.5 2023-11-17 15:31:44 +01:00
ns nsf-ordlista: init at unstable-2023-08-20 2023-11-09 09:50:05 +01:00
nu numbat: add myself as maintainer 2023-11-13 14:58:19 +01:00
nw/nwg-drawer nwg-drawer: 0.3.9 -> 0.4.1 2023-11-18 23:46:18 -03:00
oa/oauth2l oauth2l: init at 1.3.0 2023-11-09 21:07:09 +01:00
oc nixosTests.ocsinventory-agent: init 2023-11-02 14:20:46 +01:00
oe/oelint-adv oelint-adv: 3.26.1 -> 3.26.2 2023-11-02 22:40:49 +00:00
of/offpunk offpunk: move to by-name 2023-11-18 07:48:13 +01:00
oh/oh-my-fish oh-my-fish: patch to fixup permissions during installation 2023-11-25 20:11:49 -03:00
on onedrivegui: init at 1.0.3 2023-10-23 16:31:30 +00:00
op Merge pull request #157807 from scottbot95/open-fprintd 2023-11-19 18:13:32 +02:00
or/orchard orchard: 0.14.1 -> 0.14.3 2023-11-03 02:51:44 +00:00
ou/outputcheck outputcheck: init at 0.4.2 2023-09-19 22:23:55 +08:00
ow/owncloud-client owncloud-client: 4.2.0 -> 5.0.0 2023-10-28 12:07:42 +03:00
pa padre: init at 2.1.0 2023-11-20 10:31:53 +01:00
pd pdk: init at 3.0.0 2023-11-21 17:34:16 +01:00
pe pekwm: migrate to by-name 2023-09-26 12:13:10 -03:00
pg/pgmoneta pgmoneta: 0.7.0 -> 0.7.1 2023-10-23 12:57:35 +00:00
ph phel: add postCheckInstall step 2023-11-01 12:13:04 +01:00
pi pioasm: init at 1.5.1 2023-11-08 17:11:38 +11:00
pl/platformsh platformsh: 3.79.2 -> 4.10.0 2023-09-17 15:07:02 +02:00
po poethepoet: 0.24.2 -> 0.24.4 2023-11-18 17:30:18 -05:00
pp/ppsspp ppsspp: 1.16.5 -> 1.16.6 2023-10-13 12:31:01 -03:00
pr presenterm: 0.2.1 -> 0.3.0 2023-11-24 20:07:26 +01:00
pt/pterm pterm: mark as broken on Darwin 2023-11-13 04:43:58 +00:00
px/pxder pxder: use fetchYarnDeps 2023-09-26 10:08:41 -07:00
py pyprland: 1.5.3 -> 1.6.0 2023-11-17 20:40:15 +03:00
pz/pzip pzip: init at 0.2.0 2023-10-24 08:18:00 +02:00
qr/qrtool qrtool: init at 0.8.4 2023-11-08 09:05:22 -08:00
qu quicktype: 23.0.75 -> 23.0.78 2023-11-14 04:20:00 +00:00
ra raft-cowsql: 0.17.7 -> 0.18.2 2023-11-12 11:21:39 +00:00
rc/rc rc: migrate to by-name 2023-09-19 00:02:22 -03:00
re Merge pull request #258555 from rexxDigital/reactphysics3d 2023-10-19 23:24:26 +02:00
ri Merge pull request #260445 from adamcstephens/river-bnf/init 2023-10-23 06:38:26 -05:00
ro rockyou: iniat at unstable-2023-05-12 2023-10-29 18:52:20 +01:00
rp/rpcs3 rpcs3: 0.0.28-15409-fd6829f75 -> 0.0.29-15726-ebf48800e 2023-11-23 02:30:37 +10:00
rq/rqbit rqbit: 3.1.0 -> 3.2.0 2023-11-21 04:20:00 +00:00
rs rst2html5: migrate to by-name 2023-10-11 23:42:04 -03:00
rt/rtl-sdr-osmocom osmo-rtl-sdr: init at 2.0.1 2023-11-15 04:44:50 +00:00
ru rustplayer: init at unstable-2022-12-29 2023-10-17 10:24:30 +08:00
sa satty: init at 0.7.0 2023-11-24 09:09:46 +01:00
sc Remove unused dists binary post install 2023-10-25 11:09:31 +02:00
sd/sdcc sdcc: refactor 2023-11-11 16:48:40 -03:00
se Merge pull request #264348 from 999eagle/update/searxng 2023-11-20 10:48:40 +01:00
sh shopware-cli: 0.3.6 -> 0.3.12 2023-11-13 21:10:00 +00:00
si Merge pull request #266336 from DamienCassou/signaturepdf 2023-11-18 08:20:38 +01:00
sl slurm-nm: cleanup 2023-09-28 22:44:07 +02:00
sm/smallwm smallwm: migrate to by-name 2023-09-26 12:13:10 -03:00
so Merge pull request #258963 from mrtnvgr/arachno 2023-11-19 01:11:52 +02:00
sp treewide: make 'gpuBackend' use 'config.(cuda|rocm)Support' 2023-11-14 08:44:42 -06:00
ss sshx: init at unstable-2023-11-04 2023-11-22 09:18:51 +01:00
st stats: init at 2.9.11 2023-11-13 14:41:46 +11:00
su supersonic: 0.7.0 -> 0.8.0 2023-11-16 21:31:49 +10:00
sv/svix-server svix-server: init at 1.13.0 2023-10-21 22:40:49 -04:00
sw Merge pull request #265755 from rafaelrc7/add-sway-audio-idle-inhibit 2023-11-18 23:27:53 +02:00
sx/sxhkd sxhkd: refactor 2023-11-06 07:20:49 -03:00
sy systemd: migrate to by-name 2023-11-25 20:11:32 -03:00
ta tailwindcss-language-server: init at 0.0.14 2023-11-02 09:59:42 +00:00
tc/tcsh tcsh: migrate to by-name 2023-09-10 01:35:11 +00:00
te Merge pull request #267852 from 365tuwe/add-tera-cli 2023-11-22 10:34:12 +01:00
th thud: add passthru.updateScript 2023-10-31 11:18:31 -04:00
ti tinycompress: migrate to by-name 2023-11-14 20:20:57 -03:00
tk/tkdiff tkdiff: update maintainers 2023-11-11 13:07:28 -08:00
tl/tlrc tlrc: init at 1.7.1 2023-11-14 18:19:32 +01:00
tm/tmuxifier tmuxifier: init at 0.13.0 2023-09-10 18:43:27 +03:00
tp tplay: init at 0.4.5 (#266300) 2023-11-13 18:57:48 +04:00
tr trealla: 2.29.36 -> 2.30.7 2023-11-15 13:49:42 -03:00
tu Merge pull request #264858 from EdenEast/tuxmux-update 2023-11-04 12:10:35 +09:00
tx/txr txr: 291 -> 292 2023-11-22 09:26:50 -03:00
ty/typst-preview typst-preview: 0.9.0 -> 0.9.1 2023-11-18 17:52:30 +01:00
uc uclibc-ng: refactor 2023-10-11 23:42:04 -03:00
ud Merge pull request #259844 from haruki7049/udev-gothic-nf 2023-10-10 19:04:32 +02:00
ui uiua: 0.3.0 -> 0.3.1 2023-11-21 13:19:09 +01:00
un Merge pull request #264716 from Anomalocaridid/unimatrix 2023-11-21 22:47:19 +01:00
up uplosi: 0.1.1 -> 0.1.2 2023-10-13 20:36:34 +02:00
us/usql usql: fix build with clang 12+ 2023-11-25 00:31:53 +01:00
ut/ut ut: init at 2.0.0 2023-11-20 21:54:58 +00:00
uu/uuu uuu: 1.5.125 -> 1.5.141 2023-11-12 21:09:50 +00:00
ux/uxn uxn: unstable-2023-10-23 -> unstable-2023-11-12 2023-11-16 19:12:07 +00:00
va/valijson valijson: init at 1.0.1 2023-10-24 23:30:44 +03:00
ve vesktop: add cacert to pnpmDeps derivation 2023-11-20 17:46:06 +01:00
vi/virtio-win virtio-win: rename from win-virtio 2023-10-18 00:27:06 +02:00
wa warp-terminal: init at 0.2023.11.07.08.02.stable_00 2023-11-13 16:02:35 +11:00
wb/wb32-dfu-updater wb32-dfu-updater: apply suggestions from code review 2023-10-18 17:10:13 +02:00
we/websecprobe websecprobe: init at 0.0.10 2023-11-07 23:23:06 +01:00
wh whistle: 2.9.58 -> 2.9.59 2023-11-10 04:20:00 +00:00
wi wio: init at unstable-2023-05-28 2023-11-23 12:40:23 -03:00
wo wordlists: refactor 2023-11-17 17:58:09 +01:00
ws/wslay swlay: actually enable tests 2023-10-28 18:16:59 +02:00
wt/wtfis wtfis: 0.6.1 -> 0.7.1 2023-11-04 22:18:32 -03:00
xm/xmldiff xmldiff: 2.4 -> 2.6.3 2023-10-04 21:56:31 -03:00
xo xosview2: 2.3.2 -> 2.3.3 2023-11-06 07:23:09 -03:00
xs xscreensaver: add suid wrapper patch 2023-11-24 08:53:00 -03:00
ye/yeahwm yeahwm: migrate to by-name 2023-09-26 12:13:10 -03:00
yg/yggdrasil yggdrasil: 0.5.1 -> 0.5.2 2023-11-21 17:11:29 +02:00
yt/ytui-music ytui-music: init at 2.0.0-rc1 2023-09-23 00:54:46 +10:00
yu/yunfaavatar yunfaavatar: init at 0.2.0 2023-10-28 13:39:52 +03:00
zc/zcfan zcfan: init at 1.2.1 2023-09-08 19:43:02 +02:00
ze/zesarux zesarux: 10.0 -> unstable-2023-10-31 2023-11-04 22:18:10 -03:00
zi/zitadel zitadel: 2.37.2 -> 2.40.3 2023-11-04 13:23:56 +11:00
zp zpaqfranz: 58.10 -> 58.11 2023-11-11 13:47:44 -03:00
zw/zwave-js-server zwave-js: module init, zwave-js-server: init at 1.33.0 2023-11-02 08:21:09 +00:00
zx zxtune: init at r5055 2023-11-22 13:57:24 -08:00
README.md by-name: make the way of adding packages clearer 2023-10-09 19:12:29 +02:00

Name-based package directories

The structure of this directory maps almost directly to top-level package attributes. This is the recommended way to add new top-level packages to Nixpkgs when possible.

Packages found in the named-based structure do not need to be explicitly added to the top-level/all-packages.nix file unless they require overriding the default value of an implicit attribute (see below).

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 use the category hierarchy for such attributes.

  • 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. The version of this tool used is the one that corresponds to the NixOS channel of the PR base branch. See here for details.

The tool can be run locally using

nix-build -A tests.nixpkgs-check-by-name
result/bin/nixpkgs-check-by-name .