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