pkgs/README.md

   1 # Contributing to Nixpkgs packages
   2
   3 This document is for people wanting to contribute specifically to the package collection in Nixpkgs.
   4 See the [CONTRIBUTING.md](../CONTRIBUTING.md) document for more general information.
   5
   6 ## Overview
   7
   8 - [`top-level`](./top-level): Entrypoints, package set aggregations
   9   - [`impure.nix`](./top-level/impure.nix), [`default.nix`](./top-level/default.nix), [`config.nix`](./top-level/config.nix): Definitions for the evaluation entry point of `import <nixpkgs>`
  10   - [`stage.nix`](./top-level/stage.nix), [`all-packages.nix`](./top-level/all-packages.nix), [`by-name-overlay.nix`](./top-level/by-name-overlay.nix), [`splice.nix`](./top-level/splice.nix): Definitions for the top-level attribute set made available through `import <nixpkgs> {…}`
  11   - `*-packages.nix`, [`linux-kernels.nix`](./top-level/linux-kernels.nix), [`unixtools.nix`](./top-level/unixtools.nix): Aggregations of nested package sets defined in `development`
  12   - [`aliases.nix`](./top-level/aliases.nix), [`python-aliases.nix`](./top-level/python-aliases.nix): Aliases for package definitions that have been renamed or removed
  13   - `release*.nix`, [`make-tarball.nix`](./top-level/make-tarball.nix), [`packages-config.nix`](./top-level/packages-config.nix), [`metrics.nix`](./top-level/metrics.nix), [`nixpkgs-basic-release-checks.nix`](./top-level/nixpkgs-basic-release-checks.nix): Entry-points and utilities used by Hydra for continuous integration
  14 - [`development`](./development)
  15   - `*-modules`, `*-packages`, `*-pkgs`: Package definitions for nested package sets
  16   - All other directories loosely categorise top-level package definitions, see [category hierarchy][categories]
  17 - [`build-support`](./build-support): [Builders](https://nixos.org/manual/nixpkgs/stable/#part-builders)
  18   - `fetch*`: [Fetchers](https://nixos.org/manual/nixpkgs/stable/#chap-pkgs-fetchers)
  19 - [`stdenv`](./stdenv): [Standard environment](https://nixos.org/manual/nixpkgs/stable/#part-stdenv)
  20 - [`pkgs-lib`](./pkgs-lib): Definitions for utilities that need packages but are not needed for packages
  21 - [`test`](./test): Tests not directly associated with any specific packages
  22 - [`by-name`](./by-name): Top-level packages organised by name ([docs](./by-name/README.md))
  23 - All other directories loosely categorise top-level packages definitions, see [category hierarchy][categories]
  24
  25 ## Quick Start to Adding a Package
  26
  27 We welcome new contributors of new packages to Nixpkgs, arguably the greatest software database known. However, each new package comes with a cost for the maintainers, Continuous Integration, caching servers and users downloading Nixpkgs.
  28
  29 Before adding a new package, please consider the following questions:
  30
  31 * Is the package ready for general use? We don't want to include projects that are too immature or are going to be abandoned immediately. In case of doubt, check with upstream.
  32 * Does the project have a clear license statement? Remember that software is unfree by default (all rights reserved), and merely providing access to the source code does not imply its redistribution. In case of doubt, ask upstream.
  33 * How realistic is it that it will be used by other people? It's good that nixpkgs caters to various niches, but if it's a niche of 5 people it's probably too small.
  34 * Are you willing to maintain the package? You should care enough about the package to be willing to keep it up and running for at least one complete Nixpkgs' release life-cycle.
  35   * In case you are not able to maintain the package you wrote, you can seek someone to fill that role, effectively adopting the package.
  36
  37 If any of these questions' answer is no, then you should probably not add the package.
  38
  39 This is section describes a general framework of understanding and exceptions might apply.
  40
  41 Luckily it's pretty easy to maintain your own package set with Nix, which can then be added to the [Nix User Repository](https://github.com/nix-community/nur) project.
  42
  43 ---
  44
  45 Now that this is out of the way. To add a package to Nixpkgs:
  46
  47 1. Checkout the Nixpkgs source tree:
  48
  49    ```ShellSession
  50    $ git clone https://github.com/NixOS/nixpkgs
  51    $ cd nixpkgs
  52    ```
  53
  54 2. Create a package directory `pkgs/by-name/so/some-package` where `some-package` is the package name and `so` is the lowercased 2-letter prefix of the package name:
  55
  56    ```ShellSession
  57    $ mkdir -p pkgs/by-name/so/some-package
  58    ```
  59
  60    For more detailed information, see [here](./by-name/README.md).
  61
  62 3. Create a `package.nix` file in the package directory, containing a Nix expression — a piece of code that describes how to build the package. In this case, it should be a _function_ that is called with the package dependencies as arguments, and returns a build of the package in the Nix store.
  63
  64    ```ShellSession
  65    $ emacs pkgs/by-name/so/some-package/package.nix
  66    $ git add pkgs/by-name/so/some-package/package.nix
  67    ```
  68
  69    If the package is written in a language other than C, you should use [the corresponding language framework](https://nixos.org/manual/nixpkgs/stable/#chap-language-support).
  70
  71    You can have a look at the existing Nix expressions under `pkgs/` to see how it’s done, some of which are also using the [category hierarchy](#category-hierarchy).
  72    Here are some good ones:
  73
  74    - GNU Hello: [`pkgs/by-name/he/hello/package.nix`](./by-name/he/hello/package.nix). Trivial package, which specifies some `meta` attributes which is good practice.
  75
  76    - GNU cpio: [`pkgs/tools/archivers/cpio/default.nix`](tools/archivers/cpio/default.nix). Also a simple package. The generic builder in `stdenv` does everything for you. It has no dependencies beyond `stdenv`.
  77
  78    - GNU Multiple Precision arithmetic library (GMP): [`pkgs/development/libraries/gmp/5.1.x.nix`](development/libraries/gmp/5.1.x.nix). Also done by the generic builder, but has a dependency on `m4`.
  79
  80    - Pan, a GTK-based newsreader: [`pkgs/applications/networking/newsreaders/pan/default.nix`](applications/networking/newsreaders/pan/default.nix). Has an optional dependency on `gtkspell`, which is only built if `spellCheck` is `true`.
  81
  82    - Apache HTTPD: [`pkgs/servers/http/apache-httpd/2.4.nix`](servers/http/apache-httpd/2.4.nix). A bunch of optional features, variable substitutions in the configure flags, a post-install hook, and miscellaneous hackery.
  83
  84    - buildMozillaMach: [`pkgs/applications/networking/browser/firefox/common.nix`](applications/networking/browsers/firefox/common.nix). A reusable build function for Firefox, Thunderbird and Librewolf.
  85
  86    - JDiskReport, a Java utility: [`pkgs/tools/misc/jdiskreport/default.nix`](tools/misc/jdiskreport/default.nix). Nixpkgs doesn’t have a decent `stdenv` for Java yet so this is pretty ad-hoc.
  87
  88    - XML::Simple, a Perl module: [`pkgs/top-level/perl-packages.nix`](top-level/perl-packages.nix) (search for the `XMLSimple` attribute). Most Perl modules are so simple to build that they are defined directly in `perl-packages.nix`; no need to make a separate file for them.
  89
  90    - Adobe Reader: [`pkgs/applications/misc/adobe-reader/default.nix`](applications/misc/adobe-reader/default.nix). Shows how binary-only packages can be supported. In particular the [builder](applications/misc/adobe-reader/builder.sh) uses `patchelf` to set the RUNPATH and ELF interpreter of the executables so that the right libraries are found at runtime.
  91
  92    Some notes:
  93
  94    - Add yourself as the maintainer of the package.
  95
  96    - All other [`meta`](https://nixos.org/manual/nixpkgs/stable/#chap-meta) attributes are optional, but it’s still a good idea to provide at least the `description`, `homepage` and [`license`](https://nixos.org/manual/nixpkgs/stable/#sec-meta-license).
  97
  98    - The exact syntax and semantics of the Nix expression language, including the built-in functions, are [Nix language reference](https://nixos.org/manual/nix/stable/language/).
  99
 100 5. To test whether the package builds, run the following command from the root of the nixpkgs source tree:
 101
 102    ```ShellSession
 103    $ nix-build -A some-package
 104    ```
 105
 106    where `some-package` should be the package name. You may want to add the flag `-K` to keep the temporary build directory in case something fails. If the build succeeds, a symlink `./result` to the package in the Nix store is created.
 107
 108 6. If you want to install the package into your profile (optional), do
 109
 110    ```ShellSession
 111    $ nix-env -f . -iA libfoo
 112    ```
 113
 114 7. Optionally commit the new package and open a pull request [to nixpkgs](https://github.com/NixOS/nixpkgs/pulls), or use [the Patches category](https://discourse.nixos.org/t/about-the-patches-category/477) on Discourse for sending a patch without a GitHub account.
 115
 116 ## Commit conventions
 117
 118 - Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole.
 119
 120 - Format the commit messages in the following way:
 121
 122   ```
 123   (pkg-name): (from -> to | init at version | refactor | etc)
 124
 125   (Motivation for change. Link to release notes. Additional information.)
 126   ```
 127
 128   Examples:
 129
 130   * nginx: init at 2.0.1
 131   * firefox: 54.0.1 -> 55.0
 132
 133     https://www.mozilla.org/en-US/firefox/55.0/releasenotes/
 134
 135 ## Category Hierarchy
 136 [categories]: #category-hierarchy
 137
 138 Most top-level packages are organised in a loosely-categorised directory hierarchy in this directory.
 139 See the [overview](#overview) for which directories are part of this.
 140
 141 This category hierarchy is partially deprecated and will be migrated away over time.
 142 The new `pkgs/by-name` directory ([docs](./by-name/README.md)) should be preferred instead.
 143 The category hierarchy may still be used for packages that should be imported using an alternate `callPackage`, such as `python3Packages.callPackage` or `libsForQt5.callPackage`.
 144
 145 If that is the case for a new package, here are some rules for picking the right category.
 146 Many packages fall under several categories; what matters is the _primary_ purpose of a package.
 147 For example, the `libxml2` package builds both a library and some tools; but it’s a library foremost, so it goes under `pkgs/development/libraries`.
 148
 149 <details>
 150 <summary>Categories</summary>
 151
 152 **If it’s used to support _software development_:**
 153
 154 - **If it’s a _library_ used by other packages:**
 155
 156   - `development/libraries` (e.g. `libxml2`)
 157
 158 - **If it’s a _compiler_:**
 159
 160   - `development/compilers` (e.g. `gcc`)
 161
 162 - **If it’s an _interpreter_:**
 163
 164   - `development/interpreters` (e.g. `guile`)
 165
 166 - **If it’s a (set of) development _tool(s)_:**
 167
 168   - **If it’s a _parser generator_ (including lexers):**
 169
 170     - `development/tools/parsing` (e.g. `bison`, `flex`)
 171
 172   - **If it’s a _build manager_:**
 173
 174     - `development/tools/build-managers` (e.g. `gnumake`)
 175
 176   - **If it’s a _language server_:**
 177
 178     - `development/tools/language-servers` (e.g. `ccls` or `nil`)
 179
 180   - **Else:**
 181
 182     - `development/tools/misc` (e.g. `binutils`)
 183
 184 - **Else:**
 185
 186   - `development/misc`
 187
 188 **If it’s a (set of) _tool(s)_:**
 189
 190 (A tool is a relatively small program, especially one intended to be used non-interactively.)
 191
 192 - **If it’s for _networking_:**
 193
 194   - `tools/networking` (e.g. `wget`)
 195
 196 - **If it’s for _text processing_:**
 197
 198   - `tools/text` (e.g. `diffutils`)
 199
 200 - **If it’s a _system utility_, i.e., something related or essential to the operation of a system:**
 201
 202   - `tools/system` (e.g. `cron`)
 203
 204 - **If it’s an _archiver_ (which may include a compression function):**
 205
 206   - `tools/archivers` (e.g. `zip`, `tar`)
 207
 208 - **If it’s a _compression_ program:**
 209
 210   - `tools/compression` (e.g. `gzip`, `bzip2`)
 211
 212 - **If it’s a _security_-related program:**
 213
 214   - `tools/security` (e.g. `nmap`, `gnupg`)
 215
 216 - **Else:**
 217
 218   - `tools/misc`
 219
 220 **If it’s a _shell_:**
 221
 222 - `shells` (e.g. `bash`)
 223
 224 **If it’s a _server_:**
 225
 226 - **If it’s a web server:**
 227
 228   - `servers/http` (e.g. `apache-httpd`)
 229
 230 - **If it’s an implementation of the X Windowing System:**
 231
 232   - `servers/x11` (e.g. `xorg` — this includes the client libraries and programs)
 233
 234 - **Else:**
 235
 236   - `servers/misc`
 237
 238 **If it’s a _desktop environment_:**
 239
 240 - `desktops` (e.g. `kde`, `gnome`, `enlightenment`)
 241
 242 **If it’s a _window manager_:**
 243
 244 - `applications/window-managers` (e.g. `awesome`, `stumpwm`)
 245
 246 **If it’s an _application_:**
 247
 248 A (typically large) program with a distinct user interface, primarily used interactively.
 249
 250 - **If it’s a _version management system_:**
 251
 252   - `applications/version-management` (e.g. `subversion`)
 253
 254 - **If it’s a _terminal emulator_:**
 255
 256   - `applications/terminal-emulators` (e.g. `alacritty` or `rxvt` or `termite`)
 257
 258 - **If it’s a _file manager_:**
 259
 260   - `applications/file-managers` (e.g. `mc` or `ranger` or `pcmanfm`)
 261
 262 - **If it’s for _video playback / editing_:**
 263
 264   - `applications/video` (e.g. `vlc`)
 265
 266 - **If it’s for _graphics viewing / editing_:**
 267
 268   - `applications/graphics` (e.g. `gimp`)
 269
 270 - **If it’s for _networking_:**
 271
 272   - **If it’s a _mailreader_:**
 273
 274     - `applications/networking/mailreaders` (e.g. `thunderbird`)
 275
 276   - **If it’s a _newsreader_:**
 277
 278     - `applications/networking/newsreaders` (e.g. `pan`)
 279
 280   - **If it’s a _web browser_:**
 281
 282     - `applications/networking/browsers` (e.g. `firefox`)
 283
 284   - **Else:**
 285
 286     - `applications/networking/misc`
 287
 288 - **Else:**
 289
 290   - `applications/misc`
 291
 292 **If it’s _data_ (i.e., does not have a straight-forward executable semantics):**
 293
 294 - **If it’s a _font_:**
 295
 296   - `data/fonts`
 297
 298 - **If it’s an _icon theme_:**
 299
 300   - `data/icons`
 301
 302 - **If it’s related to _SGML/XML processing_:**
 303
 304   - **If it’s an _XML DTD_:**
 305
 306     - `data/sgml+xml/schemas/xml-dtd` (e.g. `docbook`)
 307
 308   - **If it’s an _XSLT stylesheet_:**
 309
 310     (Okay, these are executable...)
 311
 312     - `data/sgml+xml/stylesheets/xslt` (e.g. `docbook-xsl`)
 313
 314 - **If it’s a _theme_ for a _desktop environment_, a _window manager_ or a _display manager_:**
 315
 316   - `data/themes`
 317
 318 **If it’s a _game_:**
 319
 320 - `games`
 321
 322 **Else:**
 323
 324 - `misc`
 325
 326 </details>
 327
 328 # Conventions
 329
 330 ## Package naming
 331
 332 The key words _must_, _must not_, _required_, _shall_, _shall not_, _should_, _should not_, _recommended_, _may_, and _optional_ in this section are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). Only _emphasized_ words are to be interpreted in this way.
 333
 334 In Nixpkgs, there are generally three different names associated with a package:
 335
 336 - The `pname` attribute of the derivation. This is what most users see, in particular when using `nix-env`.
 337
 338 - The variable name used for the instantiated package in `all-packages.nix`, and when passing it as a dependency to other functions. Typically this is called the _package attribute name_. This is what Nix expression authors see. It can also be used when installing using `nix-env -iA`.
 339
 340 - The filename for (the directory containing) the Nix expression.
 341
 342 Most of the time, these are the same. For instance, the package `e2fsprogs` has a `pname` attribute `"e2fsprogs"`, is bound to the variable name `e2fsprogs` in `all-packages.nix`, and the Nix expression is in `pkgs/os-specific/linux/e2fsprogs/default.nix`.
 343
 344 There are a few naming guidelines:
 345
 346 - The `pname` attribute _should_ be identical to the upstream package name.
 347
 348 - The `pname` and the `version` attribute _must not_ contain uppercase letters — e.g., `"mplayer"` instead of `"MPlayer"`.
 349
 350 - The `version` attribute _must_ start with a digit e.g., `"0.3.1rc2"`.
 351
 352 - If a package is a commit from a repository without a version assigned, then the `version` attribute _should_ be the latest upstream version preceding that commit, followed by `-unstable-` and the date of the (fetched) commit. The date _must_ be in `"YYYY-MM-DD"` format.
 353
 354 Example: Given a project had its latest releases `2.2` in November 2021, and `3.0` in January 2022, a commit authored on March 15, 2022 for an upcoming bugfix release `2.2.1` would have `version = "2.2-unstable-2022-03-15"`.
 355
 356 - If a project has no suitable preceding releases - e.g., no versions at all, or an incompatible versioning / tagging schema - then the latest upstream version in the above schema should be `0`.
 357
 358 Example: Given a project that has no tags / released versions at all, or applies versionless tags like `latest` or `YYYY-MM-DD-Build`, a commit authored on March 15, 2022 would have `version = "0-unstable-2022-03-15"`.
 359
 360 - Dashes in the package `pname` _should_ be preserved in new variable names, rather than converted to underscores or camel cased — e.g., `http-parser` instead of `http_parser` or `httpParser`. The hyphenated style is preferred in all three package names.
 361
 362 - If there are multiple versions of a package, this _should_ be reflected in the variable names in `all-packages.nix`, e.g. `json-c_0_9` and `json-c_0_11`. If there is an obvious “default” version, make an attribute like `json-c = json-c_0_9;`. See also [versioning][versioning].
 363
 364 ## Versioning
 365 [versioning]: #versioning
 366
 367 Because every version of a package in Nixpkgs creates a potential maintenance burden, old versions of a package should not be kept unless there is a good reason to do so. For instance, Nixpkgs contains several versions of GCC because other packages don’t build with the latest version of GCC. Other examples are having both the latest stable and latest pre-release version of a package, or to keep several major releases of an application that differ significantly in functionality.
 368
 369 If there is only one version of a package, its Nix expression should be named `e2fsprogs/default.nix`. If there are multiple versions, this should be reflected in the filename, e.g. `e2fsprogs/1.41.8.nix` and `e2fsprogs/1.41.9.nix`. The version in the filename should leave out unnecessary detail. For instance, if we keep the latest Firefox 2.0.x and 3.5.x versions in Nixpkgs, they should be named `firefox/2.0.nix` and `firefox/3.5.nix`, respectively (which, at a given point, might contain versions `2.0.0.20` and `3.5.4`). If a version requires many auxiliary files, you can use a subdirectory for each version, e.g. `firefox/2.0/default.nix` and `firefox/3.5/default.nix`.
 370
 371 All versions of a package _must_ be included in `all-packages.nix` to make sure that they evaluate correctly.
 372
 373 ## Meta attributes
 374
 375 * `meta.description` must:
 376   * Be short, just one sentence.
 377   * Be capitalized.
 378   * Not start with the definite or an indefinite article.
 379   * Not start with the package name.
 380     * More generally, it should not refer to the package name.
 381   * Not end with a period (or any punctuation for that matter).
 382   * Provide factual information.
 383     * Avoid subjective language.
 384 * `meta.license` must be set and match the upstream license.
 385   * If there is no upstream license, `meta.license` should default to `lib.licenses.unfree`.
 386   * If in doubt, try to contact the upstream developers for clarification.
 387 * `meta.mainProgram` must be set to the name of the executable which facilitates the primary function or purpose of the package, if there is such an executable in `$bin/bin/` (or `$out/bin/`, if there is no `"bin"` output).
 388   * Packages that only have a single executable in the applicable directory above should set `meta.mainProgram`. For example, the package `ripgrep` only has a single executable `rg` under `$out/bin/`, so `ripgrep.meta.mainProgram` is set to `"rg"`.
 389   * Packages like `polkit_gnome` that have no executables in the applicable directory should not set `meta.mainProgram`.
 390   * Packages like `e2fsprogs` that have multiple executables, none of which can be considered the main program, should not set `meta.mainProgram`.
 391   * Packages which are not primarily used for a single executable do not need to set `meta.mainProgram`.
 392   * Always prefer using a hardcoded string (don't use `pname`, for example).
 393   * When in doubt, ask for reviewer input.
 394 * `meta.maintainers` must be set for new packages.
 395
 396 See the Nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes).
 397
 398 ## Import From Derivation
 399
 400 [Import From Derivation](https://nixos.org/manual/nix/unstable/language/import-from-derivation) (IFD) is disallowed in Nixpkgs for performance reasons:
 401 [Hydra](https://github.com/NixOS/hydra) evaluates the entire package set, and sequential builds during evaluation would increase evaluation times to become impractical.
 402
 403 Import From Derivation can be worked around in some cases by committing generated intermediate files to version control and reading those instead.
 404
 405 ## Sources
 406
 407 Always fetch source files using [Nixpkgs fetchers](https://nixos.org/manual/nixpkgs/unstable/#chap-pkgs-fetchers).
 408 Use reproducible sources with a high degree of availability.
 409 Prefer protocols that support proxies.
 410
 411 A list of schemes for `mirror://` URLs can be found in [`pkgs/build-support/fetchurl/mirrors.nix`](build-support/fetchurl/mirrors.nix), and is supported by [`fetchurl`](https://nixos.org/manual/nixpkgs/unstable/#fetchurl).
 412 Other fetchers which end up relying on `fetchurl` may also support mirroring.
 413
 414 The preferred source hash type is `sha256`.
 415
 416 Examples going from bad to best practices:
 417
 418 - Bad: Uses `git://` which won't be proxied.
 419
 420   ```nix
 421   {
 422     src = fetchgit {
 423       url = "git://github.com/NixOS/nix.git";
 424       rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
 425       hash = "sha256-7D4m+saJjbSFP5hOwpQq2FGR2rr+psQMTcyb1ZvtXsQ=";
 426     };
 427   }
 428   ```
 429
 430 - Better: This is ok, but an archive fetch will still be faster.
 431
 432   ```nix
 433   {
 434     src = fetchgit {
 435       url = "https://github.com/NixOS/nix.git";
 436       rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
 437       hash = "sha256-7D4m+saJjbSFP5hOwpQq2FGR2rr+psQMTcyb1ZvtXsQ=";
 438     };
 439   }
 440   ```
 441
 442 - Best: Fetches a snapshot archive for the given revision.
 443
 444   ```nix
 445   {
 446     src = fetchFromGitHub {
 447       owner = "NixOS";
 448       repo = "nix";
 449       rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
 450       hash = "sha256-7D4m+saJjbSFP5hOwpQq2FGR2rr+psQMTcyb1ZvtXsQ=";
 451     };
 452   }
 453   ```
 454
 455 > [!Note]
 456 > When fetching from GitHub, always reference revisions by their full commit hash.
 457 > GitHub shares commit hashes among all forks and returns `404 Not Found` when a short commit hash is ambiguous.
 458 > It already happened in Nixpkgs for short, 6-character commit hashes.
 459 >
 460 > Pushing large amounts of auto generated commits into forks is a practical vector for a denial-of-service attack, and was already [demonstrated against GitHub Actions Beta](https://blog.teddykatz.com/2019/11/12/github-actions-dos.html).
 461
 462 ## Patches
 463
 464 Sometimes, changes are needed to the source to allow building a derivation in nixpkgs, or to get earlier access to an upstream fix or improvement.
 465 When using the `patches` parameter to `mkDerivation`, make sure the patch name clearly describes the reason for the patch, or add a comment.
 466
 467 Patches already merged upstream or published elsewhere should be retrieved using `fetchpatch`.
 468
 469 ```nix
 470 {
 471   patches = [
 472     (fetchpatch {
 473       name = "fix-check-for-using-shared-freetype-lib.patch";
 474       url = "http://git.ghostscript.com/?p=ghostpdl.git;a=patch;h=8f5d285";
 475       hash = "sha256-uRcxaCjd+WAuGrXOmGfFeu79cUILwkRdBu48mwcBE7g=";
 476     })
 477   ];
 478 }
 479 ```
 480
 481 Otherwise, you can add a `.patch` file to the `nixpkgs` repository.
 482 In the interest of keeping our maintenance burden and the size of nixpkgs to a minimum, only do this for patches that are unique to `nixpkgs` or that have been proposed upstream but are not merged yet, cannot be easily fetched or have a high chance to disappear in the future due to unstable or unreliable URLs.
 483 The latter avoids link rot when the upstream abandons, squashes or rebases their change, in which case the commit may get garbage-collected.
 484
 485 If a patch is available online but does not cleanly apply, it can be modified in some fixed ways by using additional optional arguments for `fetchpatch`. Check [the `fetchpatch` reference](https://nixos.org/manual/nixpkgs/unstable/#fetchpatch) for details.
 486
 487 ```nix
 488 {
 489   patches = [ ./0001-changes.patch ];
 490 }
 491 ```
 492
 493 If you do need to do create this sort of patch file, one way to do so is with git:
 494
 495 1. Move to the root directory of the source code you're patching.
 496
 497     ```ShellSession
 498     $ cd the/program/source
 499     ```
 500
 501 2. If a git repository is not already present, create one and stage all of the source files.
 502
 503     ```ShellSession
 504     $ git init
 505     $ git add .
 506     ```
 507
 508 3. Edit some files to make whatever changes need to be included in the patch.
 509
 510 4. Use git to create a diff, and pipe the output to a patch file:
 511
 512     ```ShellSession
 513     $ git diff -a > nixpkgs/pkgs/the/package/0001-changes.patch
 514     ```
 515
 516 ## Deprecating/removing packages
 517
 518 There is currently no policy when to remove a package.
 519
 520 Before removing a package, one should try to find a new maintainer or fix smaller issues first.
 521
 522 ### Steps to remove a package from Nixpkgs
 523
 524 We use jbidwatcher as an example for a discontinued project here.
 525
 526 1. Have Nixpkgs checked out locally and up to date.
 527 1. Create a new branch for your change, e.g. `git checkout -b jbidwatcher`
 528 1. Remove the actual package including its directory, e.g. `git rm -rf pkgs/applications/misc/jbidwatcher`
 529 1. Remove the package from the list of all packages (`pkgs/top-level/all-packages.nix`).
 530 1. Add an alias for the package name in `pkgs/top-level/aliases.nix` (There is also `pkgs/applications/editors/vim/plugins/aliases.nix`. Package sets typically do not have aliases, so we can't add them there.)
 531
 532     For example in this case:
 533
 534     ```nix
 535     {
 536       jbidwatcher = throw "jbidwatcher was discontinued in march 2021"; # added 2021-03-15
 537     }
 538     ```
 539
 540     The throw message should explain in short why the package was removed for users that still have it installed.
 541
 542 1. Test if the changes introduced any issues by running `nix-env -qaP -f . --show-trace`. It should show the list of packages without errors.
 543 1. Commit the changes. Explain again why the package was removed. If it was declared discontinued upstream, add a link to the source.
 544
 545     ```ShellSession
 546     $ git add pkgs/applications/misc/jbidwatcher/default.nix pkgs/top-level/all-packages.nix pkgs/top-level/aliases.nix
 547     $ git commit
 548     ```
 549
 550     Example commit message:
 551
 552     ```
 553     jbidwatcher: remove
 554
 555     project was discontinued in march 2021. the program does not work anymore because ebay changed the login.
 556
 557     https://web.archive.org/web/20210315205723/http://www.jbidwatcher.com/
 558     ```
 559
 560 1. Push changes to your GitHub fork with `git push`
 561 1. Create a pull request against Nixpkgs. Mention the package maintainer.
 562
 563 This is how the pull request looks like in this case: [https://github.com/NixOS/nixpkgs/pull/116470](https://github.com/NixOS/nixpkgs/pull/116470)
 564
 565 ## Package tests
 566
 567 To run the main types of tests locally:
 568
 569 - Run package-internal tests with `nix-build --attr pkgs.PACKAGE.passthru.tests`
 570 - Run [NixOS tests](https://nixos.org/manual/nixos/unstable/#sec-nixos-tests) with `nix-build --attr nixosTests.NAME`, where `NAME` is the name of the test listed in `nixos/tests/all-tests.nix`
 571 - Run [global package tests](https://nixos.org/manual/nixpkgs/unstable/#sec-package-tests) with `nix-build --attr tests.PACKAGE`, where `PACKAGE` is the name of the test listed in `pkgs/test/default.nix`
 572 - See `lib/tests/NAME.nix` for instructions on running specific library tests
 573
 574 Tests are important to ensure quality and make reviews and automatic updates easy.
 575
 576 The following types of tests exists:
 577
 578 * [NixOS **module tests**](https://nixos.org/manual/nixos/stable/#sec-nixos-tests), which spawn one or more NixOS VMs. They exercise both NixOS modules and the packaged programs used within them. For example, a NixOS module test can start a web server VM running the `nginx` module, and a client VM running `curl` or a graphical `firefox`, and test that they can talk to each other and display the correct content.
 579 * Nix **package tests** are a lightweight alternative to NixOS module tests. They should be used to create simple integration tests for packages, but cannot test NixOS services, and some programs with graphical user interfaces may also be difficult to test with them.
 580 * The **`checkPhase` of a package**, which should execute the unit tests that are included in the source code of a package.
 581
 582 Here in the nixpkgs manual we describe mostly _package tests_; for _module tests_ head over to the corresponding [section in the NixOS manual](https://nixos.org/manual/nixos/stable/#sec-nixos-tests).
 583
 584 ### Writing inline package tests
 585
 586 For very simple tests, they can be written inline:
 587
 588 ```nix
 589 { /* ... , */ yq-go }:
 590
 591 buildGoModule rec {
 592   # …
 593
 594   passthru.tests = {
 595     simple = runCommand "${pname}-test" {} ''
 596       echo "test: 1" | ${yq-go}/bin/yq eval -j > $out
 597       [ "$(cat $out | tr -d $'\n ')" = '{"test":1}' ]
 598     '';
 599   };
 600 }
 601 ```
 602
 603 Any derivaton can be specified as a test, even if it's in a different file.
 604 Such a derivaton that implements a test can depend on the package under test, even in the presence of `overrideAttrs`.
 605
 606 In the following example, `(my-package.overrideAttrs f).passthru.tests` will work as expected, as long as the definition of `tests` does not rely on the original `my-package` or overrides all occurrences of `my-package`:
 607
 608 ```nix
 609 # my-package/default.nix
 610 { stdenv, callPackage }:
 611 stdenv.mkDerivation (finalAttrs: {
 612   # ...
 613   passthru.tests.example = callPackage ./example.nix { my-package = finalAttrs.finalPackage; };
 614 })
 615 ```
 616
 617 ```nix
 618 # my-package/example.nix
 619 { runCommand, lib, my-package, ... }:
 620 runCommand "my-package-test" {
 621   nativeBuildInputs = [ my-package ];
 622   src = lib.sources.sourcesByRegex ./. [ ".*.in" ".*.expected" ];
 623 } ''
 624   my-package --help
 625   my-package <example.in >example.actual
 626   diff -U3 --color=auto example.expected example.actual
 627   mkdir $out
 628 ''
 629 ```
 630
 631 ### Writing larger package tests
 632 [larger-package-tests]: #writing-larger-package-tests
 633
 634 This is an example using the `phoronix-test-suite` package with the current best practices.
 635
 636 Add the tests in `passthru.tests` to the package definition like this:
 637
 638 ```nix
 639 { stdenv, lib, fetchurl, callPackage }:
 640
 641 stdenv.mkDerivation {
 642   # …
 643
 644   passthru.tests = {
 645     simple-execution = callPackage ./tests.nix { };
 646   };
 647
 648   meta = { /* … */ };
 649 }
 650 ```
 651
 652 Create `tests.nix` in the package directory:
 653
 654 ```nix
 655 { runCommand, phoronix-test-suite }:
 656
 657 let
 658   inherit (phoronix-test-suite) pname version;
 659 in
 660
 661 runCommand "${pname}-tests" { meta.timeout = 60; }
 662   ''
 663     # automatic initial setup to prevent interactive questions
 664     ${phoronix-test-suite}/bin/phoronix-test-suite enterprise-setup >/dev/null
 665     # get version of installed program and compare with package version
 666     if [[ `${phoronix-test-suite}/bin/phoronix-test-suite version` != *"${version}"*  ]]; then
 667       echo "Error: program version does not match package version"
 668       exit 1
 669     fi
 670     # run dummy command
 671     ${phoronix-test-suite}/bin/phoronix-test-suite dummy_module.dummy-command >/dev/null
 672     # needed for Nix to register the command as successful
 673     touch $out
 674   ''
 675 ```
 676
 677 ### Running package tests
 678
 679 You can run these tests with:
 680
 681 ```ShellSession
 682 $ cd path/to/nixpkgs
 683 $ nix-build -A phoronix-test-suite.tests
 684 ```
 685
 686 ### Examples of package tests
 687
 688 Here are examples of package tests:
 689
 690 - [Jasmin compile test](development/compilers/jasmin/test-assemble-hello-world/default.nix)
 691 - [Lobster compile test](development/compilers/lobster/test-can-run-hello-world.nix)
 692 - [Spacy annotation test](development/python-modules/spacy/annotation-test/default.nix)
 693 - [Libtorch test](development/libraries/science/math/libtorch/test/default.nix)
 694 - [Multiple tests for nanopb](development/libraries/nanopb/default.nix)
 695
 696 ### Linking NixOS module tests to a package
 697
 698 Like [package tests][larger-package-tests] as shown above, [NixOS module tests](https://nixos.org/manual/nixos/stable/#sec-nixos-tests) can also be linked to a package, so that the tests can be easily run when changing the related package.
 699
 700 For example, assuming we're packaging `nginx`, we can link its module test via `passthru.tests`:
 701
 702 ```nix
 703 { stdenv, lib, nixosTests }:
 704
 705 stdenv.mkDerivation {
 706   # ...
 707
 708   passthru.tests = {
 709     nginx = nixosTests.nginx;
 710   };
 711
 712   # ...
 713 }
 714 ```
 715
 716 ## Automatic package updates
 717 [automatic-package-updates]: #automatic-package-updates
 718
 719 Nixpkgs periodically tries to update all packages that have a `passthru.updateScript` attribute.
 720
 721 > [!Note]
 722 > A common pattern is to use the [`nix-update-script`](../pkgs/common-updater/nix-update.nix) attribute provided in Nixpkgs, which runs [`nix-update`](https://github.com/Mic92/nix-update):
 723 >
 724 > ```nix
 725 > { stdenv, nix-update-script }:
 726 > stdenv.mkDerivation {
 727 >   # ...
 728 >   passthru.updateScript = nix-update-script { };
 729 > }
 730 > ```
 731 >
 732 > For simple packages, this is often enough, and will ensure that the package is updated automatically by [`nixpkgs-update`](https://ryantm.github.io/nixpkgs-update) when a new version is released.
 733 > The [update bot](https://nix-community.org/update-bot) runs periodically to attempt to automatically update packages, and will run `passthru.updateScript` if set.
 734 > While not strictly necessary if the project is listed on [Repology](https://repology.org), using `nix-update-script` allows the package to update via many more sources (e.g. GitHub releases).
 735
 736 The `passthru.updateScript` attribute can contain one of the following:
 737
 738 - an executable file, either on the file system:
 739
 740   ```nix
 741   { stdenv }:
 742   stdenv.mkDerivation {
 743     # ...
 744     passthru.updateScript = ./update.sh;
 745   }
 746   ```
 747
 748   or inside the expression itself:
 749
 750   ```nix
 751   { stdenv, writeScript }:
 752   stdenv.mkDerivation {
 753     # ...
 754     passthru.updateScript = writeScript "update-zoom-us" ''
 755       #!/usr/bin/env nix-shell
 756       #!nix-shell -i bash -p curl pcre2 common-updater-scripts
 757
 758       set -eu -o pipefail
 759
 760       version="$(curl -sI https://zoom.us/client/latest/zoom_x86_64.tar.xz | grep -Fi 'Location:' | pcre2grep -o1 '/(([0-9]\.?)+)/')"
 761       update-source-version zoom-us "$version"
 762     '';
 763   }
 764   ```
 765
 766 - a list, a script file followed by arguments to be passed to it:
 767
 768   ```nix
 769   { stdenv }:
 770   stdenv.mkDerivation {
 771     # ...
 772     passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ];
 773   }
 774   ```
 775
 776 - an attribute set containing:
 777   - `command`
 778
 779     A string or list in the [format expected by `passthru.updateScript`][automatic-package-updates]
 780
 781   - `attrPath` (optional)
 782
 783     A string containing the canonical attribute path for the package.
 784
 785     If present, it will be passed to the update script instead of the attribute path on which the package was discovered during Nixpkgs traversal.
 786
 787   - `supportedFeatures` (optional)
 788
 789     A list of the [extra features the script supports][supported-features].
 790
 791     ```nix
 792     { stdenv }:
 793     stdenv.mkDerivation rec {
 794       pname = "my-package";
 795       # ...
 796       passthru.updateScript = {
 797         command = [ ../../update.sh pname ];
 798         attrPath = pname;
 799         supportedFeatures = [ /* ... */ ];
 800       };
 801     }
 802     ```
 803
 804 ### How are update scripts executed?
 805
 806 Update scripts are to be invoked by the [automatic package update script](../maintainers/scripts/update.nix).
 807 You can run `nix-shell maintainers/scripts/update.nix` in the root of Nixpkgs repository for information on how to use it.
 808 `update.nix` offers several modes for selecting packages to update, and it will execute update scripts for all matched packages that have an `updateScript` attribute.
 809
 810 Each update script will be passed the following environment variables:
 811
 812 - [`UPDATE_NIX_NAME`] – content of the `name` attribute of the updated package
 813 - [`UPDATE_NIX_PNAME`] – content of the `pname` attribute of the updated package
 814 - [`UPDATE_NIX_OLD_VERSION`] – content of the `version` attribute of the updated package
 815 - [`UPDATE_NIX_ATTR_PATH`] – attribute path the `update.nix` discovered the package on (or the package's specified `attrPath` when available). Example: `pantheon.elementary-terminal`
 816
 817 > [!Note]
 818 > An update script will be usually run from the root of the Nixpkgs repository, but you should not rely on that.
 819 > Also note that `update.nix` executes update scripts in parallel by default, so you should avoid running `git commit` or any other commands that cannot handle that.
 820
 821 While update scripts should not create commits themselves, `update.nix` supports automatically creating commits when running it with `--argstr commit true`.
 822 If you need to customize commit message, you can have the update script implement the `commit` feature.
 823
 824 ### Supported features
 825 [update-script-supported-features]: #supported-features
 826
 827 - `commit`
 828
 829   This feature allows update scripts to *ask* `update.nix` to create Git commits.
 830
 831   When support of this feature is declared, whenever the update script exits with `0` return status, it is expected to print a JSON list containing an object described below for each updated attribute to standard output.
 832   Example:
 833
 834   ```json
 835   [
 836     {
 837       "attrPath": "volume_key",
 838       "oldVersion": "0.3.11",
 839       "newVersion": "0.3.12",
 840       "files": [
 841         "/path/to/nixpkgs/pkgs/development/libraries/volume-key/default.nix"
 842       ]
 843     }
 844   ]
 845   ```
 846   :::
 847
 848   When `update.nix` is run with `--argstr commit true`, it will create a separate commit for each of the objects.
 849   An empty list can be returned when the script did not update any files; for example, when the package is already at the latest version.
 850
 851   The commit object contains the following values:
 852
 853   - `attrPath` – a string containing the attribute path
 854   - `oldVersion` – a string containing the old version
 855   - `newVersion` – a string containing the new version
 856   - `files` – a non-empty list of file paths (as strings) to add to the commit
 857   - `commitBody` (optional) – a string with extra content to be appended to the default commit message (useful for adding changelog links)
 858   - `commitMessage` (optional) – a string to use instead of the default commit message
 859
 860   If the returned list contains exactly one object (e.g. `[{}]`), all values are optional and will be determined automatically.
 861
 862 ## Reviewing contributions
 863
 864 ### Package updates
 865
 866 A package update is the most trivial and common type of pull request. These pull requests mainly consist of updating the version part of the package name and the source hash.
 867
 868 It can happen that non-trivial updates include patches or more complex changes.
 869
 870 Reviewing process:
 871
 872 - Ensure that the package versioning [fits the guidelines](#versioning).
 873 - Ensure that the commit text [fits the guidelines](../CONTRIBUTING.md#commit-conventions).
 874 - Ensure that the package maintainers are notified.
 875   - [CODEOWNERS](https://help.github.com/articles/about-codeowners) will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
 876 - Ensure that the meta field information [fits the guidelines](#meta-attributes) and is correct:
 877   - License can change with version updates, so it should be checked to match the upstream license.
 878   - If the package has no maintainer, a maintainer must be set. This can be the update submitter or a community member that accepts to take maintainership of the package.
 879 - Ensure that the code contains no typos.
 880 - Build the package locally.
 881   - Pull requests are often targeted to the master or staging branch, and building the pull request locally when it is submitted can trigger many source builds.
 882   - It is possible to rebase the changes on nixos-unstable or nixpkgs-unstable for easier review by running the following commands from a nixpkgs clone.
 883
 884     ```ShellSession
 885     $ git fetch origin nixos-unstable
 886     $ git fetch origin pull/PRNUMBER/head
 887     $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD
 888     ```
 889
 890     - The first command fetches the nixos-unstable branch.
 891     - The second command fetches the pull request changes, `PRNUMBER` is the number at the end of the pull request title and `BASEBRANCH` the base branch of the pull request.
 892     - The third command rebases the pull request changes to the nixos-unstable branch.
 893   - The [nixpkgs-review](https://github.com/Mic92/nixpkgs-review) tool can be used to review a pull request content in a single command. `PRNUMBER` should be replaced by the number at the end of the pull request title. You can also provide the full github pull request url.
 894
 895     ```ShellSession
 896     $ nix-shell -p nixpkgs-review --run "nixpkgs-review pr PRNUMBER"
 897     ```
 898 - Run every binary.
 899
 900 Sample template for a package update review is provided below.
 901
 902 ```markdown
 903 ##### Reviewed points
 904
 905 - [ ] package name fits guidelines
 906 - [ ] package version fits guidelines
 907 - [ ] package builds on ARCHITECTURE
 908 - [ ] executables tested on ARCHITECTURE
 909 - [ ] all depending packages build
 910 - [ ] patches have a comment describing either the upstream URL or a reason why the patch wasn't upstreamed
 911 - [ ] patches that are remotely available are fetched rather than vendored
 912
 913 ##### Possible improvements
 914
 915 ##### Comments
 916 ```
 917
 918 ### New packages
 919
 920 New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package.
 921
 922 Review process:
 923
 924 - Ensure that all file paths [fit the guidelines](../CONTRIBUTING.md#file-naming-and-organisation).
 925 - Ensure that the package name and version [fits the guidelines](#package-naming).
 926 - Ensure that the package versioning [fits the guidelines](#versioning).
 927 - Ensure that the commit text [fits the guidelines](../CONTRIBUTING.md#commit-conventions).
 928 - Ensure that the meta fields [fits the guidelines](#meta-attributes) and contain the correct information:
 929   - License must match the upstream license.
 930   - Platforms should be set (or the package will not get binary substitutes).
 931   - Maintainers must be set. This can be the package submitter or a community member that accepts taking up maintainership of the package.
 932   - The `meta.mainProgram` must be set if a main executable exists.
 933 - Report detected typos.
 934 - Ensure the package source:
 935   - Uses `mirror://` URLs when available.
 936   - Uses the most appropriate functions (e.g. packages from GitHub should use `fetchFromGitHub`).
 937 - Build the package locally.
 938 - Run every binary.
 939
 940 Sample template for a new package review is provided below.
 941
 942 ```markdown
 943 ##### Reviewed points
 944
 945 - [ ] package path fits guidelines
 946 - [ ] package name fits guidelines
 947 - [ ] package version fits guidelines
 948 - [ ] package builds on ARCHITECTURE
 949 - [ ] executables tested on ARCHITECTURE
 950 - [ ] `meta.description` is set and fits guidelines
 951 - [ ] `meta.license` fits upstream license
 952 - [ ] `meta.platforms` is set
 953 - [ ] `meta.maintainers` is set
 954 - [ ] `meta.mainProgram` is set, if applicable.
 955 - [ ] build time only dependencies are declared in `nativeBuildInputs`
 956 - [ ] source is fetched using the appropriate function
 957 - [ ] the list of `phases` is not overridden
 958 - [ ] when a phase (like `installPhase`) is overridden it starts with `runHook preInstall` and ends with `runHook postInstall`.
 959 - [ ] patches have a comment describing either the upstream URL or a reason why the patch wasn't upstreamed
 960 - [ ] patches that are remotely available are fetched rather than vendored
 961
 962 ##### Possible improvements
 963
 964 ##### Comments
 965 ```
 966
 967 ## Security
 968
 969 ### Submitting security fixes
 970 [security-fixes]: #submitting-security-fixes
 971
 972 Security fixes are submitted in the same way as other changes and thus the same guidelines apply.
 973
 974 - If a new version fixing the vulnerability has been released, update the package;
 975 - If the security fix comes in the form of a patch and a CVE is available, then add the patch to the Nixpkgs tree, and apply it to the package.
 976   The name of the patch should be the CVE identifier, so e.g. `CVE-2019-13636.patch`; If a patch is fetched the name needs to be set as well, e.g.:
 977
 978   ```nix
 979   (fetchpatch {
 980     name = "CVE-2019-11068.patch";
 981     url = "https://gitlab.gnome.org/GNOME/libxslt/commit/e03553605b45c88f0b4b2980adfbbb8f6fca2fd6.patch";
 982     hash = "sha256-SEKe/8HcW0UBHCfPTTOnpRlzmV2nQPPeL6HOMxBZd14=";
 983   })
 984   ```
 985
 986 If a security fix applies to both master and a stable release then, similar to regular changes, they are preferably delivered via master first and cherry-picked to the release branch.
 987
 988 Critical security fixes may by-pass the staging branches and be delivered directly to release branches such as `master` and `release-*`.
 989
 990 ### Vulnerability Roundup
 991
 992 #### Issues
 993
 994 Vulnerable packages in Nixpkgs are managed using issues.
 995 Currently opened ones can be found using the following:
 996
 997 [github.com/NixOS/nixpkgs/issues?q=is:issue+is:open+"Vulnerability+roundup"](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+%22Vulnerability+roundup%22)
 998
 999 Each issue correspond to a vulnerable version of a package; As a consequence:
1000
1001 - One issue can contain several CVEs;
1002 - One CVE can be shared across several issues;
1003 - A single package can be concerned by several issues.
1004
1005
1006 A "Vulnerability roundup" issue usually respects the following format:
1007
1008 ```txt
1009 <link to relevant package search on search.nix.gsc.io>, <link to relevant files in Nixpkgs on GitHub>
1010
1011 <list of related CVEs, their CVSS score, and the impacted NixOS version>
1012
1013 <list of the scanned Nixpkgs versions>
1014
1015 <list of relevant contributors>
1016 ```
1017
1018 Note that there can be an extra comment containing links to previously reported (and still open) issues for the same package.
1019
1020
1021 #### Triaging and Fixing
1022
1023 **Note**: An issue can be a "false positive" (i.e. automatically opened, but without the package it refers to being actually vulnerable).
1024 If you find such a "false positive", comment on the issue an explanation of why it falls into this category, linking as much information as the necessary to help maintainers double check.
1025
1026 If you are investigating a "true positive":
1027
1028 - Find the earliest patched version or a code patch in the CVE details;
1029 - Is the issue already patched (version up-to-date or patch applied manually) in Nixpkgs's `master` branch?
1030   - **No**:
1031     - [Submit a security fix][security-fixes];
1032     - Once the fix is merged into `master`, [submit the change to the vulnerable release branch(es)](../CONTRIBUTING.md#how-to-backport-pull-requests);
1033   - **Yes**: [Backport the change to the vulnerable release branch(es)](../CONTRIBUTING.md#how-to-backport-pull-requests).
1034 - When the patch has made it into all the relevant branches (`master`, and the vulnerable releases), close the relevant issue(s).