From 0fd55565d3204fbb152166c2186ba70f6cf38222 Mon Sep 17 00:00:00 2001 From: Bobby Rong Date: Fri, 23 Apr 2021 12:46:02 +0800 Subject: [PATCH] doc/contributing/*.xml: Convert to markdown --- .../coding-conventions.chapter.md | 514 ++++++++++ doc/contributing/coding-conventions.xml | 943 ------------------ .../contributing-to-documentation.chapter.md | 24 + .../contributing-to-documentation.xml | 30 - doc/contributing/quick-start.chapter.md | 77 ++ doc/contributing/quick-start.xml | 152 --- .../reviewing-contributions.chapter.md | 204 ++++ doc/contributing/reviewing-contributions.xml | 488 --------- doc/manual.xml | 8 +- 9 files changed, 823 insertions(+), 1617 deletions(-) create mode 100644 doc/contributing/coding-conventions.chapter.md delete mode 100644 doc/contributing/coding-conventions.xml create mode 100644 doc/contributing/contributing-to-documentation.chapter.md delete mode 100644 doc/contributing/contributing-to-documentation.xml create mode 100644 doc/contributing/quick-start.chapter.md delete mode 100644 doc/contributing/quick-start.xml create mode 100644 doc/contributing/reviewing-contributions.chapter.md delete mode 100644 doc/contributing/reviewing-contributions.xml diff --git a/doc/contributing/coding-conventions.chapter.md b/doc/contributing/coding-conventions.chapter.md new file mode 100644 index 000000000000..eccf4f7436ec --- /dev/null +++ b/doc/contributing/coding-conventions.chapter.md @@ -0,0 +1,514 @@ +# Coding conventions {#chap-conventions} + +## Syntax {#sec-syntax} + +- Use 2 spaces of indentation per indentation level in Nix expressions, 4 spaces in shell scripts. + +- Do not use tab characters, i.e. configure your editor to use soft tabs. For instance, use `(setq-default indent-tabs-mode nil)` in Emacs. Everybody has different tab settings so it’s asking for trouble. + +- Use `lowerCamelCase` for variable names, not `UpperCamelCase`. Note, this rule does not apply to package attribute names, which instead follow the rules in . + +- Function calls with attribute set arguments are written as + + ```nix + foo { + arg = ...; + } + ``` + + not + + ```nix + foo + { + arg = ...; + } + ``` + + Also fine is + + ```nix + foo { arg = ...; } + ``` + + if it's a short call. + +- In attribute sets or lists that span multiple lines, the attribute names or list elements should be aligned: + + ```nix + # A long list. + list = [ + elem1 + elem2 + elem3 + ]; + + # A long attribute set. + attrs = { + attr1 = short_expr; + attr2 = + if true then big_expr else big_expr; + }; + + # Combined + listOfAttrs = [ + { + attr1 = 3; + attr2 = "fff"; + } + { + attr1 = 5; + attr2 = "ggg"; + } + ]; + ``` + +- Short lists or attribute sets can be written on one line: + + ```nix + # A short list. + list = [ elem1 elem2 elem3 ]; + + # A short set. + attrs = { x = 1280; y = 1024; }; + ``` + +- Breaking in the middle of a function argument can give hard-to-read code, like + + ```nix + someFunction { x = 1280; + y = 1024; } otherArg + yetAnotherArg + ``` + + (especially if the argument is very large, spanning multiple lines). + + Better: + + ```nix + someFunction + { x = 1280; y = 1024; } + otherArg + yetAnotherArg + ``` + + or + + ```nix + let res = { x = 1280; y = 1024; }; + in someFunction res otherArg yetAnotherArg + ``` + +- The bodies of functions, asserts, and withs are not indented to prevent a lot of superfluous indentation levels, i.e. + + ```nix + { arg1, arg2 }: + assert system == "i686-linux"; + stdenv.mkDerivation { ... + ``` + + not + + ```nix + { arg1, arg2 }: + assert system == "i686-linux"; + stdenv.mkDerivation { ... + ``` + +- Function formal arguments are written as: + + ```nix + { arg1, arg2, arg3 }: + ``` + + but if they don't fit on one line they're written as: + + ```nix + { arg1, arg2, arg3 + , arg4, ... + , # Some comment... + argN + }: + ``` + +- Functions should list their expected arguments as precisely as possible. That is, write + + ```nix + { stdenv, fetchurl, perl }: ... + ``` + + instead of + + ```nix + args: with args; ... + ``` + + or + + ```nix + { stdenv, fetchurl, perl, ... }: ... + ``` + + For functions that are truly generic in the number of arguments (such as wrappers around `mkDerivation`) that have some required arguments, you should write them using an `@`-pattern: + + ```nix + { stdenv, doCoverageAnalysis ? false, ... } @ args: + + stdenv.mkDerivation (args // { + ... if doCoverageAnalysis then "bla" else "" ... + }) + ``` + + instead of + + ```nix + args: + + args.stdenv.mkDerivation (args // { + ... if args ? doCoverageAnalysis && args.doCoverageAnalysis then "bla" else "" ... + }) + ``` + +- Arguments should be listed in the order they are used, with the exception of `lib`, which always goes first. + +- Prefer using the top-level `lib` over its alias `stdenv.lib`. `lib` is unrelated to `stdenv`, and so `stdenv.lib` should only be used as a convenience alias when developing to avoid having to modify the function inputs just to test something out. + +## Package naming {#sec-package-naming} + +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. + +In Nixpkgs, there are generally three different names associated with a package: + +- The `name` attribute of the derivation (excluding the version part). This is what most users see, in particular when using `nix-env`. + +- 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`. + +- The filename for (the directory containing) the Nix expression. + +Most of the time, these are the same. For instance, the package `e2fsprogs` has a `name` attribute `"e2fsprogs-version"`, is bound to the variable name `e2fsprogs` in `all-packages.nix`, and the Nix expression is in `pkgs/os-specific/linux/e2fsprogs/default.nix`. + +There are a few naming guidelines: + +- The `name` attribute _should_ be identical to the upstream package name. + +- The `name` attribute _must not_ contain uppercase letters — e.g., `"mplayer-1.0rc2"` instead of `"MPlayer-1.0rc2"`. + +- The version part of the `name` attribute _must_ start with a digit (following a dash) — e.g., `"hello-0.3.1rc2"`. + +- If a package is not a release but a commit from a repository, then the version part of the name _must_ be the date of that (fetched) commit. The date _must_ be in `"YYYY-MM-DD"` format. Also append `"unstable"` to the name - e.g., `"pkgname-unstable-2014-09-23"`. + +- Dashes in the package name _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. + +- 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 + +## File naming and organisation {#sec-organisation} + +Names of files and directories should be in lowercase, with dashes between words — not in camel case. For instance, it should be `all-packages.nix`, not `allPackages.nix` or `AllPackages.nix`. + +### Hierarchy {#sec-hierarchy} + +Each package should be stored in its own directory somewhere in the `pkgs/` tree, i.e. in `pkgs/category/subcategory/.../pkgname`. Below are some rules for picking the right category for a package. Many packages fall under several categories; what matters is the _primary_ purpose of a package. 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`. + +When in doubt, consider refactoring the `pkgs/` tree, e.g. creating new categories or splitting up an existing category. + +**If it’s used to support _software development_:** + +- **If it’s a _library_ used by other packages:** + + - `development/libraries` (e.g. `libxml2`) + +- **If it’s a _compiler_:** + + - `development/compilers` (e.g. `gcc`) + +- **If it’s an _interpreter_:** + + - `development/interpreters` (e.g. `guile`) + +- **If it’s a (set of) development _tool(s)_:** + + - **If it’s a _parser generator_ (including lexers):** + + - `development/tools/parsing` (e.g. `bison`, `flex`) + + - **If it’s a _build manager_:** + + - `development/tools/build-managers` (e.g. `gnumake`) + + - **Else:** + + - `development/tools/misc` (e.g. `binutils`) + +- **Else:** + + - `development/misc` + +**If it’s a (set of) _tool(s)_:** + +(A tool is a relatively small program, especially one intended to be used non-interactively.) + +- **If it’s for _networking_:** + + - `tools/networking` (e.g. `wget`) + +- **If it’s for _text processing_:** + + - `tools/text` (e.g. `diffutils`) + +- **If it’s a _system utility_, i.e., something related or essential to the operation of a system:** + + - `tools/system` (e.g. `cron`) + +- **If it’s an _archiver_ (which may include a compression function):** + + - `tools/archivers` (e.g. `zip`, `tar`) + +- **If it’s a _compression_ program:** + + - `tools/compression` (e.g. `gzip`, `bzip2`) + +- **If it’s a _security_-related program:** + + - `tools/security` (e.g. `nmap`, `gnupg`) + +- **Else:** + + - `tools/misc` + +**If it’s a _shell_:** + +- `shells` (e.g. `bash`) + +**If it’s a _server_:** + +- **If it’s a web server:** + + - `servers/http` (e.g. `apache-httpd`) + +- **If it’s an implementation of the X Windowing System:** + + - `servers/x11` (e.g. `xorg` — this includes the client libraries and programs) + +- **Else:** + + - `servers/misc` + +**If it’s a _desktop environment_:** + +- `desktops` (e.g. `kde`, `gnome`, `enlightenment`) + +**If it’s a _window manager_:** + +- `applications/window-managers` (e.g. `awesome`, `stumpwm`) + +**If it’s an _application_:** + +A (typically large) program with a distinct user interface, primarily used interactively. + +- **If it’s a _version management system_:** + + - `applications/version-management` (e.g. `subversion`) + +- **If it’s a _terminal emulator_:** + + - `applications/terminal-emulators` (e.g. `alacritty` or `rxvt` or `termite`) + +- **If it’s for _video playback / editing_:** + + - `applications/video` (e.g. `vlc`) + +- **If it’s for _graphics viewing / editing_:** + + - `applications/graphics` (e.g. `gimp`) + +- **If it’s for _networking_:** + + - **If it’s a _mailreader_:** + + - `applications/networking/mailreaders` (e.g. `thunderbird`) + + - **If it’s a _newsreader_:** + + - `applications/networking/newsreaders` (e.g. `pan`) + + - **If it’s a _web browser_:** + + - `applications/networking/browsers` (e.g. `firefox`) + + - **Else:** + + - `applications/networking/misc` + +- **Else:** + + - `applications/misc` + +**If it’s _data_ (i.e., does not have a straight-forward executable semantics):** + +- **If it’s a _font_:** + + - `data/fonts` + +- **If it’s an _icon theme_:** + + - `data/icons` + +- **If it’s related to _SGML/XML processing_:** + + - **If it’s an _XML DTD_:** + + - `data/sgml+xml/schemas/xml-dtd` (e.g. `docbook`) + + - **If it’s an _XSLT stylesheet_:** + + (Okay, these are executable...) + + - `data/sgml+xml/stylesheets/xslt` (e.g. `docbook-xsl`) + +- **If it’s a _theme_ for a _desktop environment_, a _window manager_ or a _display manager_:** + + - `data/themes` + +**If it’s a _game_:** + +- `games` + +**Else:** + +- `misc` + +### Versioning {#sec-versioning} + +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. + +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`. + +All versions of a package _must_ be included in `all-packages.nix` to make sure that they evaluate correctly. + +## Fetching Sources {#sec-sources} + +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. + +You can find many source fetch helpers in `pkgs/build-support/fetch*`. + +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: + +- Bad: Uses `git://` which won't be proxied. + + ```nix + src = fetchgit { + url = "git://github.com/NixOS/nix.git"; + rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae"; + sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg"; + } + ``` + +- Better: This is ok, but an archive fetch will still be faster. + + ```nix + src = fetchgit { + url = "https://github.com/NixOS/nix.git"; + rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae"; + sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg"; + } + ``` + +- Best: Fetches a snapshot archive and you get the rev you want. + + ```nix + src = fetchFromGitHub { + owner = "NixOS"; + repo = "nix"; + rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae"; + sha256 = "1i2yxndxb6yc9l6c99pypbd92lfq5aac4klq7y2v93c9qvx2cgpc"; + } + ``` + + Find the value to put as `sha256` by running `nix run -f '' nix-prefetch-github -c nix-prefetch-github --rev 1f795f9f44607cc5bec70d1300150bfefcef2aae NixOS nix` or `nix-prefetch-url --unpack https://github.com/NixOS/nix/archive/1f795f9f44607cc5bec70d1300150bfefcef2aae.tar.gz`. + +## Obtaining source hash {#sec-source-hashes} + +Preferred source hash type is sha256. There are several ways to get it. + +1. Prefetch URL (with `nix-prefetch-XXX URL`, where `XXX` is one of `url`, `git`, `hg`, `cvs`, `bzr`, `svn`). Hash is printed to stdout. + +2. Prefetch by package source (with `nix-prefetch-url '' -A PACKAGE.src`, where `PACKAGE` is package attribute name). Hash is printed to stdout. + + 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). + +3. Upstream provided hash: use it when upstream provides `sha256` or `sha512` (when upstream provides `md5`, don't use it, compute `sha256` instead). + + 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. + + You can convert between formats with nix-hash, for example: + + ```ShellSession + $ nix-hash --type sha256 --to-base32 HASH + ``` + +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. + +5. Fake hash: set fake hash in package expression, perform build and extract correct hash from error Nix prints. + + For package updates it is enough to change one symbol to make hash fake. For new packages, you can use `lib.fakeSha256`, `lib.fakeSha512` or any other fake hash. + + 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. + +::: warning +This method has security problems. Check below for details. +::: + +### Obtaining hashes securely {#sec-source-hashes-security} + +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: + +- `http://` URLs are not secure to prefetch hash from; + +- hashes from upstream (in method 3) should be obtained via secure protocol; + +- `https://` URLs are secure in methods 1, 2, 3; + +- `https://` URLs are not secure in method 5. When obtaining hashes with fake hash method, TLS checks are disabled. So refetch source hash from several different networks to exclude MITM scenario. Alternatively, use fake hash method to make Nix error, but instead of extracting hash from error, extract `https://` URL and prefetch it with method 1. + +## Patches {#sec-patches} + +Patches available online should be retrieved using `fetchpatch`. + +```nix +patches = [ + (fetchpatch { + name = "fix-check-for-using-shared-freetype-lib.patch"; + url = "http://git.ghostscript.com/?p=ghostpdl.git;a=patch;h=8f5d285"; + sha256 = "1f0k043rng7f0rfl9hhb89qzvvksqmkrikmm38p61yfx51l325xr"; + }) +]; +``` + +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. + +```nix +patches = [ ./0001-changes.patch ]; +``` + +If you do need to do create this sort of patch file, one way to do so is with git: + +1. Move to the root directory of the source code you're patching. + + ```ShellSession + $ cd the/program/source + ``` + +2. If a git repository is not already present, create one and stage all of the source files. + + ```ShellSession + $ git init + $ git add . + ``` + +3. Edit some files to make whatever changes need to be included in the patch. + +4. Use git to create a diff, and pipe the output to a patch file: + + ```ShellSession + $ git diff > nixpkgs/pkgs/the/package/0001-changes.patch + ``` diff --git a/doc/contributing/coding-conventions.xml b/doc/contributing/coding-conventions.xml deleted file mode 100644 index 9f00942918c0..000000000000 --- a/doc/contributing/coding-conventions.xml +++ /dev/null @@ -1,943 +0,0 @@ - - Coding conventions -
- Syntax - - - - - Use 2 spaces of indentation per indentation level in Nix expressions, 4 spaces in shell scripts. - - - - - Do not use tab characters, i.e. configure your editor to use soft tabs. For instance, use (setq-default indent-tabs-mode nil) in Emacs. Everybody has different tab settings so it’s asking for trouble. - - - - - Use lowerCamelCase for variable names, not UpperCamelCase. Note, this rule does not apply to package attribute names, which instead follow the rules in . - - - - - Function calls with attribute set arguments are written as - -foo { - arg = ...; -} - - not - -foo -{ - arg = ...; -} - - Also fine is - -foo { arg = ...; } - - if it's a short call. - - - - - In attribute sets or lists that span multiple lines, the attribute names or list elements should be aligned: - -# A long list. -list = [ - elem1 - elem2 - elem3 -]; - -# A long attribute set. -attrs = { - attr1 = short_expr; - attr2 = - if true then big_expr else big_expr; -}; - -# Combined -listOfAttrs = [ - { - attr1 = 3; - attr2 = "fff"; - } - { - attr1 = 5; - attr2 = "ggg"; - } -]; - - - - - - Short lists or attribute sets can be written on one line: - -# A short list. -list = [ elem1 elem2 elem3 ]; - -# A short set. -attrs = { x = 1280; y = 1024; }; - - - - - - Breaking in the middle of a function argument can give hard-to-read code, like - -someFunction { x = 1280; - y = 1024; } otherArg - yetAnotherArg - - (especially if the argument is very large, spanning multiple lines). - - - Better: - -someFunction - { x = 1280; y = 1024; } - otherArg - yetAnotherArg - - or - -let res = { x = 1280; y = 1024; }; -in someFunction res otherArg yetAnotherArg - - - - - - The bodies of functions, asserts, and withs are not indented to prevent a lot of superfluous indentation levels, i.e. - -{ arg1, arg2 }: -assert system == "i686-linux"; -stdenv.mkDerivation { ... - - not - -{ arg1, arg2 }: - assert system == "i686-linux"; - stdenv.mkDerivation { ... - - - - - - Function formal arguments are written as: - -{ arg1, arg2, arg3 }: - - but if they don't fit on one line they're written as: - -{ arg1, arg2, arg3 -, arg4, ... -, # Some comment... - argN -}: - - - - - - Functions should list their expected arguments as precisely as possible. That is, write - -{ stdenv, fetchurl, perl }: ... - - instead of - -args: with args; ... - - or - -{ stdenv, fetchurl, perl, ... }: ... - - - - For functions that are truly generic in the number of arguments (such as wrappers around mkDerivation) that have some required arguments, you should write them using an @-pattern: - -{ stdenv, doCoverageAnalysis ? false, ... } @ args: - -stdenv.mkDerivation (args // { - ... if doCoverageAnalysis then "bla" else "" ... -}) - - instead of - -args: - -args.stdenv.mkDerivation (args // { - ... if args ? doCoverageAnalysis && args.doCoverageAnalysis then "bla" else "" ... -}) - - - - - - Arguments should be listed in the order they are used, with the exception of lib, which always goes first. - - - - - Prefer using the top-level lib over its alias stdenv.lib. lib is unrelated to stdenv, and so stdenv.lib should only be used as a convenience alias when developing to avoid having to modify the function inputs just to test something out. - - - -
-
- Package naming - - - 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. Only emphasized words are to be interpreted in this way. - - - - In Nixpkgs, there are generally three different names associated with a package: - - - - The name attribute of the derivation (excluding the version part). This is what most users see, in particular when using nix-env. - - - - - 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. - - - - - The filename for (the directory containing) the Nix expression. - - - - Most of the time, these are the same. For instance, the package e2fsprogs has a name attribute "e2fsprogs-version", is bound to the variable name e2fsprogs in all-packages.nix, and the Nix expression is in pkgs/os-specific/linux/e2fsprogs/default.nix. - - - - There are a few naming guidelines: - - - - The name attribute should be identical to the upstream package name. - - - - - The name attribute must not contain uppercase letters — e.g., "mplayer-1.0rc2" instead of "MPlayer-1.0rc2". - - - - - The version part of the name attribute must start with a digit (following a dash) — e.g., "hello-0.3.1rc2". - - - - - If a package is not a release but a commit from a repository, then the version part of the name must be the date of that (fetched) commit. The date must be in "YYYY-MM-DD" format. Also append "unstable" to the name - e.g., "pkgname-unstable-2014-09-23". - - - - - Dashes in the package name 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. - - - - - 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 - - - - -
-
- File naming and organisation - - - Names of files and directories should be in lowercase, with dashes between words — not in camel case. For instance, it should be all-packages.nix, not allPackages.nix or AllPackages.nix. - - -
- Hierarchy - - - Each package should be stored in its own directory somewhere in the pkgs/ tree, i.e. in pkgs/category/subcategory/.../pkgname. Below are some rules for picking the right category for a package. Many packages fall under several categories; what matters is the primary purpose of a package. 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. - - - - When in doubt, consider refactoring the pkgs/ tree, e.g. creating new categories or splitting up an existing category. - - - - - - If it’s used to support software development: - - - - - - If it’s a library used by other packages: - - - - development/libraries (e.g. libxml2) - - - - - - If it’s a compiler: - - - - development/compilers (e.g. gcc) - - - - - - If it’s an interpreter: - - - - development/interpreters (e.g. guile) - - - - - - If it’s a (set of) development tool(s): - - - - - - If it’s a parser generator (including lexers): - - - - development/tools/parsing (e.g. bison, flex) - - - - - - If it’s a build manager: - - - - development/tools/build-managers (e.g. gnumake) - - - - - - Else: - - - - development/tools/misc (e.g. binutils) - - - - - - - - - Else: - - - - development/misc - - - - - - - - - If it’s a (set of) tool(s): - - - - (A tool is a relatively small program, especially one intended to be used non-interactively.) - - - - - If it’s for networking: - - - - tools/networking (e.g. wget) - - - - - - If it’s for text processing: - - - - tools/text (e.g. diffutils) - - - - - - If it’s a system utility, i.e., something related or essential to the operation of a system: - - - - tools/system (e.g. cron) - - - - - - If it’s an archiver (which may include a compression function): - - - - tools/archivers (e.g. zip, tar) - - - - - - If it’s a compression program: - - - - tools/compression (e.g. gzip, bzip2) - - - - - - If it’s a security-related program: - - - - tools/security (e.g. nmap, gnupg) - - - - - - Else: - - - - tools/misc - - - - - - - - - If it’s a shell: - - - - shells (e.g. bash) - - - - - - If it’s a server: - - - - - - If it’s a web server: - - - - servers/http (e.g. apache-httpd) - - - - - - If it’s an implementation of the X Windowing System: - - - - servers/x11 (e.g. xorg — this includes the client libraries and programs) - - - - - - Else: - - - - servers/misc - - - - - - - - - If it’s a desktop environment: - - - - desktops (e.g. kde, gnome, enlightenment) - - - - - - If it’s a window manager: - - - - applications/window-managers (e.g. awesome, stumpwm) - - - - - - If it’s an application: - - - - A (typically large) program with a distinct user interface, primarily used interactively. - - - - - If it’s a version management system: - - - - applications/version-management (e.g. subversion) - - - - - - If it’s a terminal emulator: - - - - applications/terminal-emulators (e.g. alacritty or rxvt or termite) - - - - - - If it’s for video playback / editing: - - - - applications/video (e.g. vlc) - - - - - - If it’s for graphics viewing / editing: - - - - applications/graphics (e.g. gimp) - - - - - - If it’s for networking: - - - - - - If it’s a mailreader: - - - - applications/networking/mailreaders (e.g. thunderbird) - - - - - - If it’s a newsreader: - - - - applications/networking/newsreaders (e.g. pan) - - - - - - If it’s a web browser: - - - - applications/networking/browsers (e.g. firefox) - - - - - - Else: - - - - applications/networking/misc - - - - - - - - - Else: - - - - applications/misc - - - - - - - - - If it’s data (i.e., does not have a straight-forward executable semantics): - - - - - - If it’s a font: - - - - data/fonts - - - - - - If it’s an icon theme: - - - - data/icons - - - - - - If it’s related to SGML/XML processing: - - - - - - If it’s an XML DTD: - - - - data/sgml+xml/schemas/xml-dtd (e.g. docbook) - - - - - - If it’s an XSLT stylesheet: - - - - (Okay, these are executable...) - - - data/sgml+xml/stylesheets/xslt (e.g. docbook-xsl) - - - - - - - - - If it’s a theme for a desktop environment, a window manager or a display manager: - - - - data/themes - - - - - - - - - If it’s a game: - - - - games - - - - - - Else: - - - - misc - - - - -
- -
- Versioning - - - 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. - - - - 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. - - - - All versions of a package must be included in all-packages.nix to make sure that they evaluate correctly. - -
-
-
- Fetching Sources - - - 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. - - - - You can find many source fetch helpers in pkgs/build-support/fetch*. - - - - 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: - - - - Bad: Uses git:// which won't be proxied. - -src = fetchgit { - url = "git://github.com/NixOS/nix.git"; - rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae"; - sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg"; -} - - - - - - Better: This is ok, but an archive fetch will still be faster. - -src = fetchgit { - url = "https://github.com/NixOS/nix.git"; - rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae"; - sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg"; -} - - - - - - Best: Fetches a snapshot archive and you get the rev you want. - -src = fetchFromGitHub { - owner = "NixOS"; - repo = "nix"; - rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae"; - sha256 = "1i2yxndxb6yc9l6c99pypbd92lfq5aac4klq7y2v93c9qvx2cgpc"; -} - - Find the value to put as sha256 by running nix run -f '<nixpkgs>' nix-prefetch-github -c nix-prefetch-github --rev 1f795f9f44607cc5bec70d1300150bfefcef2aae NixOS nix or nix-prefetch-url --unpack https://github.com/NixOS/nix/archive/1f795f9f44607cc5bec70d1300150bfefcef2aae.tar.gz. - - - - -
-
- Obtaining source hash - - - Preferred source hash type is sha256. There are several ways to get it. - - - - - - Prefetch URL (with nix-prefetch-XXX URL, where XXX is one of url, git, hg, cvs, bzr, svn). Hash is printed to stdout. - - - - - Prefetch by package source (with nix-prefetch-url '<nixpkgs>' -A PACKAGE.src, where PACKAGE is package attribute name). Hash is printed to stdout. - - - 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). - - - - - Upstream provided hash: use it when upstream provides sha256 or sha512 (when upstream provides md5, don't use it, compute sha256 instead). - - - 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. - - - You can convert between formats with nix-hash, for example: - -$ nix-hash --type sha256 --to-base32 HASH - - - - - - Extracting hash from local source tarball can be done with sha256sum. Use nix-prefetch-url file:///path/to/tarball if you want base32 hash. - - - - - Fake hash: set fake hash in package expression, perform build and extract correct hash from error Nix prints. - - - For package updates it is enough to change one symbol to make hash fake. For new packages, you can use lib.fakeSha256, lib.fakeSha512 or any other fake hash. - - - 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). 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. - - - - This method has security problems. Check below for details. - - - - - -
- Obtaining hashes securely - - - 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: - - - - - - http:// URLs are not secure to prefetch hash from; - - - - - hashes from upstream (in method 3) should be obtained via secure protocol; - - - - - https:// URLs are secure in methods 1, 2, 3; - - - - - https:// URLs are not secure in method 5. When obtaining hashes with fake hash method, TLS checks are disabled. So refetch source hash from several different networks to exclude MITM scenario. Alternatively, use fake hash method to make Nix error, but instead of extracting hash from error, extract https:// URL and prefetch it with method 1. - - - -
-
-
- Patches - - - Patches available online should be retrieved using fetchpatch. - - - - -patches = [ - (fetchpatch { - name = "fix-check-for-using-shared-freetype-lib.patch"; - url = "http://git.ghostscript.com/?p=ghostpdl.git;a=patch;h=8f5d285"; - sha256 = "1f0k043rng7f0rfl9hhb89qzvvksqmkrikmm38p61yfx51l325xr"; - }) -]; - - - - - 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. - - - - -patches = [ ./0001-changes.patch ]; - - - - - If you do need to do create this sort of patch file, one way to do so is with git: - - - - Move to the root directory of the source code you're patching. - -$ cd the/program/source - - - - - If a git repository is not already present, create one and stage all of the source files. - -$ git init -$ git add . - - - - - Edit some files to make whatever changes need to be included in the patch. - - - - - Use git to create a diff, and pipe the output to a patch file: - -$ git diff > nixpkgs/pkgs/the/package/0001-changes.patch - - - - -
- diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md new file mode 100644 index 000000000000..642beba74d61 --- /dev/null +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -0,0 +1,24 @@ +# Contributing to this documentation {#chap-contributing} + +The DocBook sources of the Nixpkgs manual are in the [doc](https://github.com/NixOS/nixpkgs/tree/master/doc) subdirectory of the Nixpkgs repository. + +You can quickly check your edits with `make`: + +```ShellSession +$ cd /path/to/nixpkgs/doc +$ nix-shell +[nix-shell]$ make $makeFlags +``` + +If you experience problems, run `make debug` to help understand the docbook errors. + +After making modifications to the manual, it's important to build it before committing. You can do that as follows: + +```ShellSession +$ cd /path/to/nixpkgs/doc +$ nix-shell +[nix-shell]$ make clean +[nix-shell]$ nix-build . +``` + +If the build succeeds, the manual will be in `./result/share/doc/nixpkgs/manual.html`. diff --git a/doc/contributing/contributing-to-documentation.xml b/doc/contributing/contributing-to-documentation.xml deleted file mode 100644 index 132fa3816e37..000000000000 --- a/doc/contributing/contributing-to-documentation.xml +++ /dev/null @@ -1,30 +0,0 @@ - - Contributing to this documentation - - The DocBook sources of the Nixpkgs manual are in the doc subdirectory of the Nixpkgs repository. - - - You can quickly check your edits with make: - - -$ cd /path/to/nixpkgs/doc -$ nix-shell -[nix-shell]$ make $makeFlags - - - If you experience problems, run make debug to help understand the docbook errors. - - - After making modifications to the manual, it's important to build it before committing. You can do that as follows: - -$ cd /path/to/nixpkgs/doc -$ nix-shell -[nix-shell]$ make clean -[nix-shell]$ nix-build . - - If the build succeeds, the manual will be in ./result/share/doc/nixpkgs/manual.html. - - diff --git a/doc/contributing/quick-start.chapter.md b/doc/contributing/quick-start.chapter.md new file mode 100644 index 000000000000..85c3897221ee --- /dev/null +++ b/doc/contributing/quick-start.chapter.md @@ -0,0 +1,77 @@ +# Quick Start to Adding a Package {#chap-quick-start} + +To add a package to Nixpkgs: + +1. Checkout the Nixpkgs source tree: + + ```ShellSession + $ git clone https://github.com/NixOS/nixpkgs + $ cd nixpkgs + ``` + +2. Find a good place in the Nixpkgs tree to add the Nix expression for your package. For instance, a library package typically goes into `pkgs/development/libraries/pkgname`, while a web browser goes into `pkgs/applications/networking/browsers/pkgname`. See for some hints on the tree organisation. Create a directory for your package, e.g. + + ```ShellSession + $ mkdir pkgs/development/libraries/libfoo + ``` + +3. In the package directory, create 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. The expression should usually be called `default.nix`. + + ```ShellSession + $ emacs pkgs/development/libraries/libfoo/default.nix + $ git add pkgs/development/libraries/libfoo/default.nix + ``` + + You can have a look at the existing Nix expressions under `pkgs/` to see how it’s done. Here are some good ones: + + - GNU Hello: [`pkgs/applications/misc/hello/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/hello/default.nix). Trivial package, which specifies some `meta` attributes which is good practice. + + - GNU cpio: [`pkgs/tools/archivers/cpio/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/archivers/cpio/default.nix). Also a simple package. The generic builder in `stdenv` does everything for you. It has no dependencies beyond `stdenv`. + + - GNU Multiple Precision arithmetic library (GMP): [`pkgs/development/libraries/gmp/5.1.x.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/gmp/5.1.x.nix). Also done by the generic builder, but has a dependency on `m4`. + + - Pan, a GTK-based newsreader: [`pkgs/applications/networking/newsreaders/pan/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/newsreaders/pan/default.nix). Has an optional dependency on `gtkspell`, which is only built if `spellCheck` is `true`. + + - Apache HTTPD: [`pkgs/servers/http/apache-httpd/2.4.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/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. + + - Thunderbird: [`pkgs/applications/networking/mailreaders/thunderbird/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/mailreaders/thunderbird/default.nix). Lots of dependencies. + + - JDiskReport, a Java utility: [`pkgs/tools/misc/jdiskreport/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/default.nix). Nixpkgs doesn’t have a decent `stdenv` for Java yet so this is pretty ad-hoc. + + - XML::Simple, a Perl module: [`pkgs/top-level/perl-packages.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/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. + + - Adobe Reader: [`pkgs/applications/misc/adobe-reader/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/default.nix). Shows how binary-only packages can be supported. In particular the [builder](https://github.com/NixOS/nixpkgs/blob/master/pkgs/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. + + Some notes: + + - All [`meta`](#chap-meta) attributes are optional, but it’s still a good idea to provide at least the `description`, `homepage` and [`license`](#sec-meta-license). + + - 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. + + - A list of schemes for `mirror://` URLs can be found in [`pkgs/build-support/fetchurl/mirrors.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix). + + The exact syntax and semantics of the Nix expression language, including the built-in function, are described in the Nix manual in the [chapter on writing Nix expressions](https://hydra.nixos.org/job/nix/trunk/tarball/latest/download-by-type/doc/manual/#chap-writing-nix-expressions). + +4. Add a call to the function defined in the previous step to [`pkgs/top-level/all-packages.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/all-packages.nix) with some descriptive name for the variable, e.g. `libfoo`. + + ```ShellSession + $ emacs pkgs/top-level/all-packages.nix + ``` + + The attributes in that file are sorted by category (like “Development / Libraries”) that more-or-less correspond to the directory structure of Nixpkgs, and then by attribute name. + +5. To test whether the package builds, run the following command from the root of the nixpkgs source tree: + + ```ShellSession + $ nix-build -A libfoo + ``` + + where `libfoo` should be the variable name defined in the previous step. 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. + +6. If you want to install the package into your profile (optional), do + + ```ShellSession + $ nix-env -f . -iA libfoo + ``` + +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. diff --git a/doc/contributing/quick-start.xml b/doc/contributing/quick-start.xml deleted file mode 100644 index 09d60834ec29..000000000000 --- a/doc/contributing/quick-start.xml +++ /dev/null @@ -1,152 +0,0 @@ - - Quick Start to Adding a Package - - To add a package to Nixpkgs: - - - - Checkout the Nixpkgs source tree: - -$ git clone https://github.com/NixOS/nixpkgs -$ cd nixpkgs - - - - - Find a good place in the Nixpkgs tree to add the Nix expression for your package. For instance, a library package typically goes into pkgs/development/libraries/pkgname, while a web browser goes into pkgs/applications/networking/browsers/pkgname. See for some hints on the tree organisation. Create a directory for your package, e.g. - -$ mkdir pkgs/development/libraries/libfoo - - - - - In the package directory, create 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. The expression should usually be called default.nix. - -$ emacs pkgs/development/libraries/libfoo/default.nix -$ git add pkgs/development/libraries/libfoo/default.nix - - - You can have a look at the existing Nix expressions under pkgs/ to see how it’s done. Here are some good ones: - - - - GNU Hello: pkgs/applications/misc/hello/default.nix. Trivial package, which specifies some meta attributes which is good practice. - - - - - GNU cpio: pkgs/tools/archivers/cpio/default.nix. Also a simple package. The generic builder in stdenv does everything for you. It has no dependencies beyond stdenv. - - - - - GNU Multiple Precision arithmetic library (GMP): pkgs/development/libraries/gmp/5.1.x.nix. Also done by the generic builder, but has a dependency on m4. - - - - - Pan, a GTK-based newsreader: pkgs/applications/networking/newsreaders/pan/default.nix. Has an optional dependency on gtkspell, which is only built if spellCheck is true. - - - - - Apache HTTPD: pkgs/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. - - - - - Thunderbird: pkgs/applications/networking/mailreaders/thunderbird/default.nix. Lots of dependencies. - - - - - JDiskReport, a Java utility: pkgs/tools/misc/jdiskreport/default.nix. Nixpkgs doesn’t have a decent stdenv for Java yet so this is pretty ad-hoc. - - - - - XML::Simple, a Perl module: pkgs/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. - - - - - Adobe Reader: pkgs/applications/misc/adobe-reader/default.nix. Shows how binary-only packages can be supported. In particular the builder uses patchelf to set the RUNPATH and ELF interpreter of the executables so that the right libraries are found at runtime. - - - - - - Some notes: - - - - All meta attributes are optional, but it’s still a good idea to provide at least the description, homepage and license. - - - - - 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. - - - - - A list of schemes for mirror:// URLs can be found in pkgs/build-support/fetchurl/mirrors.nix. - - - - - - The exact syntax and semantics of the Nix expression language, including the built-in function, are described in the Nix manual in the chapter on writing Nix expressions. - - - - - Add a call to the function defined in the previous step to pkgs/top-level/all-packages.nix with some descriptive name for the variable, e.g. libfoo. - -$ emacs pkgs/top-level/all-packages.nix - - - The attributes in that file are sorted by category (like “Development / Libraries”) that more-or-less correspond to the directory structure of Nixpkgs, and then by attribute name. - - - - - To test whether the package builds, run the following command from the root of the nixpkgs source tree: - -$ nix-build -A libfoo - where libfoo should be the variable name defined in the previous step. You may want to add the flag 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. - - - - - If you want to install the package into your profile (optional), do - -$ nix-env -f . -iA libfoo - - - - - Optionally commit the new package and open a pull request to nixpkgs, or use the Patches category on Discourse for sending a patch without a GitHub account. - - - - - diff --git a/doc/contributing/reviewing-contributions.chapter.md b/doc/contributing/reviewing-contributions.chapter.md new file mode 100644 index 000000000000..0dfe22199c64 --- /dev/null +++ b/doc/contributing/reviewing-contributions.chapter.md @@ -0,0 +1,204 @@ +# Reviewing contributions {#chap-reviewing-contributions} + +::: warning +The following section is a draft, and the policy for reviewing is still being discussed in issues such as [#11166](https://github.com/NixOS/nixpkgs/issues/11166) and [#20836](https://github.com/NixOS/nixpkgs/issues/20836). +::: + +The Nixpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project. + +The high change rate of Nixpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the [most recently](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) and the [least recently](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc) updated pull requests. We highly encourage looking at [this list of ready to merge, unreviewed pull requests](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone). + +When reviewing a pull request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work. + +GitHub provides reactions as a simple and quick way to provide feedback to pull requests or any comments. The thumb-down reaction should be used with care and if possible accompanied with some explanation so the submitter has directions to improve their contribution. + +pull request reviews should include a list of what has been reviewed in a comment, so other reviewers and mergers can know the state of the review. + +All the review template samples provided in this section are generic and meant as examples. Their usage is optional and the reviewer is free to adapt them to their liking. + +## Package updates {#reviewing-contributions-package-updates} + +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. + +It can happen that non-trivial updates include patches or more complex changes. + +Reviewing process: + +- Ensure that the package versioning fits the guidelines. +- Ensure that the commit text fits the guidelines. +- Ensure that the package maintainers are notified. + - [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. +- Ensure that the meta field information is correct. + - License can change with version updates, so it should be checked to match the upstream license. + - 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. +- Ensure that the code contains no typos. +- Building the package locally. + - 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. + - 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. + ```ShellSession + $ git fetch origin nixos-unstable + $ git fetch origin pull/PRNUMBER/head + $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD + ``` + - The first command fetches the nixos-unstable branch. + - 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. + - The third command rebases the pull request changes to the nixos-unstable branch. + - 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. + ```ShellSession + $ nix-shell -p nixpkgs-review --run "nixpkgs-review pr PRNUMBER" + ``` +- Running every binary. + +Sample template for a package update review is provided below. + +```markdown +##### Reviewed points + +- [ ] package name fits guidelines +- [ ] package version fits guidelines +- [ ] package build on ARCHITECTURE +- [ ] executables tested on ARCHITECTURE +- [ ] all depending packages build + +##### Possible improvements + +##### Comments +``` + +## New packages {#reviewing-contributions-new-packages} + +New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package. + +Review process: + +- Ensure that the package versioning fits the guidelines. +- Ensure that the commit name fits the guidelines. +- Ensure that the meta fields contain correct information. + - License must match the upstream license. + - Platforms should be set (or the package will not get binary substitutes). + - Maintainers must be set. This can be the package submitter or a community member that accepts taking up maintainership of the package. +- Report detected typos. +- Ensure the package source: + - Uses mirror URLs when available. + - Uses the most appropriate functions (e.g. packages from GitHub should use `fetchFromGitHub`). +- Building the package locally. +- Running every binary. + +Sample template for a new package review is provided below. + +```markdown +##### Reviewed points + +- [ ] package path fits guidelines +- [ ] package name fits guidelines +- [ ] package version fits guidelines +- [ ] package build on ARCHITECTURE +- [ ] executables tested on ARCHITECTURE +- [ ] `meta.description` is set and fits guidelines +- [ ] `meta.license` fits upstream license +- [ ] `meta.platforms` is set +- [ ] `meta.maintainers` is set +- [ ] build time only dependencies are declared in `nativeBuildInputs` +- [ ] source is fetched using the appropriate function +- [ ] phases are respected +- [ ] patches that are remotely available are fetched with `fetchpatch` + +##### Possible improvements + +##### Comments +``` + +## Module updates {#reviewing-contributions-module-updates} + +Module updates are submissions changing modules in some ways. These often contains changes to the options or introduce new options. + +Reviewing process: + +- Ensure that the module maintainers are notified. + - [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. +- Ensure that the module tests, if any, are succeeding. +- Ensure that the introduced options are correct. + - Type should be appropriate (string related types differs in their merging capabilities, `optionSet` and `string` types are deprecated). + - Description, default and example should be provided. +- Ensure that option changes are backward compatible. + - `mkRenamedOptionModule` and `mkAliasOptionModule` functions provide way to make option changes backward compatible. +- Ensure that removed options are declared with `mkRemovedOptionModule` +- Ensure that changes that are not backward compatible are mentioned in release notes. +- Ensure that documentations affected by the change is updated. + +Sample template for a module update review is provided below. + +```markdown +##### Reviewed points + +- [ ] changes are backward compatible +- [ ] removed options are declared with `mkRemovedOptionModule` +- [ ] changes that are not backward compatible are documented in release notes +- [ ] module tests succeed on ARCHITECTURE +- [ ] options types are appropriate +- [ ] options description is set +- [ ] options example is provided +- [ ] documentation affected by the changes is updated + +##### Possible improvements + +##### Comments +``` + +## New modules {#reviewing-contributions-new-modules} + +New modules submissions introduce a new module to NixOS. + +Reviewing process: + +- Ensure that the module tests, if any, are succeeding. +- Ensure that the introduced options are correct. + - Type should be appropriate (string related types differs in their merging capabilities, `optionSet` and `string` types are deprecated). + - Description, default and example should be provided. +- Ensure that module `meta` field is present + - Maintainers should be declared in `meta.maintainers`. + - Module documentation should be declared with `meta.doc`. +- Ensure that the module respect other modules functionality. + - For example, enabling a module should not open firewall ports by default. + +Sample template for a new module review is provided below. + +```markdown +##### Reviewed points + +- [ ] module path fits the guidelines +- [ ] module tests succeed on ARCHITECTURE +- [ ] options have appropriate types +- [ ] options have default +- [ ] options have example +- [ ] options have descriptions +- [ ] No unneeded package is added to environment.systemPackages +- [ ] meta.maintainers is set +- [ ] module documentation is declared in meta.doc + +##### Possible improvements + +##### Comments +``` + +## Other submissions {#reviewing-contributions-other-submissions} + +Other type of submissions requires different reviewing steps. + +If you consider having enough knowledge and experience in a topic and would like to be a long-term reviewer for related submissions, please contact the current reviewers for that topic. They will give you information about the reviewing process. The main reviewers for a topic can be hard to find as there is no list, but checking past pull requests to see who reviewed or git-blaming the code to see who committed to that topic can give some hints. + +Container system, boot system and library changes are some examples of the pull requests fitting this category. + +## Merging pull requests {#reviewing-contributions--merging-pull-requests} + +It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests. + + + +Please see the discussion in [GitHub nixpkgs issue #50105](https://github.com/NixOS/nixpkgs/issues/50105) for information on how to proceed to be granted this level of access. + +In a case a contributor definitively leaves the Nix community, they should create an issue or post on [Discourse](https://discourse.nixos.org) with references of packages and modules they maintain so the maintainership can be taken over by other contributors. diff --git a/doc/contributing/reviewing-contributions.xml b/doc/contributing/reviewing-contributions.xml deleted file mode 100644 index 7f83834bd8ea..000000000000 --- a/doc/contributing/reviewing-contributions.xml +++ /dev/null @@ -1,488 +0,0 @@ - - Reviewing contributions - - - The following section is a draft, and the policy for reviewing is still being discussed in issues such as #11166 and #20836 . - - - - The Nixpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project. - - - The high change rate of Nixpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the most recently and the least recently updated pull requests. We highly encourage looking at this list of ready to merge, unreviewed pull requests. - - - When reviewing a pull request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work. - - - GitHub provides reactions as a simple and quick way to provide feedback to pull requests or any comments. The thumb-down reaction should be used with care and if possible accompanied with some explanation so the submitter has directions to improve their contribution. - - - pull request reviews should include a list of what has been reviewed in a comment, so other reviewers and mergers can know the state of the review. - - - All the review template samples provided in this section are generic and meant as examples. Their usage is optional and the reviewer is free to adapt them to their liking. - -
- Package updates - - - 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. - - - - It can happen that non-trivial updates include patches or more complex changes. - - - - Reviewing process: - - - - - - Ensure that the package versioning fits the guidelines. - - - - - Ensure that the commit text fits the guidelines. - - - - - Ensure that the package maintainers are notified. - - - - - CODEOWNERS will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers. - - - - - - - Ensure that the meta field information is correct. - - - - - License can change with version updates, so it should be checked to match the upstream license. - - - - - 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. - - - - - - - Ensure that the code contains no typos. - - - - - Building the package locally. - - - - - 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. - - - 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. - -$ git fetch origin nixos-unstable -$ git fetch origin pull/PRNUMBER/head -$ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD - - - - - Fetching the nixos-unstable branch. - - - - - Fetching 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. - - - - - Rebasing the pull request changes to the nixos-unstable branch. - - - - - - - - The 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. - - -$ nix-shell -p nixpkgs-review --run "nixpkgs-review pr PRNUMBER" - - - - - - - Running every binary. - - - - - - Sample template for a package update review - -##### Reviewed points - -- [ ] package name fits guidelines -- [ ] package version fits guidelines -- [ ] package build on ARCHITECTURE -- [ ] executables tested on ARCHITECTURE -- [ ] all depending packages build - -##### Possible improvements - -##### Comments - - - -
-
- New packages - - - New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package. - - - - Review process: - - - - - - Ensure that the package versioning fits the guidelines. - - - - - Ensure that the commit name fits the guidelines. - - - - - Ensure that the meta fields contain correct information. - - - - - License must match the upstream license. - - - - - Platforms should be set (or the package will not get binary substitutes). - - - - - Maintainers must be set. This can be the package submitter or a community member that accepts taking up maintainership of the package. - - - - - - - Report detected typos. - - - - - Ensure the package source: - - - - - Uses mirror URLs when available. - - - - - Uses the most appropriate functions (e.g. packages from GitHub should use fetchFromGitHub). - - - - - - - Building the package locally. - - - - - Running every binary. - - - - - - Sample template for a new package review - -##### Reviewed points - -- [ ] package path fits guidelines -- [ ] package name fits guidelines -- [ ] package version fits guidelines -- [ ] package build on ARCHITECTURE -- [ ] executables tested on ARCHITECTURE -- [ ] `meta.description` is set and fits guidelines -- [ ] `meta.license` fits upstream license -- [ ] `meta.platforms` is set -- [ ] `meta.maintainers` is set -- [ ] build time only dependencies are declared in `nativeBuildInputs` -- [ ] source is fetched using the appropriate function -- [ ] phases are respected -- [ ] patches that are remotely available are fetched with `fetchpatch` - -##### Possible improvements - -##### Comments - - - -
-
- Module updates - - - Module updates are submissions changing modules in some ways. These often contains changes to the options or introduce new options. - - - - Reviewing process - - - - - - Ensure that the module maintainers are notified. - - - - - CODEOWNERS will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers. - - - - - - - Ensure that the module tests, if any, are succeeding. - - - - - Ensure that the introduced options are correct. - - - - - Type should be appropriate (string related types differs in their merging capabilities, optionSet and string types are deprecated). - - - - - Description, default and example should be provided. - - - - - - - Ensure that option changes are backward compatible. - - - - - mkRenamedOptionModule and mkAliasOptionModule functions provide way to make option changes backward compatible. - - - - - - - Ensure that removed options are declared with mkRemovedOptionModule - - - - - Ensure that changes that are not backward compatible are mentioned in release notes. - - - - - Ensure that documentations affected by the change is updated. - - - - - - Sample template for a module update review - -##### Reviewed points - -- [ ] changes are backward compatible -- [ ] removed options are declared with `mkRemovedOptionModule` -- [ ] changes that are not backward compatible are documented in release notes -- [ ] module tests succeed on ARCHITECTURE -- [ ] options types are appropriate -- [ ] options description is set -- [ ] options example is provided -- [ ] documentation affected by the changes is updated - -##### Possible improvements - -##### Comments - - - -
-
- New modules - - - New modules submissions introduce a new module to NixOS. - - - - - - Ensure that the module tests, if any, are succeeding. - - - - - Ensure that the introduced options are correct. - - - - - Type should be appropriate (string related types differs in their merging capabilities, optionSet and string types are deprecated). - - - - - Description, default and example should be provided. - - - - - - - Ensure that module meta field is present - - - - - Maintainers should be declared in meta.maintainers. - - - - - Module documentation should be declared with meta.doc. - - - - - - - Ensure that the module respect other modules functionality. - - - - - For example, enabling a module should not open firewall ports by default. - - - - - - - - Sample template for a new module review - -##### Reviewed points - -- [ ] module path fits the guidelines -- [ ] module tests succeed on ARCHITECTURE -- [ ] options have appropriate types -- [ ] options have default -- [ ] options have example -- [ ] options have descriptions -- [ ] No unneeded package is added to environment.systemPackages -- [ ] meta.maintainers is set -- [ ] module documentation is declared in meta.doc - -##### Possible improvements - -##### Comments - - - -
-
- Other submissions - - - Other type of submissions requires different reviewing steps. - - - - If you consider having enough knowledge and experience in a topic and would like to be a long-term reviewer for related submissions, please contact the current reviewers for that topic. They will give you information about the reviewing process. The main reviewers for a topic can be hard to find as there is no list, but checking past pull requests to see who reviewed or git-blaming the code to see who committed to that topic can give some hints. - - - - Container system, boot system and library changes are some examples of the pull requests fitting this category. - -
-
- Merging pull requests - - - It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests. - - - - - - Please see the discussion in GitHub nixpkgs issue #50105 for information on how to proceed to be granted this level of access. - - - - In a case a contributor definitively leaves the Nix community, they should create an issue or post on Discourse with references of packages and modules they maintain so the maintainership can be taken over by other contributors. - -
- diff --git a/doc/manual.xml b/doc/manual.xml index 1c5a7bbcaa9e..6ea4addc361a 100644 --- a/doc/manual.xml +++ b/doc/manual.xml @@ -32,11 +32,11 @@ Contributing to Nixpkgs - - + + - - + +