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
  36 If any of these questions' answer is no, then you should probably not add the package.
  37
  38 This is section describes a general framework of understanding and exceptions might apply.
  39
  40 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.
  41
  42 ---
  43
  44 Now that this is out of the way. To add a package to Nixpkgs:
  45
  46 1. Checkout the Nixpkgs source tree:
  47
  48    ```ShellSession
  49    $ git clone https://github.com/NixOS/nixpkgs
  50    $ cd nixpkgs
  51    ```
  52
  53 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:
  54
  55    ```ShellSession
  56    $ mkdir -p pkgs/by-name/so/some-package
  57    ```
  58
  59    For more detailed information, see [here](./by-name/README.md).
  60
  61 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.
  62
  63    ```ShellSession
  64    $ emacs pkgs/by-name/so/some-package/package.nix
  65    $ git add pkgs/by-name/so/some-package/package.nix
  66    ```
  67
  68    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).
  69    Here are some good ones:
  70
  71    - 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.
  72
  73    - 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`.
  74
  75    - 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`.
  76
  77    - 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`.
  78
  79    - 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.
  80
  81    - buildMozillaMach: [`pkgs/applications/networking/browser/firefox/common.nix`](applications/networking/browsers/firefox/common.nix). A reusable build function for Firefox, Thunderbird and Librewolf.
  82
  83    - 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.
  84
  85    - 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.
  86
  87    - 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.
  88
  89    Some notes:
  90
  91    - Add yourself as the maintainer of the package.
  92
  93    - 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).
  94
  95    - You can use `nix-prefetch-url url` to get the SHA-256 hash of source distributions. There are similar commands as `nix-prefetch-git` and `nix-prefetch-hg` available in `nix-prefetch-scripts` package.
  96
  97    - A list of schemes for `mirror://` URLs can be found in [`pkgs/build-support/fetchurl/mirrors.nix`](build-support/fetchurl/mirrors.nix).
  98
  99    The exact syntax and semantics of the Nix expression language, including the built-in function, are [described in the Nix manual](https://nixos.org/manual/nix/stable/language/).
 100
 101 5. To test whether the package builds, run the following command from the root of the nixpkgs source tree:
 102
 103    ```ShellSession
 104    $ nix-build -A some-package
 105    ```
 106
 107    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.
 108
 109 6. If you want to install the package into your profile (optional), do
 110
 111    ```ShellSession
 112    $ nix-env -f . -iA libfoo
 113    ```
 114
 115 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.
 116
 117 ## Commit conventions
 118
 119 - Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole.
 120
 121 - Format the commit messages in the following way:
 122
 123   ```
 124   (pkg-name): (from -> to | init at version | refactor | etc)
 125
 126   (Motivation for change. Link to release notes. Additional information.)
 127   ```
 128
 129   Examples:
 130
 131   * nginx: init at 2.0.1
 132   * firefox: 54.0.1 -> 55.0
 133
 134     https://www.mozilla.org/en-US/firefox/55.0/releasenotes/
 135
 136 ## Category Hierarchy
 137 [categories]: #category-hierarchy
 138
 139 Most top-level packages are organised in a loosely-categorised directory hierarchy in this directory.
 140 See the [overview](#overview) for which directories are part of this.
 141
 142 This category hierarchy is partially deprecated and will be migrated away over time.
 143 The new `pkgs/by-name` directory ([docs](./by-name/README.md)) should be preferred instead.
 144 The category hierarchy may still be used for packages that should be imported using an alternate `callPackage`, such as `python3Packages.callPackage` or `libsForQt5.callPackage`.
 145
 146 If that is the case for a new package, here are some rules for picking the right category.
 147 Many packages fall under several categories; what matters is the _primary_ purpose of a package.
 148 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`.
 149
 150 <details>
 151 <summary>Categories</summary>
 152
 153 **If it’s used to support _software development_:**
 154
 155 - **If it’s a _library_ used by other packages:**
 156
 157   - `development/libraries` (e.g. `libxml2`)
 158
 159 - **If it’s a _compiler_:**
 160
 161   - `development/compilers` (e.g. `gcc`)
 162
 163 - **If it’s an _interpreter_:**
 164
 165   - `development/interpreters` (e.g. `guile`)
 166
 167 - **If it’s a (set of) development _tool(s)_:**
 168
 169   - **If it’s a _parser generator_ (including lexers):**
 170
 171     - `development/tools/parsing` (e.g. `bison`, `flex`)
 172
 173   - **If it’s a _build manager_:**
 174
 175     - `development/tools/build-managers` (e.g. `gnumake`)
 176
 177   - **If it’s a _language server_:**
 178
 179     - `development/tools/language-servers` (e.g. `ccls` or `rnix-lsp`)
 180
 181   - **Else:**
 182
 183     - `development/tools/misc` (e.g. `binutils`)
 184
 185 - **Else:**
 186
 187   - `development/misc`
 188
 189 **If it’s a (set of) _tool(s)_:**
 190
 191 (A tool is a relatively small program, especially one intended to be used non-interactively.)
 192
 193 - **If it’s for _networking_:**
 194
 195   - `tools/networking` (e.g. `wget`)
 196
 197 - **If it’s for _text processing_:**
 198
 199   - `tools/text` (e.g. `diffutils`)
 200
 201 - **If it’s a _system utility_, i.e., something related or essential to the operation of a system:**
 202
 203   - `tools/system` (e.g. `cron`)
 204
 205 - **If it’s an _archiver_ (which may include a compression function):**
 206
 207   - `tools/archivers` (e.g. `zip`, `tar`)
 208
 209 - **If it’s a _compression_ program:**
 210
 211   - `tools/compression` (e.g. `gzip`, `bzip2`)
 212
 213 - **If it’s a _security_-related program:**
 214
 215   - `tools/security` (e.g. `nmap`, `gnupg`)
 216
 217 - **Else:**
 218
 219   - `tools/misc`
 220
 221 **If it’s a _shell_:**
 222
 223 - `shells` (e.g. `bash`)
 224
 225 **If it’s a _server_:**
 226
 227 - **If it’s a web server:**
 228
 229   - `servers/http` (e.g. `apache-httpd`)
 230
 231 - **If it’s an implementation of the X Windowing System:**
 232
 233   - `servers/x11` (e.g. `xorg` — this includes the client libraries and programs)
 234
 235 - **Else:**
 236
 237   - `servers/misc`
 238
 239 **If it’s a _desktop environment_:**
 240
 241 - `desktops` (e.g. `kde`, `gnome`, `enlightenment`)
 242
 243 **If it’s a _window manager_:**
 244
 245 - `applications/window-managers` (e.g. `awesome`, `stumpwm`)
 246
 247 **If it’s an _application_:**
 248
 249 A (typically large) program with a distinct user interface, primarily used interactively.
 250
 251 - **If it’s a _version management system_:**
 252
 253   - `applications/version-management` (e.g. `subversion`)
 254
 255 - **If it’s a _terminal emulator_:**
 256
 257   - `applications/terminal-emulators` (e.g. `alacritty` or `rxvt` or `termite`)
 258
 259 - **If it’s a _file manager_:**
 260
 261   - `applications/file-managers` (e.g. `mc` or `ranger` or `pcmanfm`)
 262
 263 - **If it’s for _video playback / editing_:**
 264
 265   - `applications/video` (e.g. `vlc`)
 266
 267 - **If it’s for _graphics viewing / editing_:**
 268
 269   - `applications/graphics` (e.g. `gimp`)
 270
 271 - **If it’s for _networking_:**
 272
 273   - **If it’s a _mailreader_:**
 274
 275     - `applications/networking/mailreaders` (e.g. `thunderbird`)
 276
 277   - **If it’s a _newsreader_:**
 278
 279     - `applications/networking/newsreaders` (e.g. `pan`)
 280
 281   - **If it’s a _web browser_:**
 282
 283     - `applications/networking/browsers` (e.g. `firefox`)
 284
 285   - **Else:**
 286
 287     - `applications/networking/misc`
 288
 289 - **Else:**
 290
 291   - `applications/misc`
 292
 293 **If it’s _data_ (i.e., does not have a straight-forward executable semantics):**
 294
 295 - **If it’s a _font_:**
 296
 297   - `data/fonts`
 298
 299 - **If it’s an _icon theme_:**
 300
 301   - `data/icons`
 302
 303 - **If it’s related to _SGML/XML processing_:**
 304
 305   - **If it’s an _XML DTD_:**
 306
 307     - `data/sgml+xml/schemas/xml-dtd` (e.g. `docbook`)
 308
 309   - **If it’s an _XSLT stylesheet_:**
 310
 311     (Okay, these are executable...)
 312
 313     - `data/sgml+xml/stylesheets/xslt` (e.g. `docbook-xsl`)
 314
 315 - **If it’s a _theme_ for a _desktop environment_, a _window manager_ or a _display manager_:**
 316
 317   - `data/themes`
 318
 319 **If it’s a _game_:**
 320
 321 - `games`
 322
 323 **Else:**
 324
 325 - `misc`
 326
 327 </details>
 328
 329 # Conventions
 330
 331 ## Package naming
 332
 333 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.
 334
 335 In Nixpkgs, there are generally three different names associated with a package:
 336
 337 - The `pname` attribute of the derivation. This is what most users see, in particular when using `nix-env`.
 338
 339 - 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`.
 340
 341 - The filename for (the directory containing) the Nix expression.
 342
 343 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`.
 344
 345 There are a few naming guidelines:
 346
 347 - The `pname` attribute _should_ be identical to the upstream package name.
 348
 349 - The `pname` and the `version` attribute _must not_ contain uppercase letters — e.g., `"mplayer"` instead of `"MPlayer"`.
 350
 351 - The `version` attribute _must_ start with a digit e.g., `"0.3.1rc2"`.
 352
 353 - 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.
 354
 355 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"`.
 356
 357 - 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`.
 358
 359 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"`.
 360
 361 - 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.
 362
 363 - 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].
 364
 365 ## Versioning
 366 [versioning]: #versioning
 367
 368 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.
 369
 370 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`.
 371
 372 All versions of a package _must_ be included in `all-packages.nix` to make sure that they evaluate correctly.
 373
 374 ## Meta attributes
 375
 376 * `meta.description` must:
 377   * Be short, just one sentence.
 378   * Be capitalized.
 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 ### Fetching Sources
 408
 409 There are multiple ways to fetch a package source in nixpkgs. The general guideline is that you should package reproducible sources with a high degree of availability. Right now there is only one fetcher which has mirroring support and that is `fetchurl`. Note that you should also prefer protocols which have a corresponding proxy environment variable.
 410
 411 You can find many source fetch helpers in `pkgs/build-support/fetch*`.
 412
 413 In the file `pkgs/top-level/all-packages.nix` you can find fetch helpers, these have names on the form `fetchFrom*`. The intention of these are to provide snapshot fetches but using the same api as some of the version controlled fetchers from `pkgs/build-support/`. As an example going from bad to good:
 414
 415 - Bad: Uses `git://` which won't be proxied.
 416
 417   ```nix
 418   src = fetchgit {
 419     url = "git://github.com/NixOS/nix.git";
 420     rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
 421     hash = "sha256-7D4m+saJjbSFP5hOwpQq2FGR2rr+psQMTcyb1ZvtXsQ=";
 422   }
 423   ```
 424
 425 - Better: This is ok, but an archive fetch will still be faster.
 426
 427   ```nix
 428   src = fetchgit {
 429     url = "https://github.com/NixOS/nix.git";
 430     rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
 431     hash = "sha256-7D4m+saJjbSFP5hOwpQq2FGR2rr+psQMTcyb1ZvtXsQ=";
 432   }
 433   ```
 434
 435 - Best: Fetches a snapshot archive and you get the rev you want.
 436
 437   ```nix
 438   src = fetchFromGitHub {
 439     owner = "NixOS";
 440     repo = "nix";
 441     rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
 442     hash = "sha256-7D4m+saJjbSFP5hOwpQq2FGR2rr+psQMTcyb1ZvtXsQ=";
 443   }
 444   ```
 445
 446 When fetching from GitHub, commits must always be referenced by their full commit hash. This is because GitHub shares commit hashes among all forks and returns `404 Not Found` when a short commit hash is ambiguous. It already happens for some short, 6-character commit hashes in `nixpkgs`.
 447 It is a practical vector for a denial-of-service attack by pushing large amounts of auto generated commits into forks and was already [demonstrated against GitHub Actions Beta](https://blog.teddykatz.com/2019/11/12/github-actions-dos.html).
 448
 449 Find the value to put as `hash` by running `nix-shell -p nix-prefetch-github --run "nix-prefetch-github --rev 1f795f9f44607cc5bec70d1300150bfefcef2aae NixOS nix"`.
 450
 451 #### Obtaining source hash
 452
 453 Preferred source hash type is sha256. There are several ways to get it.
 454
 455 1. Prefetch URL (with `nix-prefetch-XXX URL`, where `XXX` is one of `url`, `git`, `hg`, `cvs`, `bzr`, `svn`). Hash is printed to stdout.
 456
 457 2. Prefetch by package source (with `nix-prefetch-url '<nixpkgs>' -A PACKAGE.src`, where `PACKAGE` is package attribute name). Hash is printed to stdout.
 458
 459     This works well when you've upgraded existing package version and want to find out new hash, but is useless if package can't be accessed by attribute or package has multiple sources (`.srcs`, architecture-dependent sources, etc).
 460
 461 3. Upstream provided hash: use it when upstream provides `sha256` or `sha512` (when upstream provides `md5`, don't use it, compute `sha256` instead).
 462
 463     A little nuance is that `nix-prefetch-*` tools produce hash encoded with `base32`, but upstream usually provides hexadecimal (`base16`) encoding. Fetchers understand both formats. Nixpkgs does not standardize on any one format.
 464
 465     You can convert between formats with nix-hash, for example:
 466
 467     ```ShellSession
 468     $ nix-hash --type sha256 --to-base32 HASH
 469     ```
 470
 471 4. Extracting hash from local source tarball can be done with `sha256sum`. Use `nix-prefetch-url file:///path/to/tarball` if you want base32 hash.
 472
 473 5. Fake hash: set the hash to one of
 474
 475    - `""`
 476    - `lib.fakeHash`
 477    - `lib.fakeSha256`
 478    - `lib.fakeSha512`
 479
 480    in the package expression, attempt build and extract correct hash from error messages.
 481
 482    > [!Warning]
 483    > You must use one of these four fake hashes and not some arbitrarily-chosen hash.
 484    > See [here][secure-hashes]
 485
 486    This is last resort method when reconstructing source URL is non-trivial and `nix-prefetch-url -A` isn’t applicable (for example, [one of `kodi` dependencies](https://github.com/NixOS/nixpkgs/blob/d2ab091dd308b99e4912b805a5eb088dd536adb9/pkgs/applications/video/kodi/default.nix#L73)). The easiest way then would be replace hash with a fake one and rebuild. Nix build will fail and error message will contain desired hash.
 487
 488
 489 #### Obtaining hashes securely
 490 [secure-hashes]: #obtaining-hashes-securely
 491
 492 Let's say Man-in-the-Middle (MITM) sits close to your network. Then instead of fetching source you can fetch malware, and instead of source hash you get hash of malware. Here are security considerations for this scenario:
 493
 494 - `http://` URLs are not secure to prefetch hash from;
 495
 496 - hashes from upstream (in method 3) should be obtained via secure protocol;
 497
 498 - `https://` URLs are secure in methods 1, 2, 3;
 499
 500 - `https://` URLs are secure in method 5 *only if* you use one of the listed fake hashes. If you use any other hash, `fetchurl` will pass `--insecure` to `curl` and may then degrade to HTTP in case of TLS certificate expiration.
 501
 502 ### Patches
 503
 504 Patches available online should be retrieved using `fetchpatch`.
 505
 506 ```nix
 507 patches = [
 508   (fetchpatch {
 509     name = "fix-check-for-using-shared-freetype-lib.patch";
 510     url = "http://git.ghostscript.com/?p=ghostpdl.git;a=patch;h=8f5d285";
 511     hash = "sha256-uRcxaCjd+WAuGrXOmGfFeu79cUILwkRdBu48mwcBE7g=";
 512   })
 513 ];
 514 ```
 515
 516 Otherwise, you can add a `.patch` file to the `nixpkgs` repository. In the interest of keeping our maintenance burden to a minimum, only patches that are unique to `nixpkgs` should be added in this way.
 517
 518 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.
 519
 520 ```nix
 521 patches = [ ./0001-changes.patch ];
 522 ```
 523
 524 If you do need to do create this sort of patch file, one way to do so is with git:
 525
 526 1. Move to the root directory of the source code you're patching.
 527
 528     ```ShellSession
 529     $ cd the/program/source
 530     ```
 531
 532 2. If a git repository is not already present, create one and stage all of the source files.
 533
 534     ```ShellSession
 535     $ git init
 536     $ git add .
 537     ```
 538
 539 3. Edit some files to make whatever changes need to be included in the patch.
 540
 541 4. Use git to create a diff, and pipe the output to a patch file:
 542
 543     ```ShellSession
 544     $ git diff -a > nixpkgs/pkgs/the/package/0001-changes.patch
 545     ```
 546
 547 ## Deprecating/removing packages
 548
 549 There is currently no policy when to remove a package.
 550
 551 Before removing a package, one should try to find a new maintainer or fix smaller issues first.
 552
 553 ### Steps to remove a package from Nixpkgs
 554
 555 We use jbidwatcher as an example for a discontinued project here.
 556
 557 1. Have Nixpkgs checked out locally and up to date.
 558 1. Create a new branch for your change, e.g. `git checkout -b jbidwatcher`
 559 1. Remove the actual package including its directory, e.g. `git rm -rf pkgs/applications/misc/jbidwatcher`
 560 1. Remove the package from the list of all packages (`pkgs/top-level/all-packages.nix`).
 561 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.)
 562
 563     For example in this case:
 564
 565     ```
 566     jbidwatcher = throw "jbidwatcher was discontinued in march 2021"; # added 2021-03-15
 567     ```
 568
 569     The throw message should explain in short why the package was removed for users that still have it installed.
 570
 571 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.
 572 1. Commit the changes. Explain again why the package was removed. If it was declared discontinued upstream, add a link to the source.
 573
 574     ```ShellSession
 575     $ git add pkgs/applications/misc/jbidwatcher/default.nix pkgs/top-level/all-packages.nix pkgs/top-level/aliases.nix
 576     $ git commit
 577     ```
 578
 579     Example commit message:
 580
 581     ```
 582     jbidwatcher: remove
 583
 584     project was discontinued in march 2021. the program does not work anymore because ebay changed the login.
 585
 586     https://web.archive.org/web/20210315205723/http://www.jbidwatcher.com/
 587     ```
 588
 589 1. Push changes to your GitHub fork with `git push`
 590 1. Create a pull request against Nixpkgs. Mention the package maintainer.
 591
 592 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)
 593
 594 ## Package tests
 595
 596 To run the main types of tests locally:
 597
 598 - Run package-internal tests with `nix-build --attr pkgs.PACKAGE.passthru.tests`
 599 - 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`
 600 - 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`
 601 - See `lib/tests/NAME.nix` for instructions on running specific library tests
 602
 603 Tests are important to ensure quality and make reviews and automatic updates easy.
 604
 605 The following types of tests exists:
 606
 607 * [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.
 608 * 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.
 609 * The **`checkPhase` of a package**, which should execute the unit tests that are included in the source code of a package.
 610
 611 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).
 612
 613 ### Writing inline package tests
 614
 615 For very simple tests, they can be written inline:
 616
 617 ```nix
 618 { …, yq-go }:
 619
 620 buildGoModule rec {
 621   …
 622
 623   passthru.tests = {
 624     simple = runCommand "${pname}-test" {} ''
 625       echo "test: 1" | ${yq-go}/bin/yq eval -j > $out
 626       [ "$(cat $out | tr -d $'\n ')" = '{"test":1}' ]
 627     '';
 628   };
 629 }
 630 ```
 631
 632 ### Writing larger package tests
 633 [larger-package-tests]: #writing-larger-package-tests
 634
 635 This is an example using the `phoronix-test-suite` package with the current best practices.
 636
 637 Add the tests in `passthru.tests` to the package definition like this:
 638
 639 ```nix
 640 { stdenv, lib, fetchurl, callPackage }:
 641
 642 stdenv.mkDerivation {
 643   …
 644
 645   passthru.tests = {
 646     simple-execution = callPackage ./tests.nix { };
 647   };
 648
 649   meta = { … };
 650 }
 651 ```
 652
 653 Create `tests.nix` in the package directory:
 654
 655 ```nix
 656 { runCommand, phoronix-test-suite }:
 657
 658 let
 659   inherit (phoronix-test-suite) pname version;
 660 in
 661
 662 runCommand "${pname}-tests" { meta.timeout = 60; }
 663   ''
 664     # automatic initial setup to prevent interactive questions
 665     ${phoronix-test-suite}/bin/phoronix-test-suite enterprise-setup >/dev/null
 666     # get version of installed program and compare with package version
 667     if [[ `${phoronix-test-suite}/bin/phoronix-test-suite version` != *"${version}"*  ]]; then
 668       echo "Error: program version does not match package version"
 669       exit 1
 670     fi
 671     # run dummy command
 672     ${phoronix-test-suite}/bin/phoronix-test-suite dummy_module.dummy-command >/dev/null
 673     # needed for Nix to register the command as successful
 674     touch $out
 675   ''
 676 ```
 677
 678 ### Running package tests
 679
 680 You can run these tests with:
 681
 682 ```ShellSession
 683 $ cd path/to/nixpkgs
 684 $ nix-build -A phoronix-test-suite.tests
 685 ```
 686
 687 ### Examples of package tests
 688
 689 Here are examples of package tests:
 690
 691 - [Jasmin compile test](development/compilers/jasmin/test-assemble-hello-world/default.nix)
 692 - [Lobster compile test](development/compilers/lobster/test-can-run-hello-world.nix)
 693 - [Spacy annotation test](development/python-modules/spacy/annotation-test/default.nix)
 694 - [Libtorch test](development/libraries/science/math/libtorch/test/default.nix)
 695 - [Multiple tests for nanopb](development/libraries/nanopb/default.nix)
 696
 697 ### Linking NixOS module tests to a package
 698
 699 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.
 700
 701 For example, assuming we're packaging `nginx`, we can link its module test via `passthru.tests`:
 702
 703 ```nix
 704 { stdenv, lib, nixosTests }:
 705
 706 stdenv.mkDerivation {
 707   ...
 708
 709   passthru.tests = {
 710     nginx = nixosTests.nginx;
 711   };
 712
 713   ...
 714 }
 715 ```
 716
 717 ## Reviewing contributions
 718
 719 ### Package updates
 720
 721 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.
 722
 723 It can happen that non-trivial updates include patches or more complex changes.
 724
 725 Reviewing process:
 726
 727 - Ensure that the package versioning [fits the guidelines](#versioning).
 728 - Ensure that the commit text [fits the guidelines](../CONTRIBUTING.md#commit-conventions).
 729 - Ensure that the package maintainers are notified.
 730   - [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.
 731 - Ensure that the meta field information [fits the guidelines](#meta-attributes) and is correct:
 732   - License can change with version updates, so it should be checked to match the upstream license.
 733   - 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.
 734 - Ensure that the code contains no typos.
 735 - Build the package locally.
 736   - 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.
 737   - 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.
 738
 739     ```ShellSession
 740     $ git fetch origin nixos-unstable
 741     $ git fetch origin pull/PRNUMBER/head
 742     $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD
 743     ```
 744
 745     - The first command fetches the nixos-unstable branch.
 746     - 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.
 747     - The third command rebases the pull request changes to the nixos-unstable branch.
 748   - 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.
 749
 750     ```ShellSession
 751     $ nix-shell -p nixpkgs-review --run "nixpkgs-review pr PRNUMBER"
 752     ```
 753 - Run every binary.
 754
 755 Sample template for a package update review is provided below.
 756
 757 ```markdown
 758 ##### Reviewed points
 759
 760 - [ ] package name fits guidelines
 761 - [ ] package version fits guidelines
 762 - [ ] package builds on ARCHITECTURE
 763 - [ ] executables tested on ARCHITECTURE
 764 - [ ] all depending packages build
 765 - [ ] patches have a comment describing either the upstream URL or a reason why the patch wasn't upstreamed
 766 - [ ] patches that are remotely available are fetched rather than vendored
 767
 768 ##### Possible improvements
 769
 770 ##### Comments
 771 ```
 772
 773 ### New packages
 774
 775 New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package.
 776
 777 Review process:
 778
 779 - Ensure that all file paths [fit the guidelines](../CONTRIBUTING.md#file-naming-and-organisation).
 780 - Ensure that the package name and version [fits the guidelines](#package-naming).
 781 - Ensure that the package versioning [fits the guidelines](#versioning).
 782 - Ensure that the commit text [fits the guidelines](../CONTRIBUTING.md#commit-conventions).
 783 - Ensure that the meta fields [fits the guidelines](#meta-attributes) and contain the correct information:
 784   - License must match the upstream license.
 785   - Platforms should be set (or the package will not get binary substitutes).
 786   - Maintainers must be set. This can be the package submitter or a community member that accepts taking up maintainership of the package.
 787 - Report detected typos.
 788 - Ensure the package source:
 789   - Uses `mirror://` URLs when available.
 790   - Uses the most appropriate functions (e.g. packages from GitHub should use `fetchFromGitHub`).
 791 - Build the package locally.
 792 - Run every binary.
 793
 794 Sample template for a new package review is provided below.
 795
 796 ```markdown
 797 ##### Reviewed points
 798
 799 - [ ] package path fits guidelines
 800 - [ ] package name fits guidelines
 801 - [ ] package version fits guidelines
 802 - [ ] package builds on ARCHITECTURE
 803 - [ ] executables tested on ARCHITECTURE
 804 - [ ] `meta.description` is set and fits guidelines
 805 - [ ] `meta.license` fits upstream license
 806 - [ ] `meta.platforms` is set
 807 - [ ] `meta.maintainers` is set
 808 - [ ] build time only dependencies are declared in `nativeBuildInputs`
 809 - [ ] source is fetched using the appropriate function
 810 - [ ] the list of `phases` is not overridden
 811 - [ ] when a phase (like `installPhase`) is overridden it starts with `runHook preInstall` and ends with `runHook postInstall`.
 812 - [ ] patches have a comment describing either the upstream URL or a reason why the patch wasn't upstreamed
 813 - [ ] patches that are remotely available are fetched rather than vendored
 814
 815 ##### Possible improvements
 816
 817 ##### Comments
 818 ```
 819
 820 ## Security
 821
 822 ### Submitting security fixes
 823 [security-fixes]: #submitting-security-fixes
 824
 825 Security fixes are submitted in the same way as other changes and thus the same guidelines apply.
 826
 827 - If a new version fixing the vulnerability has been released, update the package;
 828 - 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.
 829   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.:
 830
 831   ```nix
 832   (fetchpatch {
 833     name = "CVE-2019-11068.patch";
 834     url = "https://gitlab.gnome.org/GNOME/libxslt/commit/e03553605b45c88f0b4b2980adfbbb8f6fca2fd6.patch";
 835     hash = "sha256-SEKe/8HcW0UBHCfPTTOnpRlzmV2nQPPeL6HOMxBZd14=";
 836   })
 837   ```
 838
 839 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.
 840
 841 Critical security fixes may by-pass the staging branches and be delivered directly to release branches such as `master` and `release-*`.
 842
 843 ### Vulnerability Roundup
 844
 845 #### Issues
 846
 847 Vulnerable packages in Nixpkgs are managed using issues.
 848 Currently opened ones can be found using the following:
 849
 850 [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)
 851
 852 Each issue correspond to a vulnerable version of a package; As a consequence:
 853
 854 - One issue can contain several CVEs;
 855 - One CVE can be shared across several issues;
 856 - A single package can be concerned by several issues.
 857
 858
 859 A "Vulnerability roundup" issue usually respects the following format:
 860
 861 ```txt
 862 <link to relevant package search on search.nix.gsc.io>, <link to relevant files in Nixpkgs on GitHub>
 863
 864 <list of related CVEs, their CVSS score, and the impacted NixOS version>
 865
 866 <list of the scanned Nixpkgs versions>
 867
 868 <list of relevant contributors>
 869 ```
 870
 871 Note that there can be an extra comment containing links to previously reported (and still open) issues for the same package.
 872
 873
 874 #### Triaging and Fixing
 875
 876 **Note**: An issue can be a "false positive" (i.e. automatically opened, but without the package it refers to being actually vulnerable).
 877 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.
 878
 879 If you are investigating a "true positive":
 880
 881 - Find the earliest patched version or a code patch in the CVE details;
 882 - Is the issue already patched (version up-to-date or patch applied manually) in Nixpkgs's `master` branch?
 883   - **No**:
 884     - [Submit a security fix][security-fixes];
 885     - Once the fix is merged into `master`, [submit the change to the vulnerable release branch(es)](../CONTRIBUTING.md#how-to-backport-pull-requests);
 886   - **Yes**: [Backport the change to the vulnerable release branch(es)](../CONTRIBUTING.md#how-to-backport-pull-requests).
 887 - When the patch has made it into all the relevant branches (`master`, and the vulnerable releases), close the relevant issue(s).