git-subtree-dir: infra/libkookie/nixpkgs/stable git-subtree-split: 91903ceb294dbe63a696759bfba3d23ee667f2dcwip/nixpkgs-raku
commit
f07e96ade7
@ -0,0 +1,96 @@ |
||||
# EditorConfig configuration for nixpkgs |
||||
# https://EditorConfig.org |
||||
|
||||
# Top-most EditorConfig file |
||||
root = true |
||||
|
||||
# Unix-style newlines with a newline ending every file, utf-8 charset |
||||
[*] |
||||
end_of_line = lf |
||||
insert_final_newline = true |
||||
trim_trailing_whitespace = true |
||||
charset = utf-8 |
||||
|
||||
# Ignore diffs/patches |
||||
[*.{diff,patch}] |
||||
end_of_line = unset |
||||
insert_final_newline = unset |
||||
trim_trailing_whitespace = unset |
||||
|
||||
# see https://nixos.org/nixpkgs/manual/#chap-conventions |
||||
|
||||
# Match json/lockfiles/markdown/nix/perl/python/ruby/shell/docbook files, set indent to spaces |
||||
[*.{json,lock,md,nix,pl,pm,py,rb,sh,xml}] |
||||
indent_style = space |
||||
|
||||
# Match docbook files, set indent width of one |
||||
[*.xml] |
||||
indent_size = 1 |
||||
|
||||
# Match json/lockfiles/markdown/nix/ruby files, set indent width of two |
||||
[*.{json,lock,md,nix,rb}] |
||||
indent_size = 2 |
||||
|
||||
# Match perl/python/shell scripts, set indent width of four |
||||
[*.{pl,pm,py,sh}] |
||||
indent_size = 4 |
||||
|
||||
# Match gemfiles, set indent to spaces with width of two |
||||
[Gemfile] |
||||
indent_size = 2 |
||||
indent_style = space |
||||
|
||||
# Disable file types or individual files |
||||
# some of these files may be auto-generated and/or require significant changes |
||||
|
||||
[*.{c,h}] |
||||
insert_final_newline = unset |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[*.{asc,key,ovpn}] |
||||
insert_final_newline = unset |
||||
end_of_line = unset |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[*.lock] |
||||
indent_size = unset |
||||
|
||||
[eggs.nix] |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[nixos/modules/services/networking/ircd-hybrid/*.{conf,in}] |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[nixos/tests/systemd-networkd-vrf.nix] |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[pkgs/build-support/dotnetenv/Wrapper/**] |
||||
end_of_line = unset |
||||
indent_style = unset |
||||
insert_final_newline = unset |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[pkgs/build-support/upstream-updater/**] |
||||
indent_style = unset |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[pkgs/development/compilers/elm/registry.dat] |
||||
end_of_line = unset |
||||
insert_final_newline = unset |
||||
|
||||
[pkgs/development/haskell-modules/hackage-packages.nix] |
||||
indent_style = unset |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[pkgs/servers/dict/wordnet_structures.py] |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[pkgs/tools/misc/timidity/timidity.cfg] |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[pkgs/tools/security/enpass/data.json] |
||||
insert_final_newline = unset |
||||
trim_trailing_whitespace = unset |
||||
|
||||
[pkgs/top-level/emscripten-packages.nix] |
||||
trim_trailing_whitespace = unset |
||||
@ -0,0 +1,16 @@ |
||||
**/deps.nix linguist-generated |
||||
**/node-packages.nix linguist-generated |
||||
|
||||
pkgs/applications/editors/emacs-modes/*-generated.nix linguist-generated |
||||
pkgs/development/r-modules/*-packages.nix linguist-generated |
||||
pkgs/development/haskell-modules/hackage-packages.nix linguist-generated |
||||
pkgs/development/beam-modules/hex-packages.nix linguist-generated |
||||
|
||||
doc/** linguist-documentation |
||||
doc/default.nix linguist-documentation=false |
||||
|
||||
nixos/doc/** linguist-documentation |
||||
nixos/doc/default.nix linguist-documentation=false |
||||
|
||||
nixos/modules/module-list.nix merge=union |
||||
# pkgs/top-level/all-packages.nix merge=union |
||||
@ -0,0 +1,226 @@ |
||||
# CODEOWNERS file |
||||
# |
||||
# This file is used to describe who owns what in this repository. This file does not |
||||
# replace `meta.maintainers` but is instead used for other things than derivations |
||||
# and modules, like documentation, package sets, and other assets. |
||||
# |
||||
# For documentation on this file, see https://help.github.com/articles/about-codeowners/ |
||||
# Mentioned users will get code review requests. |
||||
|
||||
# This file |
||||
/.github/CODEOWNERS @edolstra |
||||
|
||||
# GitHub actions |
||||
/.github/workflows @NixOS/Security @Mic92 @zowoq |
||||
/.github/workflows/merge-staging @FRidh |
||||
|
||||
# EditorConfig |
||||
/.editorconfig @Mic92 @zowoq |
||||
|
||||
# Libraries |
||||
/lib @edolstra @nbp @infinisil |
||||
/lib/systems @nbp @ericson2314 @matthewbauer |
||||
/lib/generators.nix @edolstra @nbp @Profpatsch |
||||
/lib/cli.nix @edolstra @nbp @Profpatsch |
||||
/lib/debug.nix @edolstra @nbp @Profpatsch |
||||
/lib/asserts.nix @edolstra @nbp @Profpatsch |
||||
|
||||
# Nixpkgs Internals |
||||
/default.nix @nbp |
||||
/pkgs/top-level/default.nix @nbp @Ericson2314 |
||||
/pkgs/top-level/impure.nix @nbp @Ericson2314 |
||||
/pkgs/top-level/stage.nix @nbp @Ericson2314 @matthewbauer |
||||
/pkgs/top-level/splice.nix @Ericson2314 @matthewbauer |
||||
/pkgs/top-level/release-cross.nix @Ericson2314 @matthewbauer |
||||
/pkgs/stdenv/generic @Ericson2314 @matthewbauer |
||||
/pkgs/stdenv/cross @Ericson2314 @matthewbauer |
||||
/pkgs/build-support/cc-wrapper @Ericson2314 @orivej |
||||
/pkgs/build-support/bintools-wrapper @Ericson2314 @orivej |
||||
/pkgs/build-support/setup-hooks @Ericson2314 |
||||
/pkgs/build-support/setup-hooks/auto-patchelf.sh @aszlig |
||||
|
||||
# Nixpkgs build-support |
||||
/pkgs/build-support/writers @lassulus @Profpatsch |
||||
|
||||
# NixOS Internals |
||||
/nixos/default.nix @nbp @infinisil |
||||
/nixos/lib/from-env.nix @nbp @infinisil |
||||
/nixos/lib/eval-config.nix @nbp @infinisil |
||||
/nixos/doc/manual/configuration/abstractions.xml @nbp |
||||
/nixos/doc/manual/configuration/config-file.xml @nbp |
||||
/nixos/doc/manual/configuration/config-syntax.xml @nbp |
||||
/nixos/doc/manual/configuration/modularity.xml @nbp |
||||
/nixos/doc/manual/development/assertions.xml @nbp |
||||
/nixos/doc/manual/development/meta-attributes.xml @nbp |
||||
/nixos/doc/manual/development/option-declarations.xml @nbp |
||||
/nixos/doc/manual/development/option-def.xml @nbp |
||||
/nixos/doc/manual/development/option-types.xml @nbp |
||||
/nixos/doc/manual/development/replace-modules.xml @nbp |
||||
/nixos/doc/manual/development/writing-modules.xml @nbp |
||||
/nixos/doc/manual/man-nixos-option.xml @nbp |
||||
/nixos/modules/installer/tools/nixos-option.sh @nbp |
||||
|
||||
# NixOS integration test driver |
||||
/nixos/lib/test-driver @tfc |
||||
|
||||
# Updaters |
||||
## update.nix |
||||
/maintainers/scripts/update.nix @jtojnar |
||||
/maintainers/scripts/update.py @jtojnar |
||||
## common-updater-scripts |
||||
/pkgs/common-updater/scripts/update-source-version @jtojnar |
||||
|
||||
# Python-related code and docs |
||||
/maintainers/scripts/update-python-libraries @FRidh |
||||
/pkgs/top-level/python-packages.nix @FRidh @jonringer |
||||
/pkgs/development/interpreters/python @FRidh |
||||
/pkgs/development/python-modules @FRidh @jonringer |
||||
/doc/languages-frameworks/python.section.md @FRidh |
||||
/pkgs/development/tools/poetry2nix @adisbladis |
||||
|
||||
# Haskell |
||||
/doc/languages-frameworks/haskell.section.md @cdepillabout @sternenseemann @maralorn |
||||
/maintainers/scripts/haskell @cdepillabout @sternenseemann @maralorn |
||||
/pkgs/development/compilers/ghc @cdepillabout @sternenseemann @maralorn |
||||
/pkgs/development/haskell-modules @cdepillabout @sternenseemann @maralorn |
||||
/pkgs/test/haskell @cdepillabout @sternenseemann @maralorn |
||||
/pkgs/top-level/release-haskell.nix @cdepillabout @sternenseemann @maralorn |
||||
/pkgs/top-level/haskell-packages.nix @cdepillabout @sternenseemann @maralorn |
||||
|
||||
# Perl |
||||
/pkgs/development/interpreters/perl @volth @stigtsp |
||||
/pkgs/top-level/perl-packages.nix @volth @stigtsp |
||||
/pkgs/development/perl-modules @volth @stigtsp |
||||
|
||||
# R |
||||
/pkgs/applications/science/math/R @peti |
||||
/pkgs/development/r-modules @peti |
||||
|
||||
# Ruby |
||||
/pkgs/development/interpreters/ruby @marsam |
||||
/pkgs/development/ruby-modules @marsam |
||||
|
||||
# Rust |
||||
/pkgs/development/compilers/rust @Mic92 @LnL7 @zowoq |
||||
/pkgs/build-support/rust @andir @danieldk @zowoq |
||||
|
||||
# Darwin-related |
||||
/pkgs/stdenv/darwin @NixOS/darwin-maintainers |
||||
/pkgs/os-specific/darwin @NixOS/darwin-maintainers |
||||
|
||||
# C compilers |
||||
/pkgs/development/compilers/gcc @matthewbauer |
||||
/pkgs/development/compilers/llvm @matthewbauer |
||||
|
||||
# Compatibility stuff |
||||
/pkgs/top-level/unix-tools.nix @matthewbauer |
||||
/pkgs/development/tools/xcbuild @matthewbauer |
||||
|
||||
# Beam-related (Erlang, Elixir, LFE, etc) |
||||
/pkgs/development/beam-modules @gleber |
||||
/pkgs/development/interpreters/erlang @gleber |
||||
/pkgs/development/interpreters/lfe @gleber |
||||
/pkgs/development/interpreters/elixir @gleber |
||||
/pkgs/development/tools/build-managers/rebar @gleber |
||||
/pkgs/development/tools/build-managers/rebar3 @gleber |
||||
/pkgs/development/tools/erlang @gleber |
||||
|
||||
# Jetbrains |
||||
/pkgs/applications/editors/jetbrains @edwtjo |
||||
|
||||
# Licenses |
||||
/lib/licenses.nix @alyssais |
||||
|
||||
# Qt / KDE |
||||
/pkgs/applications/kde @ttuegel |
||||
/pkgs/desktops/plasma-5 @ttuegel |
||||
/pkgs/development/libraries/kde-frameworks @ttuegel |
||||
/pkgs/development/libraries/qt-5 @ttuegel |
||||
|
||||
# PostgreSQL and related stuff |
||||
/pkgs/servers/sql/postgresql @thoughtpolice @marsam |
||||
/nixos/modules/services/databases/postgresql.xml @thoughtpolice |
||||
/nixos/modules/services/databases/postgresql.nix @thoughtpolice |
||||
/nixos/tests/postgresql.nix @thoughtpolice |
||||
|
||||
# Hardened profile & related modules |
||||
/nixos/modules/profiles/hardened.nix @joachifm |
||||
/nixos/modules/security/hidepid.nix @joachifm |
||||
/nixos/modules/security/lock-kernel-modules.nix @joachifm |
||||
/nixos/modules/security/misc.nix @joachifm |
||||
/nixos/tests/hardened.nix @joachifm |
||||
/pkgs/os-specific/linux/kernel/hardened-config.nix @joachifm |
||||
|
||||
# Network Time Daemons |
||||
/pkgs/tools/networking/chrony @thoughtpolice |
||||
/pkgs/tools/networking/ntp @thoughtpolice |
||||
/pkgs/tools/networking/openntpd @thoughtpolice |
||||
/nixos/modules/services/networking/ntp @thoughtpolice |
||||
|
||||
# Dhall |
||||
/pkgs/development/dhall-modules @Gabriel439 @Profpatsch @ehmry |
||||
/pkgs/development/interpreters/dhall @Gabriel439 @Profpatsch @ehmry |
||||
|
||||
# Idris |
||||
/pkgs/development/idris-modules @Infinisil |
||||
|
||||
# Bazel |
||||
/pkgs/development/tools/build-managers/bazel @mboes @Profpatsch |
||||
|
||||
# NixOS modules for e-mail and dns services |
||||
/nixos/modules/services/mail/mailman.nix @peti |
||||
/nixos/modules/services/mail/postfix.nix @peti |
||||
/nixos/modules/services/networking/bind.nix @peti |
||||
/nixos/modules/services/mail/rspamd.nix @peti |
||||
|
||||
# Emacs |
||||
/pkgs/applications/editors/emacs-modes @adisbladis |
||||
/pkgs/applications/editors/emacs @adisbladis |
||||
/pkgs/top-level/emacs-packages.nix @adisbladis |
||||
|
||||
# Neovim |
||||
/pkgs/applications/editors/neovim @jonringer |
||||
/pkgs/applications/editors/neovim @teto |
||||
|
||||
# VimPlugins |
||||
/pkgs/misc/vim-plugins @jonringer @softinio |
||||
|
||||
# VsCode Extensions |
||||
/pkgs/misc/vscode-extensions @jonringer |
||||
|
||||
# Prometheus exporter modules and tests |
||||
/nixos/modules/services/monitoring/prometheus/exporters.nix @WilliButz |
||||
/nixos/modules/services/monitoring/prometheus/exporters.xml @WilliButz |
||||
/nixos/tests/prometheus-exporters.nix @WilliButz |
||||
|
||||
# PHP interpreter, packages, extensions, tests and documentation |
||||
/doc/languages-frameworks/php.section.md @NixOS/php |
||||
/nixos/tests/php @NixOS/php |
||||
/pkgs/build-support/build-pecl.nix @NixOS/php |
||||
/pkgs/development/interpreters/php @NixOS/php |
||||
/pkgs/development/php-packages @NixOS/php |
||||
/pkgs/top-level/php-packages.nix @NixOS/php |
||||
|
||||
# Podman, CRI-O modules and related |
||||
/nixos/modules/virtualisation/containers.nix @NixOS/podman @zowoq |
||||
/nixos/modules/virtualisation/cri-o.nix @NixOS/podman @zowoq |
||||
/nixos/modules/virtualisation/podman.nix @NixOS/podman @zowoq |
||||
/nixos/tests/cri-o.nix @NixOS/podman @zowoq |
||||
/nixos/tests/podman.nix @NixOS/podman @zowoq |
||||
|
||||
# Docker tools |
||||
/pkgs/build-support/docker @roberth @utdemir |
||||
/nixos/tests/docker-tools-overlay.nix @roberth |
||||
/nixos/tests/docker-tools.nix @roberth |
||||
/doc/builders/images/dockertools.xml @roberth |
||||
|
||||
# Blockchains |
||||
/pkgs/applications/blockchains @mmahut @RaghavSood |
||||
|
||||
# Go |
||||
/pkgs/development/compilers/go @kalbasit @Mic92 @zowoq |
||||
/pkgs/development/go-modules @kalbasit @Mic92 @zowoq |
||||
/pkgs/development/go-packages @kalbasit @Mic92 @zowoq |
||||
|
||||
# Cinnamon |
||||
/pkgs/desktops/cinnamon @mkg20001 |
||||
@ -0,0 +1,64 @@ |
||||
# How to contribute |
||||
|
||||
Note: contributing implies licensing those contributions |
||||
under the terms of [COPYING](../COPYING), which is an MIT-like license. |
||||
|
||||
## Opening issues |
||||
|
||||
* Make sure you have a [GitHub account](https://github.com/signup/free) |
||||
* Make sure there is no open issue on the topic |
||||
* [Submit a new issue](https://github.com/NixOS/nixpkgs/issues/new/choose) by choosing the kind of topic and fill out the template |
||||
|
||||
## Submitting changes |
||||
|
||||
* Format the commit messages in the following way: |
||||
|
||||
``` |
||||
(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc) |
||||
|
||||
(Motivation for change. Additional information.) |
||||
``` |
||||
|
||||
For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message). |
||||
|
||||
Examples: |
||||
|
||||
* nginx: init at 2.0.1 |
||||
* firefox: 54.0.1 -> 55.0 |
||||
* nixos/hydra: add bazBaz option |
||||
|
||||
Dual baz behavior is needed to do foo. |
||||
* nixos/nginx: refactor config generation |
||||
|
||||
The old config generation system used impure shell scripts and could break in specific circumstances (see #1234). |
||||
|
||||
* `meta.description` should: |
||||
* Be capitalized. |
||||
* Not start with the package name. |
||||
* Not have a period at the end. |
||||
* `meta.license` must be set and fit the upstream license. |
||||
* If there is no upstream license, `meta.license` should default to `lib.licenses.unfree`. |
||||
* `meta.maintainers` must be set. |
||||
|
||||
See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes) and on how to [submit changes to nixpkgs](https://nixos.org/nixpkgs/manual/#chap-submitting-changes). |
||||
|
||||
## Writing good commit messages |
||||
|
||||
In addition to writing properly formatted commit messages, it's important to include relevant information so other developers can later understand *why* a change was made. While this information usually can be found by digging code, mailing list/Discourse archives, pull request discussions or upstream changes, it may require a lot of work. |
||||
|
||||
For package version upgrades and such a one-line commit message is usually sufficient. |
||||
|
||||
## Backporting changes |
||||
|
||||
Follow these steps to backport a change into a release branch in compliance with the [commit policy](https://nixos.org/nixpkgs/manual/#submitting-changes-stable-release-branches). |
||||
|
||||
1. Take note of the commits in which the change was introduced into `master` branch. |
||||
2. Check out the target _release branch_, e.g. `release-20.09`. Do not use a _channel branch_ like `nixos-20.09` or `nixpkgs-20.09`. |
||||
3. Create a branch for your change, e.g. `git checkout -b backport`. |
||||
4. When the reason to backport is not obvious from the original commit message, use `git cherry-pick -xe <original commit>` and add a reason. Otherwise use `git cherry-pick -x <original commit>`. That's fine for minor version updates that only include security and bug fixes, commits that fixes an otherwise broken package or similar. Please also ensure the commits exists on the master branch; in the case of squashed or rebased merges, the commit hash will change and the new commits can be found in the merge message at the bottom of the master pull request. |
||||
5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-20.09`) as the target branch of the pull request, and link to the pull request in which the original change was comitted to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[20.09]`. |
||||
6. When the backport pull request is merged and you have the necessary privileges you can also replace the label `9.needs: port to stable` with `8.has: port to stable` on the original pull request. This way maintainers can keep track of missing backports easier. |
||||
|
||||
## Reviewing contributions |
||||
|
||||
See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions). |
||||
@ -0,0 +1,11 @@ |
||||
## Issue description |
||||
|
||||
|
||||
|
||||
### Steps to reproduce |
||||
|
||||
|
||||
|
||||
## Technical details |
||||
|
||||
Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result. |
||||
@ -0,0 +1,43 @@ |
||||
--- |
||||
name: Bug report |
||||
about: Create a report to help us improve |
||||
title: '' |
||||
labels: '0.kind: bug' |
||||
assignees: '' |
||||
|
||||
--- |
||||
|
||||
**Describe the bug** |
||||
A clear and concise description of what the bug is. |
||||
|
||||
**To Reproduce** |
||||
Steps to reproduce the behavior: |
||||
1. ... |
||||
2. ... |
||||
3. ... |
||||
|
||||
**Expected behavior** |
||||
A clear and concise description of what you expected to happen. |
||||
|
||||
**Screenshots** |
||||
If applicable, add screenshots to help explain your problem. |
||||
|
||||
**Additional context** |
||||
Add any other context about the problem here. |
||||
|
||||
**Notify maintainers** |
||||
<!-- |
||||
Please @ people who are in the `meta.maintainers` list of the offending package or module. |
||||
If in doubt, check `git blame` for whoever last touched something. |
||||
--> |
||||
|
||||
**Metadata** |
||||
Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result. |
||||
|
||||
Maintainer information: |
||||
```yaml |
||||
# a list of nixpkgs attributes affected by the problem |
||||
attribute: |
||||
# a list of nixos modules affected by the problem |
||||
module: |
||||
``` |
||||
@ -0,0 +1,48 @@ |
||||
--- |
||||
name: Out-of-date package reports |
||||
about: For packages that are out-of-date |
||||
title: '' |
||||
labels: '9.needs: package (update)' |
||||
assignees: '' |
||||
|
||||
--- |
||||
|
||||
|
||||
###### Checklist |
||||
|
||||
<!-- Note that these are hard requirements --> |
||||
|
||||
<!-- |
||||
You can use the "Go to file" functionality on github to find the package |
||||
Then you can go to the history for this package |
||||
Find the latest "package_name: old_version -> new_version" commit |
||||
The "new_version" is the the current version of the package |
||||
--> |
||||
- [ ] Checked the [nixpkgs master branch](https://github.com/NixOS/nixpkgs) |
||||
<!-- |
||||
Type the name of your package and try to find an open pull request for the package |
||||
If you find an open pull request, you can review it! |
||||
There's a high chance that you'll have the new version right away while helping the community! |
||||
--> |
||||
- [ ] Checked the [nixpkgs pull requests](https://github.com/NixOS/nixpkgs/pulls) |
||||
|
||||
###### Project name |
||||
`nix search` name: |
||||
<!-- |
||||
The current version can be found easily with the same process than above for checking the master branch |
||||
If an open PR is present for the package, take this version as the current one and link to the PR |
||||
--> |
||||
current version: |
||||
desired version: |
||||
|
||||
###### Notify maintainers |
||||
<!-- |
||||
Search your package here: https://search.nixos.org/packages?channel=unstable |
||||
If no maintainer is listed for your package, tag the person that last updated the package |
||||
--> |
||||
|
||||
maintainers: |
||||
|
||||
###### Note for maintainers |
||||
|
||||
Please tag this issue in your PR. |
||||
@ -0,0 +1,18 @@ |
||||
--- |
||||
name: Packaging requests |
||||
about: For packages that are missing |
||||
title: '' |
||||
labels: '0.kind: packaging request' |
||||
assignees: '' |
||||
|
||||
--- |
||||
|
||||
**Project description** |
||||
_describe the project a little_ |
||||
|
||||
**Metadata** |
||||
|
||||
* homepage URL: |
||||
* source URL: |
||||
* license: mit, bsd, gpl2+ , ... |
||||
* platforms: unix, linux, darwin, ... |
||||
@ -0,0 +1,27 @@ |
||||
<!-- |
||||
To help with the large amounts of pull requests, we would appreciate your |
||||
reviews of other pull requests, especially simple package updates. Just leave a |
||||
comment describing what you have tested in the relevant package/service. |
||||
Reviewing helps to reduce the average time-to-merge for everyone. |
||||
Thanks a lot if you do! |
||||
List of open PRs: https://github.com/NixOS/nixpkgs/pulls |
||||
Reviewing guidelines: https://nixos.org/manual/nixpkgs/unstable/#chap-reviewing-contributions |
||||
--> |
||||
|
||||
###### Motivation for this change |
||||
|
||||
|
||||
###### Things done |
||||
|
||||
<!-- Please check what applies. Note that these are not hard requirements but merely serve as information for reviewers. --> |
||||
|
||||
- [ ] Tested using sandboxing ([nix.useSandbox](https://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](https://nixos.org/nix/manual/#sec-conf-file) on non-NixOS linux) |
||||
- Built on platform(s) |
||||
- [ ] NixOS |
||||
- [ ] macOS |
||||
- [ ] other Linux distributions |
||||
- [ ] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests)) |
||||
- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review wip"` |
||||
- [ ] Tested execution of all binary files (usually in `./result/bin/`) |
||||
- [ ] Added a release notes entry if the change is major or breaking |
||||
- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md). |
||||
@ -0,0 +1,35 @@ |
||||
# Stale bot information |
||||
|
||||
- Thanks for your contribution! |
||||
- To remove the stale label, just leave a new comment. |
||||
- _How to find the right people to ping?_ → [`git blame`](https://git-scm.com/docs/git-blame) to the rescue! (or GitHub's history and blame buttons.) |
||||
- You can always ask for help on [our Discourse Forum](https://discourse.nixos.org/) or on the [#nixos IRC channel](https://webchat.freenode.net/#nixos). |
||||
|
||||
## Suggestions for PRs |
||||
|
||||
1. GitHub sometimes doesn't notify people who commented / reviewed a PR previously, when you (force) push commits. If you have addressed the reviews you can [officially ask for a review](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review) from those who commented to you or anyone else. |
||||
2. If it is unfinished but you plan to finish it, please mark it as a draft. |
||||
3. If you don't expect to work on it any time soon, closing it with a short comment may encourage someone else to pick up your work. |
||||
4. To get things rolling again, rebase the PR against the target branch and address valid comments. |
||||
5. If you need a review to move forward, ask in [the Discourse thread for PRs that need help](https://discourse.nixos.org/t/prs-in-distress/3604). |
||||
6. If all you need is a merge, check the git history to find and [request reviews](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review) from people who usually merge related contributions. |
||||
|
||||
## Suggestions for issues |
||||
|
||||
1. If it is resolved (either for you personally, or in general), please consider closing it. |
||||
2. If this might still be an issue, but you are not interested in promoting its resolution, please consider closing it while encouraging others to take over and reopen an issue if they care enough. |
||||
3. If you still have interest in resolving it, try to ping somebody who you believe might have an interest in the topic. Consider discussing the problem in [our Discourse Forum](https://discourse.nixos.org/). |
||||
4. As with all open source projects, your best option is to submit a Pull Request that addresses this issue. We :heart: this attitude! |
||||
|
||||
**Memorandum on closing issues** |
||||
|
||||
Don't be afraid to close an issue that holds valuable information. Closed issues stay in the system for people to search, read, cross-reference, or even reopen--nothing is lost! Closing obsolete issues is an important way to help maintainers focus their time and effort. |
||||
|
||||
## Useful GitHub search queries |
||||
|
||||
- [Open PRs with any stale-bot interaction](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+commenter%3Aapp%2Fstale+) |
||||
- [Open PRs with any stale-bot interaction and `2.status: stale`](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+commenter%3Aapp%2Fstale+label%3A%222.status%3A+stale%22) |
||||
- [Open PRs with any stale-bot interaction and NOT `2.status: stale`](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+commenter%3Aapp%2Fstale+-label%3A%222.status%3A+stale%22+) |
||||
- [Open Issues with any stale-bot interaction](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+commenter%3Aapp%2Fstale+) |
||||
- [Open Issues with any stale-bot interaction and `2.status: stale`](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+commenter%3Aapp%2Fstale+label%3A%222.status%3A+stale%22+) |
||||
- [Open Issues with any stale-bot interaction and NOT `2.status: stale`](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+commenter%3Aapp%2Fstale+-label%3A%222.status%3A+stale%22+) |
||||
@ -0,0 +1,154 @@ |
||||
"6.topic: agda": |
||||
- doc/languages-frameworks/agda.section.md |
||||
- nixos/tests/agda.nix |
||||
- pkgs/build-support/agda/**/* |
||||
- pkgs/development/libraries/agda/**/* |
||||
- pkgs/top-level/agda-packages.nix |
||||
|
||||
"6.topic: bsd": |
||||
- pkgs/os-specific/bsd/**/* |
||||
- pkgs/stdenv/freebsd/**/* |
||||
|
||||
"6.topic: cinnamon": |
||||
- pkgs/desktops/cinnamon/**/* |
||||
|
||||
"6.topic: emacs": |
||||
- nixos/modules/services/editors/emacs.nix |
||||
- nixos/modules/services/editors/emacs.xml |
||||
- nixos/tests/emacs-daemon.nix |
||||
- pkgs/applications/editors/emacs-modes/**/* |
||||
- pkgs/applications/editors/emacs/**/* |
||||
- pkgs/build-support/emacs/**/* |
||||
- pkgs/top-level/emacs-packages.nix |
||||
|
||||
"6.topic: erlang": |
||||
- doc/languages-frameworks/beam.section.md |
||||
- pkgs/development/beam-modules/**/* |
||||
- pkgs/development/interpreters/elixir/**/* |
||||
- pkgs/development/interpreters/erlang/**/* |
||||
- pkgs/development/tools/build-managers/rebar/**/* |
||||
- pkgs/development/tools/build-managers/rebar3/**/* |
||||
- pkgs/development/tools/erlang/**/* |
||||
- pkgs/top-level/beam-packages.nix |
||||
|
||||
"6.topic: fetch": |
||||
- pkgs/build-support/fetch*/**/* |
||||
|
||||
"6.topic: GNOME": |
||||
- doc/languages-frameworks/gnome.section.md |
||||
- nixos/modules/services/desktops/gnome/**/* |
||||
- nixos/modules/services/x11/desktop-managers/gnome.nix |
||||
- nixos/tests/gnome-xorg.nix |
||||
- nixos/tests/gnome.nix |
||||
- pkgs/desktops/gnome/**/* |
||||
|
||||
"6.topic: golang": |
||||
- doc/languages-frameworks/go.section.md |
||||
- pkgs/development/compilers/go/**/* |
||||
- pkgs/development/go-modules/**/* |
||||
- pkgs/development/go-packages/**/* |
||||
|
||||
"6.topic: haskell": |
||||
- doc/languages-frameworks/haskell.section.md |
||||
- maintainers/scripts/haskell/**/* |
||||
- pkgs/development/compilers/ghc/**/* |
||||
- pkgs/development/haskell-modules/**/* |
||||
- pkgs/development/tools/haskell/**/* |
||||
- pkgs/test/haskell/**/* |
||||
- pkgs/top-level/haskell-packages.nix |
||||
- pkgs/top-level/release-haskell.nix |
||||
|
||||
"6.topic: kernel": |
||||
- pkgs/build-support/kernel/**/* |
||||
- pkgs/os-specific/linux/kernel/**/* |
||||
|
||||
"6.topic: lua": |
||||
- pkgs/development/interpreters/lua-5/**/* |
||||
- pkgs/development/interpreters/luajit/**/* |
||||
- pkgs/development/lua-modules/**/* |
||||
- pkgs/top-level/lua-packages.nix |
||||
|
||||
"6.topic: nixos": |
||||
- nixos/**/* |
||||
|
||||
"6.topic: ocaml": |
||||
- doc/languages-frameworks/ocaml.section.md |
||||
- pkgs/development/compilers/ocaml/**/* |
||||
- pkgs/development/compilers/reason/**/* |
||||
- pkgs/development/ocaml-modules/**/* |
||||
- pkgs/development/tools/ocaml/**/* |
||||
- pkgs/top-level/ocaml-packages.nix |
||||
|
||||
"6.topic: pantheon": |
||||
- nixos/modules/services/desktops/pantheon/**/* |
||||
- nixos/modules/services/x11/desktop-managers/pantheon.nix |
||||
- nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix |
||||
- nixos/tests/pantheon.nix |
||||
- pkgs/desktops/pantheon/**/* |
||||
|
||||
"6.topic: policy discussion": |
||||
- .github/**/* |
||||
|
||||
"6.topic: printing": |
||||
- nixos/modules/services/printing/cupsd.nix |
||||
- pkgs/misc/cups/**/* |
||||
|
||||
"6.topic: python": |
||||
- doc/languages-frameworks/python.section.md |
||||
- pkgs/development/interpreters/python/**/* |
||||
- pkgs/development/python-modules/**/* |
||||
- pkgs/top-level/python-packages.nix |
||||
|
||||
"6.topic: qt/kde": |
||||
- doc/languages-frameworks/qt.section.md |
||||
- nixos/modules/services/x11/desktop-managers/plasma5.nix |
||||
- nixos/tests/plasma5.nix |
||||
- pkgs/applications/kde/**/* |
||||
- pkgs/desktops/plasma-5/**/* |
||||
- pkgs/development/libraries/kde-frameworks/**/* |
||||
- pkgs/development/libraries/qt-5/**/* |
||||
|
||||
"6.topic: ruby": |
||||
- doc/languages-frameworks/ruby.section.md |
||||
- pkgs/development/interpreters/ruby/**/* |
||||
- pkgs/development/ruby-modules/**/* |
||||
|
||||
"6.topic: rust": |
||||
- doc/languages-frameworks/rust.section.md |
||||
- pkgs/build-support/rust/**/* |
||||
- pkgs/development/compilers/rust/**/* |
||||
|
||||
"6.topic: stdenv": |
||||
- pkgs/stdenv/**/* |
||||
|
||||
"6.topic: steam": |
||||
- pkgs/games/steam/**/* |
||||
|
||||
"6.topic: systemd": |
||||
- pkgs/os-specific/linux/systemd/**/* |
||||
- nixos/modules/system/boot/systemd*/**/* |
||||
|
||||
"6.topic: TeX": |
||||
- doc/languages-frameworks/texlive.section.md |
||||
- pkgs/tools/typesetting/tex/**/* |
||||
|
||||
"6.topic: vim": |
||||
- doc/languages-frameworks/vim.section.md |
||||
- pkgs/applications/editors/vim/**/* |
||||
- pkgs/misc/vim-plugins/**/* |
||||
|
||||
"6.topic: xfce": |
||||
- nixos/doc/manual/configuration/xfce.xml |
||||
- nixos/modules/services/x11/desktop-managers/xfce.nix |
||||
- nixos/tests/xfce.nix |
||||
- pkgs/desktops/xfce/**/* |
||||
|
||||
"8.has: changelog": |
||||
- nixos/doc/manual/release-notes/**/* |
||||
|
||||
"8.has: documentation": |
||||
- doc/**/* |
||||
- nixos/doc/**/* |
||||
|
||||
"8.has: module (update)": |
||||
- nixos/modules/**/* |
||||
@ -0,0 +1,10 @@ |
||||
# Configuration for probot-stale - https://github.com/probot/stale |
||||
daysUntilStale: 180 |
||||
daysUntilClose: false |
||||
exemptLabels: |
||||
- "1.severity: security" |
||||
- "2.status: never-stale" |
||||
staleLabel: "2.status: stale" |
||||
markComment: | |
||||
I marked this as stale due to inactivity. → [More info](https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md) |
||||
closeComment: false |
||||
@ -0,0 +1,29 @@ |
||||
name: "Direct Push Warning" |
||||
on: |
||||
push: |
||||
branches: |
||||
- master |
||||
- release-** |
||||
jobs: |
||||
build: |
||||
runs-on: ubuntu-latest |
||||
if: github.repository_owner == 'NixOS' |
||||
env: |
||||
GITHUB_SHA: ${{ github.sha }} |
||||
GITHUB_REPOSITORY: ${{ github.repository }} |
||||
steps: |
||||
- name: Check if commit is a merge commit |
||||
id: ismerge |
||||
run: | |
||||
ISMERGE=$(curl -H 'Accept: application/vnd.github.groot-preview+json' -H "authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" https://api.github.com/repos/${{ env.GITHUB_REPOSITORY }}/commits/${{ env.GITHUB_SHA }}/pulls | jq -r '.[] | select(.merge_commit_sha == "${{ env.GITHUB_SHA }}") | any') |
||||
echo "::set-output name=ismerge::$ISMERGE" |
||||
- name: Warn if the commit was a direct push |
||||
if: steps.ismerge.outputs.ismerge != 'true' |
||||
uses: peter-evans/commit-comment@v1 |
||||
with: |
||||
body: | |
||||
@${{ github.actor }}, you pushed a commit directly to master/release branch |
||||
instead of going through a Pull Request. |
||||
|
||||
That's highly discouraged beyond the few exceptions listed |
||||
on https://github.com/NixOS/nixpkgs/issues/118661 |
||||
@ -0,0 +1,46 @@ |
||||
name: "Checking EditorConfig" |
||||
|
||||
permissions: read-all |
||||
|
||||
on: |
||||
# avoids approving first time contributors |
||||
pull_request_target: |
||||
branches-ignore: |
||||
- 'release-**' |
||||
|
||||
jobs: |
||||
tests: |
||||
runs-on: ubuntu-latest |
||||
if: github.repository_owner == 'NixOS' |
||||
steps: |
||||
- name: Get list of changed files from PR |
||||
env: |
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
||||
run: | |
||||
echo 'PR_DIFF<<EOF' >> $GITHUB_ENV |
||||
gh api \ |
||||
repos/NixOS/nixpkgs/pulls/${{github.event.number}}/files --paginate \ |
||||
| jq '.[] | select(.status != "removed") | .filename' \ |
||||
>> $GITHUB_ENV |
||||
echo 'EOF' >> $GITHUB_ENV |
||||
- uses: actions/checkout@v2 |
||||
with: |
||||
# pull_request_target checks out the base branch by default |
||||
ref: refs/pull/${{ github.event.pull_request.number }}/merge |
||||
if: env.PR_DIFF |
||||
- uses: cachix/install-nix-action@v13 |
||||
if: env.PR_DIFF |
||||
with: |
||||
# nixpkgs commit is pinned so that it doesn't break |
||||
nix_path: nixpkgs=https://github.com/NixOS/nixpkgs/archive/f93ecc4f6bc60414d8b73dbdf615ceb6a2c604df.tar.gz |
||||
- name: install editorconfig-checker |
||||
run: nix-env -iA editorconfig-checker -f '<nixpkgs>' |
||||
if: env.PR_DIFF |
||||
- name: Checking EditorConfig |
||||
if: env.PR_DIFF |
||||
run: | |
||||
echo "$PR_DIFF" | xargs editorconfig-checker -disable-indent-size |
||||
- if: ${{ failure() }} |
||||
run: | |
||||
echo "::error :: Hey! It looks like your changes don't follow our editorconfig settings. Read https://editorconfig.org/#download to configure your editor so you never see this error again." |
||||
|
||||
@ -0,0 +1,19 @@ |
||||
name: "Label PR" |
||||
|
||||
on: |
||||
pull_request_target: |
||||
types: [edited, opened, synchronize, reopened] |
||||
|
||||
permissions: |
||||
contents: read |
||||
pull-requests: write |
||||
|
||||
jobs: |
||||
labels: |
||||
runs-on: ubuntu-latest |
||||
if: github.repository_owner == 'NixOS' |
||||
steps: |
||||
- uses: actions/labeler@v3 |
||||
with: |
||||
repo-token: ${{ secrets.GITHUB_TOKEN }} |
||||
sync-labels: true |
||||
@ -0,0 +1,30 @@ |
||||
name: "Build NixOS manual" |
||||
|
||||
permissions: read-all |
||||
|
||||
on: |
||||
pull_request_target: |
||||
branches: |
||||
- master |
||||
paths: |
||||
- 'nixos/**' |
||||
|
||||
jobs: |
||||
nixos: |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/checkout@v2 |
||||
with: |
||||
# pull_request_target checks out the base branch by default |
||||
ref: refs/pull/${{ github.event.pull_request.number }}/merge |
||||
- uses: cachix/install-nix-action@v13 |
||||
with: |
||||
# explicitly enable sandbox |
||||
extra_nix_config: sandbox = true |
||||
- uses: cachix/cachix-action@v9 |
||||
with: |
||||
# This cache is for the nixos/nixpkgs manual builds and should not be trusted or used elsewhere. |
||||
name: nixpkgs-ci |
||||
signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}' |
||||
- name: Building NixOS manual |
||||
run: NIX_PATH=nixpkgs=$(pwd) nix-build --option restrict-eval true nixos/release.nix -A manual.x86_64-linux |
||||
@ -0,0 +1,30 @@ |
||||
name: "Build Nixpkgs manual" |
||||
|
||||
permissions: read-all |
||||
|
||||
on: |
||||
pull_request_target: |
||||
branches: |
||||
- master |
||||
paths: |
||||
- 'doc/**' |
||||
|
||||
jobs: |
||||
nixpkgs: |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/checkout@v2 |
||||
with: |
||||
# pull_request_target checks out the base branch by default |
||||
ref: refs/pull/${{ github.event.pull_request.number }}/merge |
||||
- uses: cachix/install-nix-action@v13 |
||||
with: |
||||
# explicitly enable sandbox |
||||
extra_nix_config: sandbox = true |
||||
- uses: cachix/cachix-action@v9 |
||||
with: |
||||
# This cache is for the nixos/nixpkgs manual builds and should not be trusted or used elsewhere. |
||||
name: nixpkgs-ci |
||||
signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}' |
||||
- name: Building Nixpkgs manual |
||||
run: NIX_PATH=nixpkgs=$(pwd) nix-build --option restrict-eval true pkgs/top-level/release.nix -A manual |
||||
@ -0,0 +1,41 @@ |
||||
name: "merge staging(-next)" |
||||
|
||||
on: |
||||
schedule: |
||||
# * is a special character in YAML so you have to quote this string |
||||
# Merge every 6 hours |
||||
- cron: '0 */6 * * *' |
||||
|
||||
jobs: |
||||
sync-branch: |
||||
if: github.repository == 'NixOS/nixpkgs' |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/checkout@v2 |
||||
|
||||
- name: Merge master into staging-next |
||||
id: staging_next |
||||
uses: devmasx/merge-branch@v1.3.1 |
||||
with: |
||||
type: now |
||||
from_branch: master |
||||
target_branch: staging-next |
||||
github_token: ${{ secrets.GITHUB_TOKEN }} |
||||
|
||||
- name: Merge staging-next into staging |
||||
id: staging |
||||
uses: devmasx/merge-branch@v1.3.1 |
||||
with: |
||||
type: now |
||||
from_branch: staging-next |
||||
target_branch: staging |
||||
github_token: ${{ secrets.GITHUB_TOKEN }} |
||||
|
||||
- name: Comment on failure |
||||
uses: peter-evans/create-or-update-comment@v1 |
||||
if: ${{ failure() }} |
||||
with: |
||||
issue-number: 105153 |
||||
body: | |
||||
An automatic merge${{ (steps.staging_next.outcome == 'failure' && ' from master to staging-next') || ((steps.staging.outcome == 'failure' && ' from staging-next to staging') || '') }} [failed](https://github.com/NixOS/nixpkgs/actions/runs/${{ github.run_id }}). |
||||
|
||||
@ -0,0 +1,21 @@ |
||||
name: "clear pending status" |
||||
|
||||
on: |
||||
check_suite: |
||||
types: [ completed ] |
||||
|
||||
jobs: |
||||
action: |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- name: clear pending status |
||||
if: github.repository_owner == 'NixOS' && github.event.check_suite.app.name == 'OfBorg' |
||||
env: |
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
||||
run: | |
||||
curl \ |
||||
-X POST \ |
||||
-H "Accept: application/vnd.github.v3+json" \ |
||||
-H "Authorization: token $GITHUB_TOKEN" \ |
||||
-d '{"state": "success", "target_url": " ", "description": " ", "context": "Wait for ofborg"}' \ |
||||
"https://api.github.com/repos/NixOS/nixpkgs/statuses/${{ github.event.check_suite.head_sha }}" |
||||
@ -0,0 +1,20 @@ |
||||
name: "set pending status" |
||||
|
||||
on: |
||||
pull_request_target: |
||||
|
||||
jobs: |
||||
action: |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- name: set pending status |
||||
if: github.repository_owner == 'NixOS' |
||||
env: |
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
||||
run: | |
||||
curl \ |
||||
-X POST \ |
||||
-H "Accept: application/vnd.github.v3+json" \ |
||||
-H "Authorization: token $GITHUB_TOKEN" \ |
||||
-d '{"state": "pending", "target_url": " ", "description": "This pending status will be cleared when ofborg starts eval.", "context": "Wait for ofborg"}' \ |
||||
"https://api.github.com/repos/NixOS/nixpkgs/statuses/${{ github.event.pull_request.head.sha }}" |
||||
@ -0,0 +1,134 @@ |
||||
on: |
||||
issue_comment: |
||||
types: |
||||
- created |
||||
|
||||
# This action allows people with write access to the repo to rebase a PRs base branch |
||||
# by commenting `/rebase ${branch}` on the PR while avoiding CODEOWNER notifications. |
||||
|
||||
jobs: |
||||
rebase: |
||||
runs-on: ubuntu-latest |
||||
if: github.repository_owner == 'NixOS' && github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase') |
||||
steps: |
||||
- uses: peter-evans/create-or-update-comment@v1 |
||||
with: |
||||
comment-id: ${{ github.event.comment.id }} |
||||
reactions: eyes |
||||
- uses: scherermichael-oss/action-has-permission@1.0.6 |
||||
id: check-write-access |
||||
with: |
||||
required-permission: write |
||||
env: |
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
||||
- name: check permissions |
||||
run: | |
||||
echo "Commenter doesn't have write access to the repo" |
||||
exit 1 |
||||
if: "! steps.check-write-access.outputs.has-permission" |
||||
- name: setup |
||||
run: | |
||||
curl "https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.issue.number }}" 2>/dev/null >pr.json |
||||
cat <<EOF >>"$GITHUB_ENV" |
||||
CAN_MODIFY=$(jq -r '.maintainer_can_modify' pr.json) |
||||
COMMITS=$(jq -r '.commits' pr.json) |
||||
CURRENT_BASE=$(jq -r '.base.ref' pr.json) |
||||
PR_BRANCH=$(jq -r '.head.ref' pr.json) |
||||
COMMENT_BRANCH=$(echo ${{ github.event.comment.body }} | awk "/^\/rebase / {print \$2}") |
||||
PULL_REQUEST=${{ github.event.issue.number }} |
||||
EOF |
||||
rm pr.json |
||||
- name: check branch |
||||
env: |
||||
PERMANENT_BRANCHES: "haskell-updates|master|nixos|nixpkgs|python-unstable|release|staging" |
||||
VALID_BRANCHES: "haskell-updates|master|python-unstable|release-20.09|staging|staging-20.09|staging-next" |
||||
run: | |
||||
message() { |
||||
cat <<EOF |
||||
Can't rebase $PR_BRANCH from $CURRENT_BASE onto $COMMENT_BRANCH (PR:$PULL_REQUEST COMMITS:$COMMITS) |
||||
EOF |
||||
} |
||||
if ! [[ "$COMMENT_BRANCH" =~ ^($VALID_BRANCHES)$ ]]; then |
||||
cat <<EOF |
||||
Check that the branch from the comment is valid: |
||||
|
||||
$(message) |
||||
|
||||
This action can only rebase onto these branches: |
||||
|
||||
$VALID_BRANCHES |
||||
|
||||
\`/rebase \${branch}\` must be at the start of the line |
||||
EOF |
||||
exit 1 |
||||
fi |
||||
if [[ "$COMMENT_BRANCH" == "$CURRENT_BASE" ]]; then |
||||
cat <<EOF |
||||
Check that the branch from the comment isn't the current base branch: |
||||
|
||||
$(message) |
||||
EOF |
||||
exit 1 |
||||
fi |
||||
if [[ "$COMMENT_BRANCH" == "$PR_BRANCH" ]]; then |
||||
cat <<EOF |
||||
Check that the branch from the comment isn't the current branch: |
||||
|
||||
$(message) |
||||
EOF |
||||
exit 1 |
||||
fi |
||||
if [[ "$PR_BRANCH" =~ ^($PERMANENT_BRANCHES) ]]; then |
||||
cat <<EOF |
||||
Check that the PR branch isn't a permanent branch: |
||||
|
||||
$(message) |
||||
EOF |
||||
exit 1 |
||||
fi |
||||
if [[ "$CAN_MODIFY" != "true" ]]; then |
||||
cat <<EOF |
||||
Check that maintainers can edit the PR branch: |
||||
|
||||
$(message) |
||||
EOF |
||||
exit 1 |
||||
fi |
||||
- uses: actions/checkout@v2 |
||||
with: |
||||
fetch-depth: 0 |
||||
- name: rebase pull request |
||||
env: |
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
||||
run: | |
||||
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" |
||||
git config --global user.name "github-actions[bot]" |
||||
git fetch origin |
||||
gh pr checkout "$PULL_REQUEST" |
||||
git rebase \ |
||||
--onto="$(git merge-base origin/"$CURRENT_BASE" origin/"$COMMENT_BRANCH")" \ |
||||
"HEAD~$COMMITS" |
||||
git push --force |
||||
curl \ |
||||
-X POST \ |
||||
-H "Accept: application/vnd.github.v3+json" \ |
||||
-H "Authorization: token $GITHUB_TOKEN" \ |
||||
-d "{ \"base\": \"$COMMENT_BRANCH\" }" \ |
||||
"https://api.github.com/repos/${{ github.repository }}/pulls/$PULL_REQUEST" |
||||
curl \ |
||||
-X PATCH \ |
||||
-H "Accept: application/vnd.github.v3+json" \ |
||||
-H "Authorization: token $GITHUB_TOKEN" \ |
||||
-d '{ "state": "closed" }' \ |
||||
"https://api.github.com/repos/${{ github.repository }}/pulls/$PULL_REQUEST" |
||||
- uses: peter-evans/create-or-update-comment@v1 |
||||
with: |
||||
issue-number: ${{ github.event.issue.number }} |
||||
body: | |
||||
Rebased, please reopen the pull request to restart CI |
||||
- uses: peter-evans/create-or-update-comment@v1 |
||||
if: failure() |
||||
with: |
||||
issue-number: ${{ github.event.issue.number }} |
||||
body: | |
||||
[Failed to rebase](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) |
||||
@ -0,0 +1,22 @@ |
||||
*~ |
||||
,* |
||||
.*.swp |
||||
.*.swo |
||||
result |
||||
result-* |
||||
/doc/NEWS.html |
||||
/doc/NEWS.txt |
||||
/doc/manual.html |
||||
/doc/manual.pdf |
||||
.version-suffix |
||||
|
||||
.DS_Store |
||||
.mypy_cache |
||||
__pycache__ |
||||
|
||||
/pkgs/development/libraries/qt-5/*/tmp/ |
||||
/pkgs/desktops/kde-5/*/tmp/ |
||||
/pkgs/development/mobile/androidenv/xml/* |
||||
|
||||
# generated by pkgs/common-updater/update-script.nix |
||||
update-git-commits.txt |
||||
@ -0,0 +1,20 @@ |
||||
Copyright (c) 2003-2021 Eelco Dolstra and the Nixpkgs/NixOS contributors |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining |
||||
a copy of this software and associated documentation files (the |
||||
"Software"), to deal in the Software without restriction, including |
||||
without limitation the rights to use, copy, modify, merge, publish, |
||||
distribute, sublicense, and/or sell copies of the Software, and to |
||||
permit persons to whom the Software is furnished to do so, subject to |
||||
the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be |
||||
included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
@ -0,0 +1,113 @@ |
||||
<p align="center"> |
||||
<a href="https://nixos.org/nixos"><img src="https://nixos.org/logo/nixos-hires.png" width="500px" alt="NixOS logo" /></a> |
||||
</p> |
||||
|
||||
<p align="center"> |
||||
<a href="https://www.codetriage.com/nixos/nixpkgs"><img src="https://www.codetriage.com/nixos/nixpkgs/badges/users.svg" alt="Code Triagers badge" /></a> |
||||
<a href="https://opencollective.com/nixos"><img src="https://opencollective.com/nixos/tiers/supporter/badge.svg?label=Supporter&color=brightgreen" alt="Open Collective supporters" /></a> |
||||
</p> |
||||
|
||||
[Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over |
||||
60,000 software packages that can be installed with the |
||||
[Nix](https://nixos.org/nix/) package manager. It also implements |
||||
[NixOS](https://nixos.org/nixos/), a purely-functional Linux distribution. |
||||
|
||||
# Manuals |
||||
|
||||
* [NixOS Manual](https://nixos.org/nixos/manual) - how to install, configure, and maintain a purely-functional Linux distribution |
||||
* [Nixpkgs Manual](https://nixos.org/nixpkgs/manual/) - contributing to Nixpkgs and using programming-language-specific Nix expressions |
||||
* [Nix Package Manager Manual](https://nixos.org/nix/manual) - how to write Nix expressions (programs), and how to use Nix command line tools |
||||
|
||||
# Community |
||||
|
||||
* [Discourse Forum](https://discourse.nixos.org/) |
||||
* [IRC - #nixos on freenode.net](irc://irc.freenode.net/#nixos) |
||||
* [NixOS Weekly](https://weekly.nixos.org/) |
||||
* [Community-maintained wiki](https://nixos.wiki/) |
||||
* [Community-maintained list of ways to get in touch](https://nixos.wiki/wiki/Get_In_Touch#Chat) (Discord, Matrix, Telegram, other IRC channels, etc.) |
||||
|
||||
# Other Project Repositories |
||||
|
||||
The sources of all official Nix-related projects are in the [NixOS |
||||
organization on GitHub](https://github.com/NixOS/). Here are some of |
||||
the main ones: |
||||
|
||||
* [Nix](https://github.com/NixOS/nix) - the purely functional package manager |
||||
* [NixOps](https://github.com/NixOS/nixops) - the tool to remotely deploy NixOS machines |
||||
* [nixos-hardware](https://github.com/NixOS/nixos-hardware) - NixOS profiles to optimize settings for different hardware |
||||
* [Nix RFCs](https://github.com/NixOS/rfcs) - the formal process for making substantial changes to the community |
||||
* [NixOS homepage](https://github.com/NixOS/nixos-homepage) - the [NixOS.org](https://nixos.org) website |
||||
* [hydra](https://github.com/NixOS/hydra) - our continuous integration system |
||||
* [NixOS Artwork](https://github.com/NixOS/nixos-artwork) - NixOS artwork |
||||
|
||||
# Continuous Integration and Distribution |
||||
|
||||
Nixpkgs and NixOS are built and tested by our continuous integration |
||||
system, [Hydra](https://hydra.nixos.org/). |
||||
|
||||
* [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined) |
||||
* [Continuous package builds for the NixOS 20.09 release](https://hydra.nixos.org/jobset/nixos/release-20.09) |
||||
* [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents) |
||||
* [Tests for the NixOS 20.09 release](https://hydra.nixos.org/job/nixos/release-20.09/tested#tabs-constituents) |
||||
|
||||
Artifacts successfully built with Hydra are published to cache at |
||||
https://cache.nixos.org/. When successful build and test criteria are |
||||
met, the Nixpkgs expressions are distributed via [Nix |
||||
channels](https://nixos.org/nix/manual/#sec-channels). |
||||
|
||||
# Contributing |
||||
|
||||
Nixpkgs is among the most active projects on GitHub. While thousands |
||||
of open issues and pull requests might seem a lot at first, it helps |
||||
consider it in the context of the scope of the project. Nixpkgs |
||||
describes how to build tens of thousands of pieces of software and implements a |
||||
Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse) |
||||
page gives a sense of the project activity. |
||||
|
||||
Community contributions are always welcome through GitHub Issues and |
||||
Pull Requests. When pull requests are made, our tooling automation bot, |
||||
[OfBorg](https://github.com/NixOS/ofborg) will perform various checks |
||||
to help ensure expression quality. |
||||
|
||||
The *Nixpkgs maintainers* are people who have assigned themselves to |
||||
maintain specific individual packages. We encourage people who care |
||||
about a package to assign themselves as a maintainer. When a pull |
||||
request is made against a package, OfBorg will notify the appropriate |
||||
maintainer(s). The *Nixpkgs committers* are people who have been given |
||||
permission to merge. |
||||
|
||||
Most contributions are based on and merged into these branches: |
||||
|
||||
* `master` is the main branch where all small contributions go |
||||
* `staging` is branched from master, changes that have a big impact on |
||||
Hydra builds go to this branch |
||||
* `staging-next` is branched from staging and only fixes to stabilize |
||||
and security fixes with a big impact on Hydra builds should be |
||||
contributed to this branch. This branch is merged into master when |
||||
deemed of sufficiently high quality |
||||
|
||||
For more information about contributing to the project, please visit |
||||
the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md). |
||||
|
||||
# Donations |
||||
|
||||
The infrastructure for NixOS and related projects is maintained by a |
||||
nonprofit organization, the [NixOS |
||||
Foundation](https://nixos.org/nixos/foundation.html). To ensure the |
||||
continuity and expansion of the NixOS infrastructure, we are looking |
||||
for donations to our organization. |
||||
|
||||
You can donate to the NixOS foundation by using Open Collective: |
||||
|
||||
<a href="https://opencollective.com/nixos#support"><img src="https://opencollective.com/nixos/tiers/supporter.svg?width=890" /></a> |
||||
|
||||
# License |
||||
|
||||
Nixpkgs is licensed under the [MIT License](COPYING). |
||||
|
||||
Note: MIT license does not apply to the packages built by Nixpkgs, |
||||
merely to the files in this repository (the Nix expressions, build |
||||
scripts, NixOS modules, etc.). It also might not apply to patches |
||||
included in Nixpkgs, which may be derivative works of the packages to |
||||
which they apply. The aforementioned artifacts are all covered by the |
||||
licenses of the respective packages. |
||||
@ -0,0 +1,28 @@ |
||||
let requiredVersion = import ./lib/minver.nix; in |
||||
|
||||
if ! builtins ? nixVersion || builtins.compareVersions requiredVersion builtins.nixVersion == 1 then |
||||
|
||||
abort '' |
||||
|
||||
This version of Nixpkgs requires Nix >= ${requiredVersion}, please upgrade: |
||||
|
||||
- If you are running NixOS, `nixos-rebuild' can be used to upgrade your system. |
||||
|
||||
- Alternatively, with Nix > 2.0 `nix upgrade-nix' can be used to imperatively |
||||
upgrade Nix. You may use `nix-env --version' to check which version you have. |
||||
|
||||
- If you installed Nix using the install script (https://nixos.org/nix/install), |
||||
it is safe to upgrade by running it again: |
||||
|
||||
curl -L https://nixos.org/nix/install | sh |
||||
|
||||
For more information, please see the NixOS release notes at |
||||
https://nixos.org/nixos/manual or locally at |
||||
${toString ./nixos/doc/manual/release-notes}. |
||||
|
||||
If you need further help, see https://nixos.org/nixos/support.html |
||||
'' |
||||
|
||||
else |
||||
|
||||
import ./pkgs/top-level/impure.nix |
||||
@ -0,0 +1,8 @@ |
||||
*.chapter.xml |
||||
*.section.xml |
||||
.version |
||||
functions/library/generated |
||||
functions/library/locations.xml |
||||
highlightjs |
||||
manual-full.xml |
||||
out |
||||
@ -0,0 +1,104 @@ |
||||
MD_TARGETS=$(addsuffix .xml, $(basename $(shell find . -type f -regex '.*\.md$$' -not -name README.md)))
|
||||
|
||||
.PHONY: all |
||||
all: validate format out/html/index.html out/epub/manual.epub |
||||
|
||||
.PHONY: debug |
||||
debug: |
||||
nix-shell --run "xmloscopy --docbook5 ./manual.xml ./manual-full.xml"
|
||||
|
||||
.PHONY: format |
||||
format: doc-support/result |
||||
find . -iname '*.xml' -type f | while read f; do \
|
||||
echo $$f ;\
|
||||
xmlformat --config-file "doc-support/result/xmlformat.conf" -i $$f ;\
|
||||
done
|
||||
|
||||
.PHONY: fix-misc-xml |
||||
fix-misc-xml: |
||||
find . -iname '*.xml' -type f \
|
||||
-exec ../nixos/doc/varlistentry-fixer.rb {} ';'
|
||||
|
||||
.PHONY: clean |
||||
clean: |
||||
rm -f ${MD_TARGETS} doc-support/result .version manual-full.xml functions/library/locations.xml functions/library/generated
|
||||
rm -rf ./out/ ./highlightjs
|
||||
|
||||
.PHONY: validate |
||||
validate: manual-full.xml doc-support/result |
||||
jing doc-support/result/docbook.rng manual-full.xml
|
||||
|
||||
out/html/index.html: doc-support/result manual-full.xml style.css highlightjs |
||||
mkdir -p out/html
|
||||
xsltproc \
|
||||
--nonet --xinclude \
|
||||
--output $@ \
|
||||
doc-support/result/xhtml.xsl \
|
||||
./manual-full.xml
|
||||
|
||||
mkdir -p out/html/highlightjs/
|
||||
cp -r highlightjs out/html/
|
||||
|
||||
cp -r media out/html/
|
||||
cp ./overrides.css out/html/
|
||||
cp ./style.css out/html/style.css
|
||||
|
||||
mkdir -p out/html/images/callouts
|
||||
cp doc-support/result/xsl/docbook/images/callouts/*.svg out/html/images/callouts/
|
||||
chmod u+w -R out/html/
|
||||
|
||||
out/epub/manual.epub: manual-full.xml |
||||
mkdir -p out/epub/scratch
|
||||
xsltproc --nonet \
|
||||
--output out/epub/scratch/ \
|
||||
doc-support/result/epub.xsl \
|
||||
./manual-full.xml
|
||||
|
||||
cp -r media out/epub/scratch/OEBPS
|
||||
cp ./overrides.css out/epub/scratch/OEBPS
|
||||
cp ./style.css out/epub/scratch/OEBPS
|
||||
mkdir -p out/epub/scratch/OEBPS/images/callouts/
|
||||
cp doc-support/result/xsl/docbook/images/callouts/*.svg out/epub/scratch/OEBPS/images/callouts/
|
||||
echo "application/epub+zip" > mimetype
|
||||
zip -0Xq "out/epub/manual.epub" mimetype
|
||||
rm mimetype
|
||||
cd "out/epub/scratch/" && zip -Xr9D "../manual.epub" *
|
||||
rm -rf "out/epub/scratch/"
|
||||
|
||||
highlightjs: doc-support/result |
||||
mkdir -p highlightjs
|
||||
cp -r doc-support/result/highlightjs/highlight.pack.js highlightjs/
|
||||
cp -r doc-support/result/highlightjs/LICENSE highlightjs/
|
||||
cp -r doc-support/result/highlightjs/mono-blue.css highlightjs/
|
||||
cp -r doc-support/result/highlightjs/loader.js highlightjs/
|
||||
|
||||
|
||||
manual-full.xml: ${MD_TARGETS} .version functions/library/locations.xml functions/library/generated *.xml **/*.xml **/**/*.xml |
||||
xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
|
||||
|
||||
.version: doc-support/result |
||||
ln -rfs ./doc-support/result/version .version
|
||||
|
||||
doc-support/result: doc-support/default.nix |
||||
(cd doc-support; nix-build)
|
||||
|
||||
functions/library/locations.xml: doc-support/result |
||||
ln -rfs ./doc-support/result/function-locations.xml functions/library/locations.xml
|
||||
|
||||
functions/library/generated: doc-support/result |
||||
ln -rfs ./doc-support/result/function-docs functions/library/generated
|
||||
|
||||
%.section.xml: %.section.md |
||||
pandoc $^ -t docbook \
|
||||
--extract-media=media \
|
||||
--lua-filter=$(PANDOC_LUA_FILTERS_DIR)/diagram-generator.lua \
|
||||
-f markdown+smart \
|
||||
| cat > $@
|
||||
|
||||
%.chapter.xml: %.chapter.md |
||||
pandoc $^ -t docbook \
|
||||
--top-level-division=chapter \
|
||||
--extract-media=media \
|
||||
--lua-filter=$(PANDOC_LUA_FILTERS_DIR)/diagram-generator.lua \
|
||||
-f markdown+smart \
|
||||
| cat > $@
|
||||
@ -0,0 +1,12 @@ |
||||
|
||||
# Nixpkgs/doc |
||||
|
||||
This directory houses the sources files for the Nixpkgs manual. |
||||
|
||||
You can find the [rendered documentation for Nixpkgs `unstable` on nixos.org](https://nixos.org/manual/nixpkgs/unstable/). |
||||
|
||||
[Docs for Nixpkgs stable](https://nixos.org/manual/nixpkgs/stable/) are also available. |
||||
|
||||
If you want to contribute to the documentation, [here's how to do it](https://nixos.org/manual/nixpkgs/unstable/#chap-contributing). |
||||
|
||||
If you're only getting started with Nix, go to [nixos.org/learn](https://nixos.org/learn). |
||||
@ -0,0 +1,78 @@ |
||||
# Fetchers {#chap-pkgs-fetchers} |
||||
|
||||
When using Nix, you will frequently need to download source code and other files from the internet. Nixpkgs comes with a few helper functions that allow you to fetch fixed-output derivations in a structured way. |
||||
|
||||
The two fetcher primitives are `fetchurl` and `fetchzip`. Both of these have two required arguments, a URL and a hash. The hash is typically `sha256`, although many more hash algorithms are supported. Nixpkgs contributors are currently recommended to use `sha256`. This hash will be used by Nix to identify your source. A typical usage of fetchurl is provided below. |
||||
|
||||
```nix |
||||
{ stdenv, fetchurl }: |
||||
|
||||
stdenv.mkDerivation { |
||||
name = "hello"; |
||||
src = fetchurl { |
||||
url = "http://www.example.org/hello.tar.gz"; |
||||
sha256 = "1111111111111111111111111111111111111111111111111111"; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
The main difference between `fetchurl` and `fetchzip` is in how they store the contents. `fetchurl` will store the unaltered contents of the URL within the Nix store. `fetchzip` on the other hand will decompress the archive for you, making files and directories directly accessible in the future. `fetchzip` can only be used with archives. Despite the name, `fetchzip` is not limited to .zip files and can also be used with any tarball. |
||||
|
||||
`fetchpatch` works very similarly to `fetchurl` with the same arguments expected. It expects patch files as a source and performs normalization on them before computing the checksum. For example it will remove comments or other unstable parts that are sometimes added by version control systems and can change over time. |
||||
|
||||
|
||||
Other fetcher functions allow you to add source code directly from a VCS such as subversion or git. These are mostly straightforward nambes based on the name of the command used with the VCS system. Because they give you a working repository, they act most like `fetchzip`. |
||||
|
||||
## `fetchsvn` |
||||
|
||||
Used with Subversion. Expects `url` to a Subversion directory, `rev`, and `sha256`. |
||||
|
||||
## `fetchgit` |
||||
|
||||
Used with Git. Expects `url` to a Git repo, `rev`, and `sha256`. `rev` in this case can be full the git commit id (SHA1 hash) or a tag name like `refs/tags/v1.0`. |
||||
|
||||
Additionally the following optional arguments can be given: `fetchSubmodules = true` makes `fetchgit` also fetch the submodules of a repository. If `deepClone` is set to true, the entire repository is cloned as opposing to just creating a shallow clone. `deepClone = true` also implies `leaveDotGit = true` which means that the `.git` directory of the clone won't be removed after checkout. |
||||
|
||||
## `fetchfossil` |
||||
|
||||
Used with Fossil. Expects `url` to a Fossil archive, `rev`, and `sha256`. |
||||
|
||||
## `fetchcvs` |
||||
|
||||
Used with CVS. Expects `cvsRoot`, `tag`, and `sha256`. |
||||
|
||||
## `fetchhg` |
||||
|
||||
Used with Mercurial. Expects `url`, `rev`, and `sha256`. |
||||
|
||||
A number of fetcher functions wrap part of `fetchurl` and `fetchzip`. They are mainly convenience functions intended for commonly used destinations of source code in Nixpkgs. These wrapper fetchers are listed below. |
||||
|
||||
## `fetchFromGitHub` |
||||
|
||||
`fetchFromGitHub` expects four arguments. `owner` is a string corresponding to the GitHub user or organization that controls this repository. `repo` corresponds to the name of the software repository. These are located at the top of every GitHub HTML page as `owner`/`repo`. `rev` corresponds to the Git commit hash or tag (e.g `v1.0`) that will be downloaded from Git. Finally, `sha256` corresponds to the hash of the extracted directory. Again, other hash algorithms are also available but `sha256` is currently preferred. |
||||
|
||||
`fetchFromGitHub` uses `fetchzip` to download the source archive generated by GitHub for the specified revision. If `leaveDotGit`, `deepClone` or `fetchSubmodules` are set to `true`, `fetchFromGitHub` will use `fetchgit` instead. Refer to its section for documentation of these options. |
||||
|
||||
## `fetchFromGitLab` |
||||
|
||||
This is used with GitLab repositories. The arguments expected are very similar to fetchFromGitHub above. |
||||
|
||||
## `fetchFromGitiles` |
||||
|
||||
This is used with Gitiles repositories. The arguments expected are similar to fetchgit. |
||||
|
||||
## `fetchFromBitbucket` |
||||
|
||||
This is used with BitBucket repositories. The arguments expected are very similar to fetchFromGitHub above. |
||||
|
||||
## `fetchFromSavannah` |
||||
|
||||
This is used with Savannah repositories. The arguments expected are very similar to fetchFromGitHub above. |
||||
|
||||
## `fetchFromRepoOrCz` |
||||
|
||||
This is used with repo.or.cz repositories. The arguments expected are very similar to fetchFromGitHub above. |
||||
|
||||
## `fetchFromSourcehut` |
||||
|
||||
This is used with sourcehut repositories. The arguments expected are very similar to fetchFromGitHub above. Don't forget the tilde (~) in front of the user name! |
||||
@ -0,0 +1,12 @@ |
||||
<chapter xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="chap-images"> |
||||
<title>Images</title> |
||||
<para> |
||||
This chapter describes tools for creating various types of images. |
||||
</para> |
||||
<xi:include href="images/appimagetools.section.xml" /> |
||||
<xi:include href="images/dockertools.section.xml" /> |
||||
<xi:include href="images/ocitools.section.xml" /> |
||||
<xi:include href="images/snaptools.section.xml" /> |
||||
</chapter> |
||||
@ -0,0 +1,48 @@ |
||||
# pkgs.appimageTools {#sec-pkgs-appimageTools} |
||||
|
||||
`pkgs.appimageTools` is a set of functions for extracting and wrapping [AppImage](https://appimage.org/) files. They are meant to be used if traditional packaging from source is infeasible, or it would take too long. To quickly run an AppImage file, `pkgs.appimage-run` can be used as well. |
||||
|
||||
::: warning |
||||
The `appimageTools` API is unstable and may be subject to backwards-incompatible changes in the future. |
||||
::: |
||||
|
||||
## AppImage formats {#ssec-pkgs-appimageTools-formats} |
||||
|
||||
There are different formats for AppImages, see [the specification](https://github.com/AppImage/AppImageSpec/blob/74ad9ca2f94bf864a4a0dac1f369dd4f00bd1c28/draft.md#image-format) for details. |
||||
|
||||
- Type 1 images are ISO 9660 files that are also ELF executables. |
||||
- Type 2 images are ELF executables with an appended filesystem. |
||||
|
||||
They can be told apart with `file -k`: |
||||
|
||||
```ShellSession |
||||
$ file -k type1.AppImage |
||||
type1.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) ISO 9660 CD-ROM filesystem data 'AppImage' (Lepton 3.x), scale 0-0, |
||||
spot sensor temperature 0.000000, unit celsius, color scheme 0, calibration: offset 0.000000, slope 0.000000, dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 2.6.18, BuildID[sha1]=d629f6099d2344ad82818172add1d38c5e11bc6d, stripped\012- data |
||||
|
||||
$ file -k type2.AppImage |
||||
type2.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) (Lepton 3.x), scale 232-60668, spot sensor temperature -4.187500, color scheme 15, show scale bar, calibration: offset -0.000000, slope 0.000000 (Lepton 2.x), scale 4111-45000, spot sensor temperature 412442.250000, color scheme 3, minimum point enabled, calibration: offset -75402534979642766821519867692934234112.000000, slope 5815371847733706829839455140374904832.000000, dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 2.6.18, BuildID[sha1]=79dcc4e55a61c293c5e19edbd8d65b202842579f, stripped\012- data |
||||
``` |
||||
|
||||
Note how the type 1 AppImage is described as an `ISO 9660 CD-ROM filesystem`, and the type 2 AppImage is not. |
||||
|
||||
## Wrapping {#ssec-pkgs-appimageTools-wrapping} |
||||
|
||||
Depending on the type of AppImage you're wrapping, you'll have to use `wrapType1` or `wrapType2`. |
||||
|
||||
```nix |
||||
appimageTools.wrapType2 { # or wrapType1 |
||||
name = "patchwork"; |
||||
src = fetchurl { |
||||
url = "https://github.com/ssbc/patchwork/releases/download/v3.11.4/Patchwork-3.11.4-linux-x86_64.AppImage"; |
||||
sha256 = "1blsprpkvm0ws9b96gb36f0rbf8f5jgmw4x6dsb1kswr4ysf591s"; |
||||
}; |
||||
extraPkgs = pkgs: with pkgs; [ ]; |
||||
} |
||||
``` |
||||
|
||||
- `name` specifies the name of the resulting image. |
||||
- `src` specifies the AppImage file to extract. |
||||
- `extraPkgs` allows you to pass a function to include additional packages inside the FHS environment your AppImage is going to run in. There are a few ways to learn which dependencies an application needs: |
||||
- Looking through the extracted AppImage files, reading its scripts and running `patchelf` and `ldd` on its executables. This can also be done in `appimage-run`, by setting `APPIMAGE_DEBUG_EXEC=bash`. |
||||
- Running `strace -vfefile` on the wrapped executable, looking for libraries that can't be found. |
||||
@ -0,0 +1,308 @@ |
||||
# pkgs.dockerTools {#sec-pkgs-dockerTools} |
||||
|
||||
`pkgs.dockerTools` is a set of functions for creating and manipulating Docker images according to the [ Docker Image Specification v1.2.0 ](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120). Docker itself is not used to perform any of the operations done by these functions. |
||||
|
||||
## buildImage {#ssec-pkgs-dockerTools-buildImage} |
||||
|
||||
This function is analogous to the `docker build` command, in that it can be used to build a Docker-compatible repository tarball containing a single image with one or multiple layers. As such, the result is suitable for being loaded in Docker with `docker load`. |
||||
|
||||
The parameters of `buildImage` with relative example values are described below: |
||||
|
||||
[]{#ex-dockerTools-buildImage} |
||||
[]{#ex-dockerTools-buildImage-runAsRoot} |
||||
|
||||
```nix |
||||
buildImage { |
||||
name = "redis"; |
||||
tag = "latest"; |
||||
|
||||
fromImage = someBaseImage; |
||||
fromImageName = null; |
||||
fromImageTag = "latest"; |
||||
|
||||
contents = pkgs.redis; |
||||
runAsRoot = '' |
||||
#!${pkgs.runtimeShell} |
||||
mkdir -p /data |
||||
''; |
||||
|
||||
config = { |
||||
Cmd = [ "/bin/redis-server" ]; |
||||
WorkingDir = "/data"; |
||||
Volumes = { "/data" = { }; }; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
The above example will build a Docker image `redis/latest` from the given base image. Loading and running this image in Docker results in `redis-server` being started automatically. |
||||
|
||||
- `name` specifies the name of the resulting image. This is the only required argument for `buildImage`. |
||||
|
||||
- `tag` specifies the tag of the resulting image. By default it's `null`, which indicates that the nix output hash will be used as tag. |
||||
|
||||
- `fromImage` is the repository tarball containing the base image. It must be a valid Docker image, such as exported by `docker save`. By default it's `null`, which can be seen as equivalent to `FROM scratch` of a `Dockerfile`. |
||||
|
||||
- `fromImageName` can be used to further specify the base image within the repository, in case it contains multiple images. By default it's `null`, in which case `buildImage` will peek the first image available in the repository. |
||||
|
||||
- `fromImageTag` can be used to further specify the tag of the base image within the repository, in case an image contains multiple tags. By default it's `null`, in which case `buildImage` will peek the first tag available for the base image. |
||||
|
||||
- `contents` is a derivation that will be copied in the new layer of the resulting image. This can be similarly seen as `ADD contents/ /` in a `Dockerfile`. By default it's `null`. |
||||
|
||||
- `runAsRoot` is a bash script that will run as root in an environment that overlays the existing layers of the base image with the new resulting layer, including the previously copied `contents` derivation. This can be similarly seen as `RUN ...` in a `Dockerfile`. |
||||
|
||||
> **_NOTE:_** Using this parameter requires the `kvm` device to be available. |
||||
|
||||
- `config` is used to specify the configuration of the containers that will be started off the built image in Docker. The available options are listed in the [ Docker Image Specification v1.2.0 ](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions). |
||||
|
||||
After the new layer has been created, its closure (to which `contents`, `config` and `runAsRoot` contribute) will be copied in the layer itself. Only new dependencies that are not already in the existing layers will be copied. |
||||
|
||||
At the end of the process, only one new single layer will be produced and added to the resulting image. |
||||
|
||||
The resulting repository will only list the single image `image/tag`. In the case of [the `buildImage` example](#ex-dockerTools-buildImage) it would be `redis/latest`. |
||||
|
||||
It is possible to inspect the arguments with which an image was built using its `buildArgs` attribute. |
||||
|
||||
> **_NOTE:_** If you see errors similar to `getProtocolByName: does not exist (no such protocol name: tcp)` you may need to add `pkgs.iana-etc` to `contents`. |
||||
|
||||
> **_NOTE:_** If you see errors similar to `Error_Protocol ("certificate has unknown CA",True,UnknownCa)` you may need to add `pkgs.cacert` to `contents`. |
||||
|
||||
By default `buildImage` will use a static date of one second past the UNIX Epoch. This allows `buildImage` to produce binary reproducible images. When listing images with `docker images`, the newly created images will be listed like this: |
||||
|
||||
```ShellSession |
||||
$ docker images |
||||
REPOSITORY TAG IMAGE ID CREATED SIZE |
||||
hello latest 08c791c7846e 48 years ago 25.2MB |
||||
``` |
||||
|
||||
You can break binary reproducibility but have a sorted, meaningful `CREATED` column by setting `created` to `now`. |
||||
|
||||
```nix |
||||
pkgs.dockerTools.buildImage { |
||||
name = "hello"; |
||||
tag = "latest"; |
||||
created = "now"; |
||||
contents = pkgs.hello; |
||||
|
||||
config.Cmd = [ "/bin/hello" ]; |
||||
} |
||||
``` |
||||
|
||||
and now the Docker CLI will display a reasonable date and sort the images as expected: |
||||
|
||||
```ShellSession |
||||
$ docker images |
||||
REPOSITORY TAG IMAGE ID CREATED SIZE |
||||
hello latest de2bf4786de6 About a minute ago 25.2MB |
||||
``` |
||||
|
||||
however, the produced images will not be binary reproducible. |
||||
|
||||
## buildLayeredImage {#ssec-pkgs-dockerTools-buildLayeredImage} |
||||
|
||||
Create a Docker image with many of the store paths being on their own layer to improve sharing between images. The image is realized into the Nix store as a gzipped tarball. Depending on the intended usage, many users might prefer to use `streamLayeredImage` instead, which this function uses internally. |
||||
|
||||
`name` |
||||
|
||||
: The name of the resulting image. |
||||
|
||||
`tag` _optional_ |
||||
|
||||
: Tag of the generated image. |
||||
|
||||
*Default:* the output path's hash |
||||
|
||||
`fromImage` _optional_ |
||||
|
||||
: The repository tarball containing the base image. It must be a valid Docker image, such as one exported by `docker save`. |
||||
|
||||
*Default:* `null`, which can be seen as equivalent to `FROM scratch` of a `Dockerfile`. |
||||
|
||||
`contents` _optional_ |
||||
|
||||
: Top level paths in the container. Either a single derivation, or a list of derivations. |
||||
|
||||
*Default:* `[]` |
||||
|
||||
`config` _optional_ |
||||
|
||||
: Run-time configuration of the container. A full list of the options are available at in the [ Docker Image Specification v1.2.0 ](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions). |
||||
|
||||
*Default:* `{}` |
||||
|
||||
`created` _optional_ |
||||
|
||||
: Date and time the layers were created. Follows the same `now` exception supported by `buildImage`. |
||||
|
||||
*Default:* `1970-01-01T00:00:01Z` |
||||
|
||||
`maxLayers` _optional_ |
||||
|
||||
: Maximum number of layers to create. |
||||
|
||||
*Default:* `100` |
||||
|
||||
*Maximum:* `125` |
||||
|
||||
`extraCommands` _optional_ |
||||
|
||||
: Shell commands to run while building the final layer, without access to most of the layer contents. Changes to this layer are "on top" of all the other layers, so can create additional directories and files. |
||||
|
||||
`fakeRootCommands` _optional_ |
||||
|
||||
: Shell commands to run while creating the archive for the final layer in a fakeroot environment. Unlike `extraCommands`, you can run `chown` to change the owners of the files in the archive, changing fakeroot's state instead of the real filesystem. The latter would require privileges that the build user does not have. Static binaries do not interact with the fakeroot environment. By default all files in the archive will be owned by root. |
||||
|
||||
### Behavior of `contents` in the final image {#dockerTools-buildLayeredImage-arg-contents} |
||||
|
||||
Each path directly listed in `contents` will have a symlink in the root of the image. |
||||
|
||||
For example: |
||||
|
||||
```nix |
||||
pkgs.dockerTools.buildLayeredImage { |
||||
name = "hello"; |
||||
contents = [ pkgs.hello ]; |
||||
} |
||||
``` |
||||
|
||||
will create symlinks for all the paths in the `hello` package: |
||||
|
||||
```ShellSession |
||||
/bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello |
||||
/share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info |
||||
/share/locale/bg/LC_MESSAGES/hello.mo -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/locale/bg/LC_MESSAGES/hello.mo |
||||
``` |
||||
|
||||
### Automatic inclusion of `config` references {#dockerTools-buildLayeredImage-arg-config} |
||||
|
||||
The closure of `config` is automatically included in the closure of the final image. |
||||
|
||||
This allows you to make very simple Docker images with very little code. This container will start up and run `hello`: |
||||
|
||||
```nix |
||||
pkgs.dockerTools.buildLayeredImage { |
||||
name = "hello"; |
||||
config.Cmd = [ "${pkgs.hello}/bin/hello" ]; |
||||
} |
||||
``` |
||||
|
||||
### Adjusting `maxLayers` {#dockerTools-buildLayeredImage-arg-maxLayers} |
||||
|
||||
Increasing the `maxLayers` increases the number of layers which have a chance to be shared between different images. |
||||
|
||||
Modern Docker installations support up to 128 layers, however older versions support as few as 42. |
||||
|
||||
If the produced image will not be extended by other Docker builds, it is safe to set `maxLayers` to `128`. However it will be impossible to extend the image further. |
||||
|
||||
The first (`maxLayers-2`) most "popular" paths will have their own individual layers, then layer \#`maxLayers-1` will contain all the remaining "unpopular" paths, and finally layer \#`maxLayers` will contain the Image configuration. |
||||
|
||||
Docker's Layers are not inherently ordered, they are content-addressable and are not explicitly layered until they are composed in to an Image. |
||||
|
||||
## streamLayeredImage {#ssec-pkgs-dockerTools-streamLayeredImage} |
||||
|
||||
Builds a script which, when run, will stream an uncompressed tarball of a Docker image to stdout. The arguments to this function are as for `buildLayeredImage`. This method of constructing an image does not realize the image into the Nix store, so it saves on IO and disk/cache space, particularly with large images. |
||||
|
||||
The image produced by running the output script can be piped directly into `docker load`, to load it into the local docker daemon: |
||||
|
||||
```ShellSession |
||||
$(nix-build) | docker load |
||||
``` |
||||
|
||||
Alternatively, the image be piped via `gzip` into `skopeo`, e.g. to copy it into a registry: |
||||
|
||||
```ShellSession |
||||
$(nix-build) | gzip --fast | skopeo copy docker-archive:/dev/stdin docker://some_docker_registry/myimage:tag |
||||
``` |
||||
|
||||
## pullImage {#ssec-pkgs-dockerTools-fetchFromRegistry} |
||||
|
||||
This function is analogous to the `docker pull` command, in that it can be used to pull a Docker image from a Docker registry. By default [Docker Hub](https://hub.docker.com/) is used to pull images. |
||||
|
||||
Its parameters are described in the example below: |
||||
|
||||
```nix |
||||
pullImage { |
||||
imageName = "nixos/nix"; |
||||
imageDigest = |
||||
"sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b"; |
||||
finalImageName = "nix"; |
||||
finalImageTag = "1.11"; |
||||
sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; |
||||
os = "linux"; |
||||
arch = "x86_64"; |
||||
} |
||||
``` |
||||
|
||||
- `imageName` specifies the name of the image to be downloaded, which can also include the registry namespace (e.g. `nixos`). This argument is required. |
||||
|
||||
- `imageDigest` specifies the digest of the image to be downloaded. This argument is required. |
||||
|
||||
- `finalImageName`, if specified, this is the name of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's equal to `imageName`. |
||||
|
||||
- `finalImageTag`, if specified, this is the tag of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's `latest`. |
||||
|
||||
- `sha256` is the checksum of the whole fetched image. This argument is required. |
||||
|
||||
- `os`, if specified, is the operating system of the fetched image. By default it's `linux`. |
||||
|
||||
- `arch`, if specified, is the cpu architecture of the fetched image. By default it's `x86_64`. |
||||
|
||||
`nix-prefetch-docker` command can be used to get required image parameters: |
||||
|
||||
```ShellSession |
||||
$ nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5 |
||||
``` |
||||
|
||||
Since a given `imageName` may transparently refer to a manifest list of images which support multiple architectures and/or operating systems, you can supply the `--os` and `--arch` arguments to specify exactly which image you want. By default it will match the OS and architecture of the host the command is run on. |
||||
|
||||
```ShellSession |
||||
$ nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux |
||||
``` |
||||
|
||||
Desired image name and tag can be set using `--final-image-name` and `--final-image-tag` arguments: |
||||
|
||||
```ShellSession |
||||
$ nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod |
||||
``` |
||||
|
||||
## exportImage {#ssec-pkgs-dockerTools-exportImage} |
||||
|
||||
This function is analogous to the `docker export` command, in that it can be used to flatten a Docker image that contains multiple layers. It is in fact the result of the merge of all the layers of the image. As such, the result is suitable for being imported in Docker with `docker import`. |
||||
|
||||
> **_NOTE:_** Using this function requires the `kvm` device to be available. |
||||
|
||||
The parameters of `exportImage` are the following: |
||||
|
||||
```nix |
||||
exportImage { |
||||
fromImage = someLayeredImage; |
||||
fromImageName = null; |
||||
fromImageTag = null; |
||||
|
||||
name = someLayeredImage.name; |
||||
} |
||||
``` |
||||
|
||||
The parameters relative to the base image have the same synopsis as described in [buildImage](#ssec-pkgs-dockerTools-buildImage), except that `fromImage` is the only required argument in this case. |
||||
|
||||
The `name` argument is the name of the derivation output, which defaults to `fromImage.name`. |
||||
|
||||
## shadowSetup {#ssec-pkgs-dockerTools-shadowSetup} |
||||
|
||||
This constant string is a helper for setting up the base files for managing users and groups, only if such files don't exist already. It is suitable for being used in a [`buildImage` `runAsRoot`](#ex-dockerTools-buildImage-runAsRoot) script for cases like in the example below: |
||||
|
||||
```nix |
||||
buildImage { |
||||
name = "shadow-basic"; |
||||
|
||||
runAsRoot = '' |
||||
#!${pkgs.runtimeShell} |
||||
${shadowSetup} |
||||
groupadd -r redis |
||||
useradd -r -g redis redis |
||||
mkdir /data |
||||
chown redis:redis /data |
||||
''; |
||||
} |
||||
``` |
||||
|
||||
Creating base files like `/etc/passwd` or `/etc/login.defs` is necessary for shadow-utils to manipulate users and groups. |
||||
@ -0,0 +1,37 @@ |
||||
# pkgs.ociTools {#sec-pkgs-ociTools} |
||||
|
||||
`pkgs.ociTools` is a set of functions for creating containers according to the [OCI container specification v1.0.0](https://github.com/opencontainers/runtime-spec). Beyond that it makes no assumptions about the container runner you choose to use to run the created container. |
||||
|
||||
## buildContainer {#ssec-pkgs-ociTools-buildContainer} |
||||
|
||||
This function creates a simple OCI container that runs a single command inside of it. An OCI container consists of a `config.json` and a rootfs directory.The nix store of the container will contain all referenced dependencies of the given command. |
||||
|
||||
The parameters of `buildContainer` with an example value are described below: |
||||
|
||||
```nix |
||||
buildContainer { |
||||
args = [ |
||||
(with pkgs; |
||||
writeScript "run.sh" '' |
||||
#!${bash}/bin/bash |
||||
exec ${bash}/bin/bash |
||||
'').outPath |
||||
]; |
||||
|
||||
mounts = { |
||||
"/data" = { |
||||
type = "none"; |
||||
source = "/var/lib/mydata"; |
||||
options = [ "bind" ]; |
||||
}; |
||||
}; |
||||
|
||||
readonly = false; |
||||
} |
||||
``` |
||||
|
||||
- `args` specifies a set of arguments to run inside the container. This is the only required argument for `buildContainer`. All referenced packages inside the derivation will be made available inside the container |
||||
|
||||
- `mounts` specifies additional mount points chosen by the user. By default only a minimal set of necessary filesystems are mounted into the container (e.g procfs, cgroupfs) |
||||
|
||||
- `readonly` makes the container\'s rootfs read-only if it is set to true. The default value is false `false`. |
||||
@ -0,0 +1,71 @@ |
||||
# pkgs.snapTools {#sec-pkgs-snapTools} |
||||
|
||||
`pkgs.snapTools` is a set of functions for creating Snapcraft images. Snap and Snapcraft is not used to perform these operations. |
||||
|
||||
## The makeSnap Function {#ssec-pkgs-snapTools-makeSnap-signature} |
||||
|
||||
`makeSnap` takes a single named argument, `meta`. This argument mirrors [the upstream `snap.yaml` format](https://docs.snapcraft.io/snap-format) exactly. |
||||
|
||||
The `base` should not be specified, as `makeSnap` will force set it. |
||||
|
||||
Currently, `makeSnap` does not support creating GUI stubs. |
||||
|
||||
## Build a Hello World Snap {#ssec-pkgs-snapTools-build-a-snap-hello} |
||||
|
||||
The following expression packages GNU Hello as a Snapcraft snap. |
||||
|
||||
```{#ex-snapTools-buildSnap-hello .nix} |
||||
let |
||||
inherit (import <nixpkgs> { }) snapTools hello; |
||||
in snapTools.makeSnap { |
||||
meta = { |
||||
name = "hello"; |
||||
summary = hello.meta.description; |
||||
description = hello.meta.longDescription; |
||||
architectures = [ "amd64" ]; |
||||
confinement = "strict"; |
||||
apps.hello.command = "${hello}/bin/hello"; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
`nix-build` this expression and install it with `snap install ./result --dangerous`. `hello` will now be the Snapcraft version of the package. |
||||
|
||||
## Build a Graphical Snap {#ssec-pkgs-snapTools-build-a-snap-firefox} |
||||
|
||||
Graphical programs require many more integrations with the host. This example uses Firefox as an example, because it is one of the most complicated programs we could package. |
||||
|
||||
```{#ex-snapTools-buildSnap-firefox .nix} |
||||
let |
||||
inherit (import <nixpkgs> { }) snapTools firefox; |
||||
in snapTools.makeSnap { |
||||
meta = { |
||||
name = "nix-example-firefox"; |
||||
summary = firefox.meta.description; |
||||
architectures = [ "amd64" ]; |
||||
apps.nix-example-firefox = { |
||||
command = "${firefox}/bin/firefox"; |
||||
plugs = [ |
||||
"pulseaudio" |
||||
"camera" |
||||
"browser-support" |
||||
"avahi-observe" |
||||
"cups-control" |
||||
"desktop" |
||||
"desktop-legacy" |
||||
"gsettings" |
||||
"home" |
||||
"network" |
||||
"mount-observe" |
||||
"removable-media" |
||||
"x11" |
||||
]; |
||||
}; |
||||
confinement = "strict"; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
`nix-build` this expression and install it with `snap install ./result --dangerous`. `nix-example-firefox` will now be the Snapcraft version of the Firefox package. |
||||
|
||||
The specific meaning behind plugs can be looked up in the [Snapcraft interface documentation](https://docs.snapcraft.io/supported-interfaces). |
||||
@ -0,0 +1,129 @@ |
||||
# Cataclysm: Dark Days Ahead {#cataclysm-dark-days-ahead} |
||||
|
||||
## How to install Cataclysm DDA |
||||
|
||||
To install the latest stable release of Cataclysm DDA to your profile, execute |
||||
`nix-env -f "<nixpkgs>" -iA cataclysm-dda`. For the curses build (build |
||||
without tiles), install `cataclysmDDA.stable.curses`. Note: `cataclysm-dda` is |
||||
an alias to `cataclysmDDA.stable.tiles`. |
||||
|
||||
If you like access to a development build of your favorite git revision, |
||||
override `cataclysm-dda-git` (or `cataclysmDDA.git.curses` if you like curses |
||||
build): |
||||
|
||||
```nix |
||||
cataclysm-dda-git.override { |
||||
version = "YYYY-MM-DD"; |
||||
rev = "YOUR_FAVORITE_REVISION"; |
||||
sha256 = "CHECKSUM_OF_THE_REVISION"; |
||||
} |
||||
``` |
||||
|
||||
The sha256 checksum can be obtained by |
||||
|
||||
```sh |
||||
nix-prefetch-url --unpack "https://github.com/CleverRaven/Cataclysm-DDA/archive/${YOUR_FAVORITE_REVISION}.tar.gz" |
||||
``` |
||||
|
||||
The default configuration directory is `~/.cataclysm-dda`. If you prefer |
||||
`$XDG_CONFIG_HOME/cataclysm-dda`, override the derivation: |
||||
|
||||
```nix |
||||
cataclysm-dda.override { |
||||
useXdgDir = true; |
||||
} |
||||
``` |
||||
|
||||
## Important note for overriding packages |
||||
|
||||
After applying `overrideAttrs`, you need to fix `passthru.pkgs` and |
||||
`passthru.withMods` attributes either manually or by using `attachPkgs`: |
||||
|
||||
```nix |
||||
let |
||||
# You enabled parallel building. |
||||
myCDDA = cataclysm-dda-git.overrideAttrs (_: { |
||||
enableParallelBuilding = true; |
||||
}); |
||||
|
||||
# Unfortunately, this refers to the package before overriding and |
||||
# parallel building is still disabled. |
||||
badExample = myCDDA.withMods (_: []); |
||||
|
||||
inherit (cataclysmDDA) attachPkgs pkgs wrapCDDA; |
||||
|
||||
# You can fix it by hand |
||||
goodExample1 = myCDDA.overrideAttrs (old: { |
||||
passthru = old.passthru // { |
||||
pkgs = pkgs.override { build = goodExample1; }; |
||||
withMods = wrapCDDA goodExample1; |
||||
}; |
||||
}); |
||||
|
||||
# or by using a helper function `attachPkgs`. |
||||
goodExample2 = attachPkgs pkgs myCDDA; |
||||
in |
||||
|
||||
# badExample # parallel building disabled |
||||
# goodExample1.withMods (_: []) # parallel building enabled |
||||
goodExample2.withMods (_: []) # parallel building enabled |
||||
``` |
||||
|
||||
## Customizing with mods |
||||
|
||||
To install Cataclysm DDA with mods of your choice, you can use `withMods` |
||||
attribute: |
||||
|
||||
```nix |
||||
cataclysm-dda.withMods (mods: with mods; [ |
||||
tileset.UndeadPeople |
||||
]) |
||||
``` |
||||
|
||||
All mods, soundpacks, and tilesets available in nixpkgs are found in |
||||
`cataclysmDDA.pkgs`. |
||||
|
||||
Here is an example to modify existing mods and/or add more mods not available |
||||
in nixpkgs: |
||||
|
||||
```nix |
||||
let |
||||
customMods = self: super: lib.recursiveUpdate super { |
||||
# Modify existing mod |
||||
tileset.UndeadPeople = super.tileset.UndeadPeople.overrideAttrs (old: { |
||||
# If you like to apply a patch to the tileset for example |
||||
patches = [ ./path/to/your.patch ]; |
||||
}); |
||||
|
||||
# Add another mod |
||||
mod.Awesome = cataclysmDDA.buildMod { |
||||
modName = "Awesome"; |
||||
version = "0.x"; |
||||
src = fetchFromGitHub { |
||||
owner = "Someone"; |
||||
repo = "AwesomeMod"; |
||||
rev = "..."; |
||||
sha256 = "..."; |
||||
}; |
||||
# Path to be installed in the unpacked source (default: ".") |
||||
modRoot = "contents/under/this/path/will/be/installed"; |
||||
}; |
||||
|
||||
# Add another soundpack |
||||
soundpack.Fantastic = cataclysmDDA.buildSoundPack { |
||||
# ditto |
||||
}; |
||||
|
||||
# Add another tileset |
||||
tileset.SuperDuper = cataclysmDDA.buildTileSet { |
||||
# ditto |
||||
}; |
||||
}; |
||||
in |
||||
cataclysm-dda.withMods (mods: with mods.extend customMods; [ |
||||
tileset.UndeadPeople |
||||
mod.Awesome |
||||
soundpack.Fantastic |
||||
tileset.SuperDuper |
||||
]) |
||||
``` |
||||
@ -0,0 +1,32 @@ |
||||
# Citrix Workspace {#sec-citrix} |
||||
|
||||
The [Citrix Workspace App](https://www.citrix.com/products/workspace-app/) is a remote desktop viewer which provides access to [XenDesktop](https://www.citrix.com/products/xenapp-xendesktop/) installations. |
||||
|
||||
## Basic usage {#sec-citrix-base} |
||||
|
||||
The tarball archive needs to be downloaded manually as the license agreements of the vendor for [Citrix Workspace](https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html) needs to be accepted first. Then run `nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz`. With the archive available in the store the package can be built and installed with Nix. |
||||
|
||||
## Citrix Selfservice {#sec-citrix-selfservice} |
||||
|
||||
The [selfservice](https://support.citrix.com/article/CTX200337) is an application managing Citrix desktops and applications. Please note that this feature only works with at least citrix_workspace_20_06_0 and later versions. |
||||
|
||||
In order to set this up, you first have to [download the `.cr` file from the Netscaler Gateway](https://its.uiowa.edu/support/article/102186). After that you can configure the `selfservice` like this: |
||||
|
||||
```ShellSession |
||||
$ storebrowse -C ~/Downloads/receiverconfig.cr |
||||
$ selfservice |
||||
``` |
||||
|
||||
## Custom certificates {#sec-citrix-custom-certs} |
||||
|
||||
The `Citrix Workspace App` in `nixpkgs` trusts several certificates [from the Mozilla database](https://curl.haxx.se/docs/caextract.html) by default. However several companies using Citrix might require their own corporate certificate. On distros with imperative packaging these certs can be stored easily in [`$ICAROOT`](https://developer-docs.citrix.com/projects/receiver-for-linux-command-reference/en/13.7/), however this directory is a store path in `nixpkgs`. In order to work around this issue the package provides a simple mechanism to add custom certificates without rebuilding the entire package using `symlinkJoin`: |
||||
|
||||
```nix |
||||
with import <nixpkgs> { config.allowUnfree = true; }; |
||||
let |
||||
extraCerts = [ |
||||
./custom-cert-1.pem |
||||
./custom-cert-2.pem # ... |
||||
]; |
||||
in citrix_workspace.override { inherit extraCerts; } |
||||
``` |
||||
@ -0,0 +1,13 @@ |
||||
# DLib {#dlib} |
||||
|
||||
[DLib](http://dlib.net/) is a modern, C++-based toolkit which provides several machine learning algorithms. |
||||
|
||||
## Compiling without AVX support {#compiling-without-avx-support} |
||||
|
||||
Especially older CPUs don\'t support [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) (Advanced Vector Extensions) instructions that are used by DLib to optimize their algorithms. |
||||
|
||||
On the affected hardware errors like `Illegal instruction` will occur. In those cases AVX support needs to be disabled: |
||||
|
||||
```nix |
||||
self: super: { dlib = super.dlib.override { avxSupport = false; }; } |
||||
``` |
||||
@ -0,0 +1,64 @@ |
||||
# Eclipse {#sec-eclipse} |
||||
|
||||
The Nix expressions related to the Eclipse platform and IDE are in [`pkgs/applications/editors/eclipse`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/eclipse). |
||||
|
||||
Nixpkgs provides a number of packages that will install Eclipse in its various forms. These range from the bare-bones Eclipse Platform to the more fully featured Eclipse SDK or Scala-IDE packages and multiple version are often available. It is possible to list available Eclipse packages by issuing the command: |
||||
|
||||
```ShellSession |
||||
$ nix-env -f '<nixpkgs>' -qaP -A eclipses --description |
||||
``` |
||||
|
||||
Once an Eclipse variant is installed it can be run using the `eclipse` command, as expected. From within Eclipse it is then possible to install plugins in the usual manner by either manually specifying an Eclipse update site or by installing the Marketplace Client plugin and using it to discover and install other plugins. This installation method provides an Eclipse installation that closely resemble a manually installed Eclipse. |
||||
|
||||
If you prefer to install plugins in a more declarative manner then Nixpkgs also offer a number of Eclipse plugins that can be installed in an _Eclipse environment_. This type of environment is created using the function `eclipseWithPlugins` found inside the `nixpkgs.eclipses` attribute set. This function takes as argument `{ eclipse, plugins ? [], jvmArgs ? [] }` where `eclipse` is a one of the Eclipse packages described above, `plugins` is a list of plugin derivations, and `jvmArgs` is a list of arguments given to the JVM running the Eclipse. For example, say you wish to install the latest Eclipse Platform with the popular Eclipse Color Theme plugin and also allow Eclipse to use more RAM. You could then add |
||||
|
||||
```nix |
||||
packageOverrides = pkgs: { |
||||
myEclipse = with pkgs.eclipses; eclipseWithPlugins { |
||||
eclipse = eclipse-platform; |
||||
jvmArgs = [ "-Xmx2048m" ]; |
||||
plugins = [ plugins.color-theme ]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
to your Nixpkgs configuration (`~/.config/nixpkgs/config.nix`) and install it by running `nix-env -f '<nixpkgs>' -iA myEclipse` and afterward run Eclipse as usual. It is possible to find out which plugins are available for installation using `eclipseWithPlugins` by running |
||||
|
||||
```ShellSession |
||||
$ nix-env -f '<nixpkgs>' -qaP -A eclipses.plugins --description |
||||
``` |
||||
|
||||
If there is a need to install plugins that are not available in Nixpkgs then it may be possible to define these plugins outside Nixpkgs using the `buildEclipseUpdateSite` and `buildEclipsePlugin` functions found in the `nixpkgs.eclipses.plugins` attribute set. Use the `buildEclipseUpdateSite` function to install a plugin distributed as an Eclipse update site. This function takes `{ name, src }` as argument where `src` indicates the Eclipse update site archive. All Eclipse features and plugins within the downloaded update site will be installed. When an update site archive is not available then the `buildEclipsePlugin` function can be used to install a plugin that consists of a pair of feature and plugin JARs. This function takes an argument `{ name, srcFeature, srcPlugin }` where `srcFeature` and `srcPlugin` are the feature and plugin JARs, respectively. |
||||
|
||||
Expanding the previous example with two plugins using the above functions we have |
||||
|
||||
```nix |
||||
packageOverrides = pkgs: { |
||||
myEclipse = with pkgs.eclipses; eclipseWithPlugins { |
||||
eclipse = eclipse-platform; |
||||
jvmArgs = [ "-Xmx2048m" ]; |
||||
plugins = [ |
||||
plugins.color-theme |
||||
(plugins.buildEclipsePlugin { |
||||
name = "myplugin1-1.0"; |
||||
srcFeature = fetchurl { |
||||
url = "http://…/features/myplugin1.jar"; |
||||
sha256 = "123…"; |
||||
}; |
||||
srcPlugin = fetchurl { |
||||
url = "http://…/plugins/myplugin1.jar"; |
||||
sha256 = "123…"; |
||||
}; |
||||
}); |
||||
(plugins.buildEclipseUpdateSite { |
||||
name = "myplugin2-1.0"; |
||||
src = fetchurl { |
||||
stripRoot = false; |
||||
url = "http://…/myplugin2.zip"; |
||||
sha256 = "123…"; |
||||
}; |
||||
}); |
||||
]; |
||||
}; |
||||
} |
||||
``` |
||||
@ -0,0 +1,11 @@ |
||||
# Elm {#sec-elm} |
||||
|
||||
To start a development environment do |
||||
|
||||
```ShellSession |
||||
nix-shell -p elmPackages.elm elmPackages.elm-format |
||||
``` |
||||
|
||||
To update the Elm compiler, see <filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>. |
||||
|
||||
To package Elm applications, [read about elm2nix](https://github.com/hercules-ci/elm2nix#elm2nix). |
||||
@ -0,0 +1,119 @@ |
||||
# Emacs {#sec-emacs} |
||||
|
||||
## Configuring Emacs {#sec-emacs-config} |
||||
|
||||
The Emacs package comes with some extra helpers to make it easier to configure. `emacs.pkgs.withPackages` allows you to manage packages from ELPA. This means that you will not have to install that packages from within Emacs. For instance, if you wanted to use `company` `counsel`, `flycheck`, `ivy`, `magit`, `projectile`, and `use-package` you could use this as a `~/.config/nixpkgs/config.nix` override: |
||||
|
||||
```nix |
||||
{ |
||||
packageOverrides = pkgs: with pkgs; { |
||||
myEmacs = emacs.pkgs.withPackages (epkgs: (with epkgs.melpaStablePackages; [ |
||||
company |
||||
counsel |
||||
flycheck |
||||
ivy |
||||
magit |
||||
projectile |
||||
use-package |
||||
])); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
You can install it like any other packages via `nix-env -iA myEmacs`. However, this will only install those packages. It will not `configure` them for us. To do this, we need to provide a configuration file. Luckily, it is possible to do this from within Nix! By modifying the above example, we can make Emacs load a custom config file. The key is to create a package that provide a `default.el` file in `/share/emacs/site-start/`. Emacs knows to load this file automatically when it starts. |
||||
|
||||
```nix |
||||
{ |
||||
packageOverrides = pkgs: with pkgs; rec { |
||||
myEmacsConfig = writeText "default.el" '' |
||||
;; initialize package |
||||
|
||||
(require 'package) |
||||
(package-initialize 'noactivate) |
||||
(eval-when-compile |
||||
(require 'use-package)) |
||||
|
||||
;; load some packages |
||||
|
||||
(use-package company |
||||
:bind ("<C-tab>" . company-complete) |
||||
:diminish company-mode |
||||
:commands (company-mode global-company-mode) |
||||
:defer 1 |
||||
:config |
||||
(global-company-mode)) |
||||
|
||||
(use-package counsel |
||||
:commands (counsel-descbinds) |
||||
:bind (([remap execute-extended-command] . counsel-M-x) |
||||
("C-x C-f" . counsel-find-file) |
||||
("C-c g" . counsel-git) |
||||
("C-c j" . counsel-git-grep) |
||||
("C-c k" . counsel-ag) |
||||
("C-x l" . counsel-locate) |
||||
("M-y" . counsel-yank-pop))) |
||||
|
||||
(use-package flycheck |
||||
:defer 2 |
||||
:config (global-flycheck-mode)) |
||||
|
||||
(use-package ivy |
||||
:defer 1 |
||||
:bind (("C-c C-r" . ivy-resume) |
||||
("C-x C-b" . ivy-switch-buffer) |
||||
:map ivy-minibuffer-map |
||||
("C-j" . ivy-call)) |
||||
:diminish ivy-mode |
||||
:commands ivy-mode |
||||
:config |
||||
(ivy-mode 1)) |
||||
|
||||
(use-package magit |
||||
:defer |
||||
:if (executable-find "git") |
||||
:bind (("C-x g" . magit-status) |
||||
("C-x G" . magit-dispatch-popup)) |
||||
:init |
||||
(setq magit-completing-read-function 'ivy-completing-read)) |
||||
|
||||
(use-package projectile |
||||
:commands projectile-mode |
||||
:bind-keymap ("C-c p" . projectile-command-map) |
||||
:defer 5 |
||||
:config |
||||
(projectile-global-mode)) |
||||
''; |
||||
|
||||
myEmacs = emacs.pkgs.withPackages (epkgs: (with epkgs.melpaStablePackages; [ |
||||
(runCommand "default.el" {} '' |
||||
mkdir -p $out/share/emacs/site-lisp |
||||
cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el |
||||
'') |
||||
company |
||||
counsel |
||||
flycheck |
||||
ivy |
||||
magit |
||||
projectile |
||||
use-package |
||||
])); |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
This provides a fairly full Emacs start file. It will load in addition to the user's presonal config. You can always disable it by passing `-q` to the Emacs command. |
||||
|
||||
Sometimes `emacs.pkgs.withPackages` is not enough, as this package set has some priorities imposed on packages (with the lowest priority assigned to Melpa Unstable, and the highest for packages manually defined in `pkgs/top-level/emacs-packages.nix`). But you can't control this priorities when some package is installed as a dependency. You can override it on per-package-basis, providing all the required dependencies manually - but it's tedious and there is always a possibility that an unwanted dependency will sneak in through some other package. To completely override such a package you can use `overrideScope'`. |
||||
|
||||
```nix |
||||
overrides = self: super: rec { |
||||
haskell-mode = self.melpaPackages.haskell-mode; |
||||
... |
||||
}; |
||||
((emacsPackagesFor emacs).overrideScope' overrides).emacs.pkgs.withPackages |
||||
(p: with p; [ |
||||
# here both these package will use haskell-mode of our own choice |
||||
ghc-mod |
||||
dante |
||||
]) |
||||
``` |
||||
@ -0,0 +1,49 @@ |
||||
# Firefox {#sec-firefox} |
||||
|
||||
## Build wrapped Firefox with extensions and policies |
||||
|
||||
The `wrapFirefox` function allows to pass policies, preferences and extension that are available to firefox. With the help of `fetchFirefoxAddon` this allows build a firefox version that already comes with addons pre-installed: |
||||
|
||||
```nix |
||||
{ |
||||
myFirefox = wrapFirefox firefox-unwrapped { |
||||
nixExtensions = [ |
||||
(fetchFirefoxAddon { |
||||
name = "ublock"; # Has to be unique! |
||||
url = "https://addons.mozilla.org/firefox/downloads/file/3679754/ublock_origin-1.31.0-an+fx.xpi"; |
||||
sha256 = "1h768ljlh3pi23l27qp961v1hd0nbj2vasgy11bmcrlqp40zgvnr"; |
||||
}) |
||||
]; |
||||
|
||||
extraPolicies = { |
||||
CaptivePortal = false; |
||||
DisableFirefoxStudies = true; |
||||
DisablePocket = true; |
||||
DisableTelemetry = true; |
||||
DisableFirefoxAccounts = true; |
||||
FirefoxHome = { |
||||
Pocket = false; |
||||
Snippets = false; |
||||
}; |
||||
UserMessaging = { |
||||
ExtensionRecommendations = false; |
||||
SkipOnboarding = true; |
||||
}; |
||||
}; |
||||
|
||||
extraPrefs = '' |
||||
// Show more ssl cert infos |
||||
lockPref("security.identityblock.show_extended_validation", true); |
||||
''; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
If `nixExtensions != null` then all manually installed addons will be uninstalled from your browser profile. |
||||
To view available enterprise policies visit [enterprise policies](https://github.com/mozilla/policy-templates#enterprisepoliciesenabled) |
||||
or type into the Firefox url bar: `about:policies#documentation`. |
||||
Nix installed addons do not have a valid signature, which is why signature verification is disabled. This does not compromise security because downloaded addons are checksumed and manual addons can't be installed. Also make sure that the `name` field of fetchFirefoxAddon is unique. If you remove an addon from the nixExtensions array, rebuild and start Firefox the removed addon will be completly removed with all of its settings. |
||||
|
||||
## Troubleshooting {#sec-firefox-troubleshooting} |
||||
If addons do not appear installed although they have been defined in your nix configuration file reset the local addon state of your Firefox profile by clicking `help -> restart with addons disabled -> restart -> refresh firefox`. This can happen if you switch from manual addon mode to nix addon mode and then back to manual mode and then again to nix addon mode. |
||||
|
||||
@ -0,0 +1,50 @@ |
||||
# Fish {#sec-fish} |
||||
|
||||
Fish is a "smart and user-friendly command line shell" with support for plugins. |
||||
|
||||
|
||||
## Vendor Fish scripts {#sec-fish-vendor} |
||||
|
||||
Any package may ship its own Fish completions, configuration snippets, and |
||||
functions. Those should be installed to |
||||
`$out/share/fish/vendor_{completions,conf,functions}.d` respectively. |
||||
|
||||
When the `programs.fish.enable` and |
||||
`programs.fish.vendor.{completions,config,functions}.enable` options from the |
||||
NixOS Fish module are set to true, those paths are symlinked in the current |
||||
system environment and automatically loaded by Fish. |
||||
|
||||
|
||||
## Packaging Fish plugins {#sec-fish-plugins-pkg} |
||||
|
||||
While packages providing standalone executables belong to the top level, |
||||
packages which have the sole purpose of extending Fish belong to the |
||||
`fishPlugins` scope and should be registered in |
||||
`pkgs/shells/fish/plugins/default.nix`. |
||||
|
||||
The `buildFishPlugin` utility function can be used to automatically copy Fish |
||||
scripts from `$src/{completions,conf,conf.d,functions}` to the standard vendor |
||||
installation paths. It also sets up the test environment so that the optional |
||||
`checkPhase` is executed in a Fish shell with other already packaged plugins |
||||
and package-local Fish functions specified in `checkPlugins` and |
||||
`checkFunctionDirs` respectively. |
||||
|
||||
See `pkgs/shells/fish/plugins/pure.nix` for an example of Fish plugin package |
||||
using `buildFishPlugin` and running unit tests with the `fishtape` test runner. |
||||
|
||||
|
||||
## Fish wrapper {#sec-fish-wrapper} |
||||
|
||||
The `wrapFish` package is a wrapper around Fish which can be used to create |
||||
Fish shells initialised with some plugins as well as completions, configuration |
||||
snippets and functions sourced from the given paths. This provides a convenient |
||||
way to test Fish plugins and scripts without having to alter the environment. |
||||
|
||||
```nix |
||||
wrapFish { |
||||
pluginPkgs = with fishPlugins; [ pure foreign-env ]; |
||||
completionDirs = []; |
||||
functionDirs = []; |
||||
confDirs = [ "/path/to/some/fish/init/dir/" ]; |
||||
} |
||||
``` |
||||
@ -0,0 +1,45 @@ |
||||
# FUSE {#sec-fuse} |
||||
|
||||
Some packages rely on |
||||
[FUSE](https://www.kernel.org/doc/html/latest/filesystems/fuse.html) to provide |
||||
support for additional filesystems not supported by the kernel. |
||||
|
||||
In general, FUSE software are primarily developed for Linux but many of them can |
||||
also run on macOS. Nixpkgs supports FUSE packages on macOS, but it requires |
||||
[macFUSE](https://osxfuse.github.io) to be installed outside of Nix. macFUSE |
||||
currently isn't packaged in Nixpkgs mainly because it includes a kernel |
||||
extension, which isn't supported by Nix outside of NixOS. |
||||
|
||||
If a package fails to run on macOS with an error message similar to the |
||||
following, it's a likely sign that you need to have macFUSE installed. |
||||
|
||||
dyld: Library not loaded: /usr/local/lib/libfuse.2.dylib |
||||
Referenced from: /nix/store/w8bi72bssv0bnxhwfw3xr1mvn7myf37x-sshfs-fuse-2.10/bin/sshfs |
||||
Reason: image not found |
||||
[1] 92299 abort /nix/store/w8bi72bssv0bnxhwfw3xr1mvn7myf37x-sshfs-fuse-2.10/bin/sshfs |
||||
|
||||
Package maintainers may often encounter the following error when building FUSE |
||||
packages on macOS: |
||||
|
||||
checking for fuse.h... no |
||||
configure: error: No fuse.h found. |
||||
|
||||
This happens on autoconf based projects that uses `AC_CHECK_HEADERS` or |
||||
`AC_CHECK_LIBS` to detect libfuse, and will occur even when the `fuse` package |
||||
is included in `buildInputs`. It happens because libfuse headers throw an error |
||||
on macOS if the `FUSE_USE_VERSION` macro is undefined. Many proejcts do define |
||||
`FUSE_USE_VERSION`, but only inside C source files. This results in the above |
||||
error at configure time because the configure script would attempt to compile |
||||
sample FUSE programs without defining `FUSE_USE_VERSION`. |
||||
|
||||
There are two possible solutions for this problem in Nixpkgs: |
||||
|
||||
1. Pass `FUSE_USE_VERSION` to the configure script by adding |
||||
`CFLAGS=-DFUSE_USE_VERSION=25` in `configureFlags`. The actual value would |
||||
have to match the definition used in the upstream source code. |
||||
2. Remove `AC_CHECK_HEADERS` / `AC_CHECK_LIBS` for libfuse. |
||||
|
||||
However, a better solution might be to fix the build script upstream to use |
||||
`PKG_CHECK_MODULES` instead. This approach wouldn't suffer from the problem that |
||||
`AC_CHECK_HEADERS`/`AC_CHECK_LIBS` has at the price of introducing a dependency |
||||
on pkg-config. |
||||
@ -0,0 +1,38 @@ |
||||
# ibus-engines.typing-booster {#sec-ibus-typing-booster} |
||||
|
||||
This package is an ibus-based completion method to speed up typing. |
||||
|
||||
## Activating the engine {#sec-ibus-typing-booster-activate} |
||||
|
||||
IBus needs to be configured accordingly to activate `typing-booster`. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the [upstream docs](https://mike-fabian.github.io/ibus-typing-booster/documentation.html). |
||||
|
||||
On NixOS you need to explicitly enable `ibus` with given engines before customizing your desktop to use `typing-booster`. This can be achieved using the `ibus` module: |
||||
|
||||
```nix |
||||
{ pkgs, ... }: { |
||||
i18n.inputMethod = { |
||||
enabled = "ibus"; |
||||
ibus.engines = with pkgs.ibus-engines; [ typing-booster ]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
## Using custom hunspell dictionaries {#sec-ibus-typing-booster-customize-hunspell} |
||||
|
||||
The IBus engine is based on `hunspell` to support completion in many languages. By default the dictionaries `de-de`, `en-us`, `fr-moderne` `es-es`, `it-it`, `sv-se` and `sv-fi` are in use. To add another dictionary, the package can be overridden like this: |
||||
|
||||
```nix |
||||
ibus-engines.typing-booster.override { langs = [ "de-at" "en-gb" ]; } |
||||
``` |
||||
|
||||
_Note: each language passed to `langs` must be an attribute name in `pkgs.hunspellDicts`._ |
||||
|
||||
## Built-in emoji picker {#sec-ibus-typing-booster-emoji-picker} |
||||
|
||||
The `ibus-engines.typing-booster` package contains a program named `emoji-picker`. To display all emojis correctly, a special font such as `noto-fonts-emoji` is needed: |
||||
|
||||
On NixOS it can be installed using the following expression: |
||||
|
||||
```nix |
||||
{ pkgs, ... }: { fonts.fonts = with pkgs; [ noto-fonts-emoji ]; } |
||||
``` |
||||
@ -0,0 +1,28 @@ |
||||
<chapter xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="chap-packages"> |
||||
<title>Packages</title> |
||||
<para> |
||||
This chapter contains information about how to use and maintain the Nix expressions for a number of specific packages, such as the Linux kernel or X.org. |
||||
</para> |
||||
<xi:include href="citrix.section.xml" /> |
||||
<xi:include href="dlib.section.xml" /> |
||||
<xi:include href="eclipse.section.xml" /> |
||||
<xi:include href="elm.section.xml" /> |
||||
<xi:include href="emacs.section.xml" /> |
||||
<xi:include href="firefox.section.xml" /> |
||||
<xi:include href="fish.section.xml" /> |
||||
<xi:include href="fuse.section.xml" /> |
||||
<xi:include href="ibus.section.xml" /> |
||||
<xi:include href="kakoune.section.xml" /> |
||||
<xi:include href="linux.section.xml" /> |
||||
<xi:include href="locales.section.xml" /> |
||||
<xi:include href="nginx.section.xml" /> |
||||
<xi:include href="opengl.section.xml" /> |
||||
<xi:include href="shell-helpers.section.xml" /> |
||||
<xi:include href="steam.section.xml" /> |
||||
<xi:include href="cataclysm-dda.section.xml" /> |
||||
<xi:include href="urxvt.section.xml" /> |
||||
<xi:include href="weechat.section.xml" /> |
||||
<xi:include href="xorg.section.xml" /> |
||||
</chapter> |
||||
@ -0,0 +1,9 @@ |
||||
# Kakoune {#sec-kakoune} |
||||
|
||||
Kakoune can be built to autoload plugins: |
||||
|
||||
```nix |
||||
(kakoune.override { |
||||
plugins = with pkgs.kakounePlugins; [ parinfer-rust ]; |
||||
}) |
||||
``` |
||||
@ -0,0 +1,41 @@ |
||||
# Linux kernel {#sec-linux-kernel} |
||||
|
||||
The Nix expressions to build the Linux kernel are in [`pkgs/os-specific/linux/kernel`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel). |
||||
|
||||
The function that builds the kernel has an argument `kernelPatches` which should be a list of `{name, patch, extraConfig}` attribute sets, where `name` is the name of the patch (which is included in the kernel’s `meta.description` attribute), `patch` is the patch itself (possibly compressed), and `extraConfig` (optional) is a string specifying extra options to be concatenated to the kernel configuration file (`.config`). |
||||
|
||||
The kernel derivation exports an attribute `features` specifying whether optional functionality is or isn’t enabled. This is used in NixOS to implement kernel-specific behaviour. For instance, if the kernel has the `iwlwifi` feature (i.e. has built-in support for Intel wireless chipsets), then NixOS doesn’t have to build the external `iwlwifi` package: |
||||
|
||||
```nix |
||||
modulesTree = [kernel] |
||||
++ pkgs.lib.optional (!kernel.features ? iwlwifi) kernelPackages.iwlwifi |
||||
++ ...; |
||||
``` |
||||
|
||||
How to add a new (major) version of the Linux kernel to Nixpkgs: |
||||
|
||||
1. Copy the old Nix expression (e.g. `linux-2.6.21.nix`) to the new one (e.g. `linux-2.6.22.nix`) and update it. |
||||
|
||||
2. Add the new kernel to `all-packages.nix` (e.g., create an attribute `kernel_2_6_22`). |
||||
|
||||
3. Now we’re going to update the kernel configuration. First unpack the kernel. Then for each supported platform (`i686`, `x86_64`, `uml`) do the following: |
||||
|
||||
1. Make an copy from the old config (e.g. `config-2.6.21-i686-smp`) to the new one (e.g. `config-2.6.22-i686-smp`). |
||||
|
||||
2. Copy the config file for this platform (e.g. `config-2.6.22-i686-smp`) to `.config` in the kernel source tree. |
||||
|
||||
3. Run `make oldconfig ARCH={i386,x86_64,um}` and answer all questions. (For the uml configuration, also add `SHELL=bash`.) Make sure to keep the configuration consistent between platforms (i.e. don’t enable some feature on `i686` and disable it on `x86_64`). |
||||
|
||||
4. If needed you can also run `make menuconfig`: |
||||
|
||||
```ShellSession |
||||
$ nix-env -i ncurses |
||||
$ export NIX_CFLAGS_LINK=-lncurses |
||||
$ make menuconfig ARCH=arch |
||||
``` |
||||
|
||||
5. Copy `.config` over the new config file (e.g. `config-2.6.22-i686-smp`). |
||||
|
||||
4. Test building the kernel: `nix-build -A kernel_2_6_22`. If it compiles, ship it! For extra credit, try booting NixOS with it. |
||||
|
||||
5. It may be that the new kernel requires updating the external kernel modules and kernel-dependent packages listed in the `linuxPackagesFor` function in `all-packages.nix` (such as the NVIDIA drivers, AUFS, etc.). If the updated packages aren’t backwards compatible with older kernels, you may need to keep the older versions around. |
||||
@ -0,0 +1,5 @@ |
||||
# Locales {#locales} |
||||
|
||||
To allow simultaneous use of packages linked against different versions of `glibc` with different locale archive formats Nixpkgs patches `glibc` to rely on `LOCALE_ARCHIVE` environment variable. |
||||
|
||||
On non-NixOS distributions this variable is obviously not set. This can cause regressions in language support or even crashes in some Nixpkgs-provided programs. The simplest way to mitigate this problem is exporting the `LOCALE_ARCHIVE` variable pointing to `${glibcLocales}/lib/locale/locale-archive`. The drawback (and the reason this is not the default) is the relatively large (a hundred MiB) size of the full set of locales. It is possible to build a custom set of locales by overriding parameters `allLocales` and `locales` of the package. |
||||
@ -0,0 +1,11 @@ |
||||
# Nginx {#sec-nginx} |
||||
|
||||
[Nginx](https://nginx.org) is a reverse proxy and lightweight webserver. |
||||
|
||||
## ETags on static files served from the Nix store {#sec-nginx-etag} |
||||
|
||||
HTTP has a couple different mechanisms for caching to prevent clients from having to download the same content repeatedly if a resource has not changed since the last time it was requested. When nginx is used as a server for static files, it implements the caching mechanism based on the [`Last-Modified`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified) response header automatically; unfortunately, it works by using filesystem timestamps to determine the value of the `Last-Modified` header. This doesn't give the desired behavior when the file is in the Nix store, because all file timestamps are set to 0 (for reasons related to build reproducibility). |
||||
|
||||
Fortunately, HTTP supports an alternative (and more effective) caching mechanism: the [`ETag`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) response header. The value of the `ETag` header specifies some identifier for the particular content that the server is sending (e.g. a hash). When a client makes a second request for the same resource, it sends that value back in an `If-None-Match` header. If the ETag value is unchanged, then the server does not need to resend the content. |
||||
|
||||
As of NixOS 19.09, the nginx package in Nixpkgs is patched such that when nginx serves a file out of `/nix/store`, the hash in the store path is used as the `ETag` header in the HTTP response, thus providing proper caching functionality. This happens automatically; you do not need to do modify any configuration to get this behavior. |
||||
@ -0,0 +1,15 @@ |
||||
# OpenGL {#sec-opengl} |
||||
|
||||
OpenGL support varies depending on which hardware is used and which drivers are available and loaded. |
||||
|
||||
Broadly, we support both GL vendors: Mesa and NVIDIA. |
||||
|
||||
## NixOS Desktop |
||||
|
||||
The NixOS desktop or other non-headless configurations are the primary target for OpenGL libraries and applications. The current solution for discovering which drivers are available is based on [libglvnd](https://gitlab.freedesktop.org/glvnd/libglvnd). `libglvnd` performs "vendor-neutral dispatch", trying a variety of techniques to find the system's GL implementation. In practice, this will be either via standard GLX for X11 users or EGL for Wayland users, and supporting either NVIDIA or Mesa extensions. |
||||
|
||||
## Nix on GNU/Linux |
||||
|
||||
If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of `libglvnd` and `mesa.drivers` in `LD_LIBRARY_PATH`. For Mesa drivers, the Linux kernel version doesn't have to match nixpkgs. |
||||
|
||||
For proprietary video drivers you might have luck with also adding the corresponding video driver package. |
||||
@ -0,0 +1,12 @@ |
||||
# Interactive shell helpers {#sec-shell-helpers} |
||||
|
||||
Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard `share` directory location. This is why a bunch `PACKAGE-share` scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following: |
||||
|
||||
- `fzf` : `fzf-share` |
||||
|
||||
E.g. `fzf` can then used in the `.bashrc` like this: |
||||
|
||||
```bash |
||||
source "$(fzf-share)/completion.bash" |
||||
source "$(fzf-share)/key-bindings.bash" |
||||
``` |
||||
@ -0,0 +1,69 @@ |
||||
# Steam {#sec-steam} |
||||
|
||||
## Steam in Nix {#sec-steam-nix} |
||||
|
||||
Steam is distributed as a `.deb` file, for now only as an i686 package (the amd64 package only has documentation). When unpacked, it has a script called `steam` that in Ubuntu (their target distro) would go to `/usr/bin`. When run for the first time, this script copies some files to the user's home, which include another script that is the ultimate responsible for launching the steam binary, which is also in \$HOME. |
||||
|
||||
Nix problems and constraints: |
||||
|
||||
- We don't have `/bin/bash` and many scripts point there. Similarly for `/usr/bin/python`. |
||||
- We don't have the dynamic loader in `/lib`. |
||||
- The `steam.sh` script in \$HOME can not be patched, as it is checked and rewritten by steam. |
||||
- The steam binary cannot be patched, it's also checked. |
||||
|
||||
The current approach to deploy Steam in NixOS is composing a FHS-compatible chroot environment, as documented [here](http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html). This allows us to have binaries in the expected paths without disrupting the system, and to avoid patching them to work in a non FHS environment. |
||||
|
||||
## How to play {#sec-steam-play} |
||||
|
||||
Use `programs.steam.enable = true;` if you want to add steam to systemPackages and also enable a few workarrounds aswell as Steam controller support or other Steam supported controllers such as the DualShock 4 or Nintendo Switch Pr. |
||||
|
||||
## Troubleshooting {#sec-steam-troub} |
||||
|
||||
- **Steam fails to start. What do I do?** |
||||
Try to run |
||||
|
||||
```ShellSession |
||||
strace steam |
||||
``` |
||||
|
||||
to see what is causing steam to fail. |
||||
|
||||
- **Using the FOSS Radeon or nouveau (nvidia) drivers** |
||||
|
||||
- The `newStdcpp` parameter was removed since NixOS 17.09 and should not be needed anymore. |
||||
- Steam ships statically linked with a version of libcrypto that conflics with the one dynamically loaded by radeonsi_dri.so. If you get the error |
||||
``` |
||||
steam.sh: line 713: 7842 Segmentation fault (core dumped) |
||||
``` |
||||
have a look at [this pull request](https://github.com/NixOS/nixpkgs/pull/20269). |
||||
|
||||
- **Java** |
||||
|
||||
1. There is no java in steam chrootenv by default. If you get a message like |
||||
|
||||
``` |
||||
/home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found |
||||
``` |
||||
|
||||
You need to add |
||||
|
||||
```nix |
||||
steam.override { withJava = true; }; |
||||
``` |
||||
|
||||
## steam-run {#sec-steam-run} |
||||
|
||||
The FHS-compatible chroot used for steam can also be used to run other linux games that expect a FHS environment. To do it, add |
||||
|
||||
```nix |
||||
pkgs.steam.override ({ |
||||
nativeOnly = true; |
||||
newStdcpp = true; |
||||
}).run |
||||
``` |
||||
|
||||
to your configuration, rebuild, and run the game with |
||||
|
||||
``` |
||||
steam-run ./foo |
||||
``` |
||||
@ -0,0 +1,13 @@ |
||||
<section xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" |
||||
xml:id="unfree-software"> |
||||
<title>Unfree software</title> |
||||
|
||||
<para> |
||||
All users of Nixpkgs are free software users, and many users (and developers) of Nixpkgs want to limit and tightly control their exposure to unfree software. At the same time, many users need (or want) to run some specific pieces of proprietary software. Nixpkgs includes some expressions for unfree software packages. By default unfree software cannot be installed and doesn’t show up in searches. To allow installing unfree software in a single Nix invocation one can export <literal>NIXPKGS_ALLOW_UNFREE=1</literal>. For a persistent solution, users can set <literal>allowUnfree</literal> in the Nixpkgs configuration. |
||||
</para> |
||||
|
||||
<para> |
||||
Fine-grained control is possible by defining <literal>allowUnfreePredicate</literal> function in config; it takes the <literal>mkDerivation</literal> parameter attrset and returns <literal>true</literal> for unfree packages that should be allowed. |
||||
</para> |
||||
</section> |
||||
@ -0,0 +1,71 @@ |
||||
# Urxvt {#sec-urxvt} |
||||
|
||||
Urxvt, also known as rxvt-unicode, is a highly customizable terminal emulator. |
||||
|
||||
## Configuring urxvt {#sec-urxvt-conf} |
||||
|
||||
In `nixpkgs`, urxvt is provided by the package `rxvt-unicode`. It can be configured to include your choice of plugins, reducing its closure size from the default configuration which includes all available plugins. To make use of this functionality, use an overlay or directly install an expression that overrides its configuration, such as |
||||
|
||||
```nix |
||||
rxvt-unicode.override { |
||||
configure = { availablePlugins, ... }: { |
||||
plugins = with availablePlugins; [ perls resize-font vtwheel ]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
If the `configure` function returns an attrset without the `plugins` attribute, `availablePlugins` will be used automatically. |
||||
|
||||
In order to add plugins but also keep all default plugins installed, it is possible to use the following method: |
||||
|
||||
```nix |
||||
rxvt-unicode.override { |
||||
configure = { availablePlugins, ... }: { |
||||
plugins = (builtins.attrValues availablePlugins) ++ [ custom-plugin ]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
To get a list of all the plugins available, open the Nix REPL and run |
||||
|
||||
```ShellSession |
||||
$ nix repl |
||||
:l <nixpkgs> |
||||
map (p: p.name) pkgs.rxvt-unicode.plugins |
||||
``` |
||||
|
||||
Alternatively, if your shell is bash or zsh and have completion enabled, simply type `nixpkgs.rxvt-unicode.plugins.<tab>`. |
||||
|
||||
In addition to `plugins` the options `extraDeps` and `perlDeps` can be used to install extra packages. `extraDeps` can be used, for example, to provide `xsel` (a clipboard manager) to the clipboard plugin, without installing it globally: |
||||
|
||||
```nix |
||||
rxvt-unicode.override { |
||||
configure = { availablePlugins, ... }: { |
||||
pluginsDeps = [ xsel ]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
`perlDeps` is a handy way to provide Perl packages to your custom plugins (in `$HOME/.urxvt/ext`). For example, if you need `AnyEvent` you can do: |
||||
|
||||
```nix |
||||
rxvt-unicode.override { |
||||
configure = { availablePlugins, ... }: { |
||||
perlDeps = with perlPackages; [ AnyEvent ]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
## Packaging urxvt plugins {#sec-urxvt-pkg} |
||||
|
||||
Urxvt plugins resides in `pkgs/applications/misc/rxvt-unicode-plugins`. To add a new plugin create an expression in a subdirectory and add the package to the set in `pkgs/applications/misc/rxvt-unicode-plugins/default.nix`. |
||||
|
||||
A plugin can be any kind of derivation, the only requirement is that it should always install perl scripts in `$out/lib/urxvt/perl`. Look for existing plugins for examples. |
||||
|
||||
If the plugin is itself a perl package that needs to be imported from other plugins or scripts, add the following passthrough: |
||||
|
||||
```nix |
||||
passthru.perlPackages = [ "self" ]; |
||||
``` |
||||
|
||||
This will make the urxvt wrapper pick up the dependency and set up the perl path accordingly. |
||||
@ -0,0 +1,85 @@ |
||||
# Weechat {#sec-weechat} |
||||
|
||||
Weechat can be configured to include your choice of plugins, reducing its closure size from the default configuration which includes all available plugins. To make use of this functionality, install an expression that overrides its configuration such as |
||||
|
||||
```nix |
||||
weechat.override {configure = {availablePlugins, ...}: { |
||||
plugins = with availablePlugins; [ python perl ]; |
||||
} |
||||
} |
||||
``` |
||||
|
||||
If the `configure` function returns an attrset without the `plugins` attribute, `availablePlugins` will be used automatically. |
||||
|
||||
The plugins currently available are `python`, `perl`, `ruby`, `guile`, `tcl` and `lua`. |
||||
|
||||
The python and perl plugins allows the addition of extra libraries. For instance, the `inotify.py` script in `weechat-scripts` requires D-Bus or libnotify, and the `fish.py` script requires `pycrypto`. To use these scripts, use the plugin's `withPackages` attribute: |
||||
|
||||
```nix |
||||
weechat.override { configure = {availablePlugins, ...}: { |
||||
plugins = with availablePlugins; [ |
||||
(python.withPackages (ps: with ps; [ pycrypto python-dbus ])) |
||||
]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
In order to also keep all default plugins installed, it is possible to use the following method: |
||||
|
||||
```nix |
||||
weechat.override { configure = { availablePlugins, ... }: { |
||||
plugins = builtins.attrValues (availablePlugins // { |
||||
python = availablePlugins.python.withPackages (ps: with ps; [ pycrypto python-dbus ]); |
||||
}); |
||||
}; } |
||||
``` |
||||
|
||||
WeeChat allows to set defaults on startup using the `--run-command`. The `configure` method can be used to pass commands to the program: |
||||
|
||||
```nix |
||||
weechat.override { |
||||
configure = { availablePlugins, ... }: { |
||||
init = '' |
||||
/set foo bar |
||||
/server add freenode chat.freenode.org |
||||
''; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
Further values can be added to the list of commands when running `weechat --run-command "your-commands"`. |
||||
|
||||
Additionally it's possible to specify scripts to be loaded when starting `weechat`. These will be loaded before the commands from `init`: |
||||
|
||||
```nix |
||||
weechat.override { |
||||
configure = { availablePlugins, ... }: { |
||||
scripts = with pkgs.weechatScripts; [ |
||||
weechat-xmpp weechat-matrix-bridge wee-slack |
||||
]; |
||||
init = '' |
||||
/set plugins.var.python.jabber.key "val" |
||||
'': |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
In `nixpkgs` there's a subpackage which contains derivations for WeeChat scripts. Such derivations expect a `passthru.scripts` attribute which contains a list of all scripts inside the store path. Furthermore all scripts have to live in `$out/share`. An exemplary derivation looks like this: |
||||
|
||||
```nix |
||||
{ stdenv, fetchurl }: |
||||
|
||||
stdenv.mkDerivation { |
||||
name = "exemplary-weechat-script"; |
||||
src = fetchurl { |
||||
url = "https://scripts.tld/your-scripts.tar.gz"; |
||||
sha256 = "..."; |
||||
}; |
||||
passthru.scripts = [ "foo.py" "bar.lua" ]; |
||||
installPhase = '' |
||||
mkdir $out/share |
||||
cp foo.py $out/share |
||||
cp bar.lua $out/share |
||||
''; |
||||
} |
||||
``` |
||||
@ -0,0 +1,34 @@ |
||||
# X.org {#sec-xorg} |
||||
|
||||
The Nix expressions for the X.org packages reside in `pkgs/servers/x11/xorg/default.nix`. This file is automatically generated from lists of tarballs in an X.org release. As such it should not be modified directly; rather, you should modify the lists, the generator script or the file `pkgs/servers/x11/xorg/overrides.nix`, in which you can override or add to the derivations produced by the generator. |
||||
|
||||
## Katamari Tarballs |
||||
|
||||
X.org upstream releases used to include [katamari](https://en.wiktionary.org/wiki/%E3%81%8B%E3%81%9F%E3%81%BE%E3%82%8A) releases, which included a holistic recommended version for each tarball, up until 7.7. To create a list of tarballs in a katamari release: |
||||
|
||||
```ShellSession |
||||
export release="X11R7.7" |
||||
export url="mirror://xorg/$release/src/everything/" |
||||
cat $(PRINT_PATH=1 nix-prefetch-url $url | tail -n 1) \ |
||||
| perl -e 'while (<>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'url'}$2\n"; }; }' \ |
||||
| sort > "tarballs-$release.list" |
||||
``` |
||||
|
||||
## Individual Tarballs |
||||
|
||||
The upstream release process for [X11R7.8](https://x.org/wiki/Releases/7.8/) does not include a planned katamari. Instead, each component of X.org is released as its own tarball. We maintain `pkgs/servers/x11/xorg/tarballs.list` as a list of tarballs for each individual package. This list includes X.org core libraries and protocol descriptions, extra newer X11 interface libraries, like `xorg.libxcb`, and classic utilities which are largely unused but still available if needed, like `xorg.imake`. |
||||
|
||||
## Generating Nix Expressions |
||||
|
||||
The generator is invoked as follows: |
||||
|
||||
```ShellSession |
||||
cd pkgs/servers/x11/xorg |
||||
<tarballs.list perl ./generate-expr-from-tarballs.pl |
||||
``` |
||||
|
||||
For each of the tarballs in the `.list` files, the script downloads it, unpacks it, and searches its `configure.ac` and `*.pc.in` files for dependencies. This information is used to generate `default.nix`. The generator caches downloaded tarballs between runs. Pay close attention to the `NOT FOUND: $NAME` messages at the end of the run, since they may indicate missing dependencies. (Some might be optional dependencies, however.) |
||||
|
||||
## Overriding the Generator |
||||
|
||||
If the expression for a package requires derivation attributes that the generator cannot figure out automatically (say, `patches` or a `postInstall` hook), you should modify `pkgs/servers/x11/xorg/overrides.nix`. |
||||
@ -0,0 +1,10 @@ |
||||
<chapter xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="chap-special"> |
||||
<title>Special builders</title> |
||||
<para> |
||||
This chapter describes several special builders. |
||||
</para> |
||||
<xi:include href="special/fhs-environments.section.xml" /> |
||||
<xi:include href="special/mkshell.section.xml" /> |
||||
</chapter> |
||||
@ -0,0 +1,45 @@ |
||||
# buildFHSUserEnv {#sec-fhs-environments} |
||||
|
||||
`buildFHSUserEnv` provides a way to build and run FHS-compatible lightweight sandboxes. It creates an isolated root with bound `/nix/store`, so its footprint in terms of disk space needed is quite small. This allows one to run software which is hard or unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions, games distributed as tarballs, software with integrity checking and/or external self-updated binaries. It uses Linux namespaces feature to create temporary lightweight environments which are destroyed after all child processes exit, without root user rights requirement. Accepted arguments are: |
||||
|
||||
- `name` |
||||
Environment name. |
||||
- `targetPkgs` |
||||
Packages to be installed for the main host's architecture (i.e. x86_64 on x86_64 installations). Along with libraries binaries are also installed. |
||||
- `multiPkgs` |
||||
Packages to be installed for all architectures supported by a host (i.e. i686 and x86_64 on x86_64 installations). Only libraries are installed by default. |
||||
- `extraBuildCommands` |
||||
Additional commands to be executed for finalizing the directory structure. |
||||
- `extraBuildCommandsMulti` |
||||
Like `extraBuildCommands`, but executed only on multilib architectures. |
||||
- `extraOutputsToInstall` |
||||
Additional derivation outputs to be linked for both target and multi-architecture packages. |
||||
- `extraInstallCommands` |
||||
Additional commands to be executed for finalizing the derivation with runner script. |
||||
- `runScript` |
||||
A command that would be executed inside the sandbox and passed all the command line arguments. It defaults to `bash`. |
||||
|
||||
One can create a simple environment using a `shell.nix` like that: |
||||
|
||||
```nix |
||||
{ pkgs ? import <nixpkgs> {} }: |
||||
|
||||
(pkgs.buildFHSUserEnv { |
||||
name = "simple-x11-env"; |
||||
targetPkgs = pkgs: (with pkgs; |
||||
[ udev |
||||
alsaLib |
||||
]) ++ (with pkgs.xorg; |
||||
[ libX11 |
||||
libXcursor |
||||
libXrandr |
||||
]); |
||||
multiPkgs = pkgs: (with pkgs; |
||||
[ udev |
||||
alsaLib |
||||
]); |
||||
runScript = "bash"; |
||||
}).env |
||||
``` |
||||
|
||||
Running `nix-shell` would then drop you into a shell with these libraries and binaries available. You can use this to run closed-source applications which expect FHS structure without hassles: simply change `runScript` to the application path, e.g. `./bin/start.sh` -- relative paths are supported. |
||||
@ -0,0 +1,17 @@ |
||||
# pkgs.mkShell {#sec-pkgs-mkShell} |
||||
|
||||
`pkgs.mkShell` is a special kind of derivation that is only useful when using |
||||
it combined with `nix-shell`. It will in fact fail to instantiate when invoked |
||||
with `nix-build`. |
||||
|
||||
## Usage {#sec-pkgs-mkShell-usage} |
||||
|
||||
```nix |
||||
{ pkgs ? import <nixpkgs> {} }: |
||||
pkgs.mkShell { |
||||
# specify which packages to add to the shell environment |
||||
packages = [ pkgs.gnumake ]; |
||||
# add all the dependencies, of the given packages, to the shell environment |
||||
inputsFrom = with pkgs; [ hello gnutar ]; |
||||
} |
||||
``` |
||||
@ -0,0 +1,99 @@ |
||||
# Trivial builders {#chap-trivial-builders} |
||||
|
||||
Nixpkgs provides a couple of functions that help with building derivations. The most important one, `stdenv.mkDerivation`, has already been documented above. The following functions wrap `stdenv.mkDerivation`, making it easier to use in certain cases. |
||||
|
||||
## `runCommand` {#trivial-builder-runCommand} |
||||
|
||||
This takes three arguments, `name`, `env`, and `buildCommand`. `name` is just the name that Nix will append to the store path in the same way that `stdenv.mkDerivation` uses its `name` attribute. `env` is an attribute set specifying environment variables that will be set for this derivation. These attributes are then passed to the wrapped `stdenv.mkDerivation`. `buildCommand` specifies the commands that will be run to create this derivation. Note that you will need to create `$out` for Nix to register the command as successful. |
||||
|
||||
An example of using `runCommand` is provided below. |
||||
|
||||
```nix |
||||
(import <nixpkgs> {}).runCommand "my-example" {} '' |
||||
echo My example command is running |
||||
|
||||
mkdir $out |
||||
|
||||
echo I can write data to the Nix store > $out/message |
||||
|
||||
echo I can also run basic commands like: |
||||
|
||||
echo ls |
||||
ls |
||||
|
||||
echo whoami |
||||
whoami |
||||
|
||||
echo date |
||||
date |
||||
'' |
||||
``` |
||||
|
||||
## `runCommandCC` {#trivial-builder-runCommandCC} |
||||
|
||||
This works just like `runCommand`. The only difference is that it also provides a C compiler in `buildCommand`'s environment. To minimize your dependencies, you should only use this if you are sure you will need a C compiler as part of running your command. |
||||
|
||||
## `runCommandLocal` {#trivial-builder-runCommandLocal} |
||||
|
||||
Variant of `runCommand` that forces the derivation to be built locally, it is not substituted. This is intended for very cheap commands (<1s execution time). It saves on the network roundrip and can speed up a build. |
||||
|
||||
::: note |
||||
This sets [`allowSubstitutes` to `false`](https://nixos.org/nix/manual/#adv-attr-allowSubstitutes), so only use `runCommandLocal` if you are certain the user will always have a builder for the `system` of the derivation. This should be true for most trivial use cases (e.g. just copying some files to a different location or adding symlinks), because there the `system` is usually the same as `builtins.currentSystem`. |
||||
::: |
||||
|
||||
## `writeTextFile`, `writeText`, `writeTextDir`, `writeScript`, `writeScriptBin` {#trivial-builder-writeText} |
||||
|
||||
These functions write `text` to the Nix store. This is useful for creating scripts from Nix expressions. `writeTextFile` takes an attribute set and expects two arguments, `name` and `text`. `name` corresponds to the name used in the Nix store path. `text` will be the contents of the file. You can also set `executable` to true to make this file have the executable bit set. |
||||
|
||||
Many more commands wrap `writeTextFile` including `writeText`, `writeTextDir`, `writeScript`, and `writeScriptBin`. These are convenience functions over `writeTextFile`. |
||||
|
||||
## `symlinkJoin` {#trivial-builder-symlinkJoin} |
||||
|
||||
This can be used to put many derivations into the same directory structure. It works by creating a new derivation and adding symlinks to each of the paths listed. It expects two arguments, `name`, and `paths`. `name` is the name used in the Nix store path for the created derivation. `paths` is a list of paths that will be symlinked. These paths can be to Nix store derivations or any other subdirectory contained within. |
||||
|
||||
## `writeReferencesToFile` {#trivial-builder-writeReferencesToFile} |
||||
|
||||
Writes the closure of transitive dependencies to a file. |
||||
|
||||
This produces the equivalent of `nix-store -q --requisites`. |
||||
|
||||
For example, |
||||
|
||||
```nix |
||||
writeReferencesToFile (writeScriptBin "hi" ''${hello}/bin/hello'') |
||||
``` |
||||
|
||||
produces an output path `/nix/store/<hash>-runtime-deps` containing |
||||
|
||||
```nix |
||||
/nix/store/<hash>-hello-2.10 |
||||
/nix/store/<hash>-hi |
||||
/nix/store/<hash>-libidn2-2.3.0 |
||||
/nix/store/<hash>-libunistring-0.9.10 |
||||
/nix/store/<hash>-glibc-2.32-40 |
||||
``` |
||||
|
||||
You can see that this includes `hi`, the original input path, |
||||
`hello`, which is a direct reference, but also |
||||
the other paths that are indirectly required to run `hello`. |
||||
|
||||
## `writeDirectReferencesToFile` {#trivial-builder-writeDirectReferencesToFile} |
||||
|
||||
Writes the set of references to the output file, that is, their immediate dependencies. |
||||
|
||||
This produces the equivalent of `nix-store -q --references`. |
||||
|
||||
For example, |
||||
|
||||
```nix |
||||
writeDirectReferencesToFile (writeScriptBin "hi" ''${hello}/bin/hello'') |
||||
``` |
||||
|
||||
produces an output path `/nix/store/<hash>-runtime-references` containing |
||||
|
||||
```nix |
||||
/nix/store/<hash>-hello-2.10 |
||||
``` |
||||
|
||||
but none of `hello`'s dependencies, because those are not referenced directly |
||||
by `hi`'s output. |
||||
@ -0,0 +1,607 @@ |
||||
# 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 <xref linkend="sec-package-naming"/>. |
||||
|
||||
- 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 "" ... |
||||
}) |
||||
``` |
||||
|
||||
- Unnecessary string conversions should be avoided. Do |
||||
|
||||
```nix |
||||
rev = version; |
||||
``` |
||||
|
||||
instead of |
||||
|
||||
```nix |
||||
rev = "${version}"; |
||||
``` |
||||
|
||||
- Arguments should be listed in the order they are used, with the exception of `lib`, which always goes first. |
||||
|
||||
- The top-level `lib` must be used in the master and 21.05 branch over its alias `stdenv.lib` as it now causes evaluation errors when aliases are disabled which is the case for ofborg. |
||||
`lib` is unrelated to `stdenv`, and so `stdenv.lib` should only be used as a convenience alias when developing locally 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 <xref linkend="sec-versioning" /> |
||||
|
||||
## 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 '<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 {#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 '<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). |
||||
|
||||
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 |
||||
``` |
||||
|
||||
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`: |
||||
|
||||
- `stripLen`: Remove the first `stripLen` components of pathnames in the patch. |
||||
- `extraPrefix`: Prefix pathnames by this string. |
||||
- `excludes`: Exclude files matching this pattern. |
||||
- `includes`: Include only files matching this pattern. |
||||
- `revert`: Revert the patch. |
||||
|
||||
Note that because the checksum is computed after applying these effects, using or modifying these arguments will have no effect unless the `sha256` argument is changed as well. |
||||
|
||||
## Package tests {#sec-package-tests} |
||||
|
||||
Tests are important to ensure quality and make reviews and automatic updates easy. |
||||
|
||||
Nix package tests are a lightweight alternative to [NixOS module tests](https://nixos.org/manual/nixos/stable/#sec-nixos-tests). They can be used to create simple integration tests for packages while the module tests are used to test services or programs with a graphical user interface on a NixOS VM. Unittests that are included in the source code of a package should be executed in the `checkPhase`. |
||||
|
||||
### Writing package tests {#ssec-package-tests-writing} |
||||
|
||||
This is an example using the `phoronix-test-suite` package with the current best practices. |
||||
|
||||
Add the tests in `passthru.tests` to the package definition like this: |
||||
|
||||
```nix |
||||
{ stdenv, lib, fetchurl, callPackage }: |
||||
|
||||
stdenv.mkDerivation { |
||||
… |
||||
|
||||
passthru.tests = { |
||||
simple-execution = callPackage ./tests.nix { }; |
||||
}; |
||||
|
||||
meta = { … }; |
||||
} |
||||
``` |
||||
|
||||
Create `tests.nix` in the package directory: |
||||
|
||||
```nix |
||||
{ runCommand, phoronix-test-suite }: |
||||
|
||||
let |
||||
inherit (phoronix-test-suite) pname version; |
||||
in |
||||
|
||||
runCommand "${pname}-tests" { meta.timeout = 3; } |
||||
'' |
||||
# automatic initial setup to prevent interactive questions |
||||
${phoronix-test-suite}/bin/phoronix-test-suite enterprise-setup >/dev/null |
||||
# get version of installed program and compare with package version |
||||
if [[ `${phoronix-test-suite}/bin/phoronix-test-suite version` != *"${version}"* ]]; then |
||||
echo "Error: program version does not match package version" |
||||
exit 1 |
||||
fi |
||||
# run dummy command |
||||
${phoronix-test-suite}/bin/phoronix-test-suite dummy_module.dummy-command >/dev/null |
||||
# needed for Nix to register the command as successful |
||||
touch $out |
||||
'' |
||||
``` |
||||
|
||||
### Running package tests {#ssec-package-tests-running} |
||||
|
||||
You can run these tests with: |
||||
|
||||
```ShellSession |
||||
$ cd path/to/nixpkgs |
||||
$ nix-build -A phoronix-test-suite.tests |
||||
``` |
||||
|
||||
### Examples of package tests {#ssec-package-tests-examples} |
||||
|
||||
Here are examples of package tests: |
||||
|
||||
- [Jasmin compile test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/compilers/jasmin/test-assemble-hello-world/default.nix) |
||||
- [Lobster compile test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/compilers/lobster/test-can-run-hello-world.nix) |
||||
- [Spacy annotation test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/python-modules/spacy/annotation-test/default.nix) |
||||
- [Libtorch test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/science/math/libtorch/test/default.nix) |
||||
- [Multiple tests for nanopb](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/nanopb/default.nix) |
||||
@ -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 |
||||
``` |
||||
|
||||
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`. |
||||
@ -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 <xref linkend="sec-organisation" /> 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. |
||||
@ -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. |
||||
|
||||
<!-- |
||||
The following paragraphs about how to deal with unactive contributors is just a proposition and should be modified to what the community agrees to be the right policy. |
||||
|
||||
Please note that contributors with commit rights unactive for more than three months will have their commit rights revoked. |
||||
--> |
||||
|
||||
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. |
||||
@ -0,0 +1,267 @@ |
||||
# Submitting changes {#chap-submitting-changes} |
||||
|
||||
## Making patches {#submitting-changes-making-patches} |
||||
|
||||
- Read [Manual (How to write packages for Nix)](https://nixos.org/nixpkgs/manual/). |
||||
|
||||
- Fork [the Nixpkgs repository](https://github.com/nixos/nixpkgs/) on GitHub. |
||||
|
||||
- Create a branch for your future fix. |
||||
|
||||
- You can make branch from a commit of your local `nixos-version`. That will help you to avoid additional local compilations. Because you will receive packages from binary cache. For example |
||||
|
||||
```ShellSession |
||||
$ nixos-version --hash |
||||
0998212 |
||||
$ git checkout 0998212 |
||||
$ git checkout -b 'fix/pkg-name-update' |
||||
``` |
||||
|
||||
- Please avoid working directly on the `master` branch. |
||||
|
||||
- Make commits of logical units. |
||||
|
||||
- If you removed pkgs or made some major NixOS changes, write about it in the release notes for the next stable release. For example `nixos/doc/manual/release-notes/rl-2003.xml`. |
||||
|
||||
- Check for unnecessary whitespace with `git diff --check` before committing. |
||||
|
||||
- Format the commit in a following way: |
||||
|
||||
``` |
||||
(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc) |
||||
Additional information. |
||||
``` |
||||
|
||||
- Examples: |
||||
- `nginx: init at 2.0.1` |
||||
- `firefox: 54.0.1 -> 55.0` |
||||
- `nixos/hydra: add bazBaz option` |
||||
- `nixos/nginx: refactor config generation` |
||||
|
||||
- Test your changes. If you work with |
||||
|
||||
- nixpkgs: |
||||
|
||||
- update pkg |
||||
- `nix-env -i pkg-name -f <path to your local nixpkgs folder>` |
||||
- add pkg |
||||
- Make sure it’s in `pkgs/top-level/all-packages.nix` |
||||
- `nix-env -i pkg-name -f <path to your local nixpkgs folder>` |
||||
- _If you don’t want to install pkg in you profile_. |
||||
- `nix-build -A pkg-attribute-name <path to your local nixpkgs folder>/default.nix` and check results in the folder `result`. It will appear in the same directory where you did `nix-build`. |
||||
- If you did `nix-env -i pkg-name` you can do `nix-env -e pkg-name` to uninstall it from your system. |
||||
|
||||
- NixOS and its modules: |
||||
- You can add new module to your NixOS configuration file (usually it’s `/etc/nixos/configuration.nix`). And do `sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast`. |
||||
|
||||
- If you have commits `pkg-name: oh, forgot to insert whitespace`: squash commits in this case. Use `git rebase -i`. |
||||
|
||||
- [Rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) your branch against current `master`. |
||||
|
||||
## Submitting changes {#submitting-changes-submitting-changes} |
||||
|
||||
- Push your changes to your fork of nixpkgs. |
||||
- Create the pull request |
||||
- Follow [the contribution guidelines](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md#submitting-changes). |
||||
|
||||
## Submitting security fixes {#submitting-changes-submitting-security-fixes} |
||||
|
||||
Security fixes are submitted in the same way as other changes and thus the same guidelines apply. |
||||
|
||||
- If a new version fixing the vulnerability has been released, update the package; |
||||
- 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. |
||||
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.: |
||||
```nix |
||||
(fetchpatch { |
||||
name = "CVE-2019-11068.patch"; |
||||
url = "https://gitlab.gnome.org/GNOME/libxslt/commit/e03553605b45c88f0b4b2980adfbbb8f6fca2fd6.patch"; |
||||
sha256 = "0pkpb4837km15zgg6h57bncp66d5lwrlvkr73h0lanywq7zrwhj8"; |
||||
}) |
||||
``` |
||||
|
||||
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. |
||||
|
||||
Critical security fixes may by-pass the staging branches and be delivered directly to release branches such as `master` and `release-*`. |
||||
|
||||
## Deprecating/removing packages {#submitting-changes-deprecating-packages} |
||||
|
||||
There is currently no policy when to remove a package. |
||||
|
||||
Before removing a package, one should try to find a new maintainer or fix smaller issues first. |
||||
|
||||
### Steps to remove a package from Nixpkgs |
||||
|
||||
We use jbidwatcher as an example for a discontinued project here. |
||||
|
||||
1. Have Nixpkgs checked out locally and up to date. |
||||
1. Create a new branch for your change, e.g. `git checkout -b jbidwatcher` |
||||
1. Remove the actual package including its directory, e.g. `rm -rf pkgs/applications/misc/jbidwatcher` |
||||
1. Remove the package from the list of all packages (`pkgs/top-level/all-packages.nix`). |
||||
1. Add an alias for the package name in `pkgs/top-level/aliases.nix` (There is also `pkgs/misc/vim-plugins/aliases.nix`. Package sets typically do not have aliases, so we can't add them there.) |
||||
|
||||
For example in this case: |
||||
``` |
||||
jbidwatcher = throw "jbidwatcher was discontinued in march 2021"; # added 2021-03-15 |
||||
``` |
||||
|
||||
The throw message should explain in short why the package was removed for users that still have it installed. |
||||
|
||||
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. |
||||
1. Commit the changes. Explain again why the package was removed. If it was declared discontinued upstream, add a link to the source. |
||||
|
||||
```ShellSession |
||||
$ git add pkgs/applications/misc/jbidwatcher/default.nix pkgs/top-level/all-packages.nix pkgs/top-level/aliases.nix |
||||
$ git commit |
||||
``` |
||||
|
||||
Example commit message: |
||||
|
||||
``` |
||||
jbidwatcher: remove |
||||
|
||||
project was discontinued in march 2021. the program does not work anymore because ebay changed the login. |
||||
|
||||
https://web.archive.org/web/20210315205723/http://www.jbidwatcher.com/ |
||||
``` |
||||
|
||||
1. Push changes to your GitHub fork with `git push` |
||||
1. Create a pull request against Nixpkgs. Mention the package maintainer. |
||||
|
||||
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) |
||||
|
||||
## Pull Request Template {#submitting-changes-pull-request-template} |
||||
|
||||
The pull request template helps determine what steps have been made for a contribution so far, and will help guide maintainers on the status of a change. The motivation section of the PR should include any extra details the title does not address and link any existing issues related to the pull request. |
||||
|
||||
When a PR is created, it will be pre-populated with some checkboxes detailed below: |
||||
|
||||
### Tested using sandboxing {#submitting-changes-tested-with-sandbox} |
||||
|
||||
When sandbox builds are enabled, Nix will setup an isolated environment for each build process. It is used to remove further hidden dependencies set by the build environment to improve reproducibility. This includes access to the network during the build outside of `fetch*` functions and files outside the Nix store. Depending on the operating system access to other resources are blocked as well (ex. inter process communication is isolated on Linux); see [sandbox](https://nixos.org/nix/manual/#conf-sandbox) in Nix manual for details. |
||||
|
||||
Sandboxing is not enabled by default in Nix due to a small performance hit on each build. In pull requests for [nixpkgs](https://github.com/NixOS/nixpkgs/) people are asked to test builds with sandboxing enabled (see `Tested using sandboxing` in the pull request template) because in<https://nixos.org/hydra/> sandboxing is also used. |
||||
|
||||
Depending if you use NixOS or other platforms you can use one of the following methods to enable sandboxing **before** building the package: |
||||
|
||||
- **Globally enable sandboxing on NixOS**: add the following to `configuration.nix` |
||||
|
||||
```nix |
||||
nix.useSandbox = true; |
||||
``` |
||||
|
||||
- **Globally enable sandboxing on non-NixOS platforms**: add the following to: `/etc/nix/nix.conf` |
||||
|
||||
```ini |
||||
sandbox = true |
||||
``` |
||||
|
||||
### Built on platform(s) {#submitting-changes-platform-diversity} |
||||
|
||||
Many Nix packages are designed to run on multiple platforms. As such, it’s important to let the maintainer know which platforms your changes have been tested on. It’s not always practical to test a change on all platforms, and is not required for a pull request to be merged. Only check the systems you tested the build on in this section. |
||||
|
||||
### Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests) {#submitting-changes-nixos-tests} |
||||
|
||||
Packages with automated tests are much more likely to be merged in a timely fashion because it doesn’t require as much manual testing by the maintainer to verify the functionality of the package. If there are existing tests for the package, they should be run to verify your changes do not break the tests. Tests can only be run on Linux. For more details on writing and running tests, see the [section in the NixOS manual](https://nixos.org/nixos/manual/index.html#sec-nixos-tests). |
||||
|
||||
### Tested compilation of all pkgs that depend on this change using `nixpkgs-review` {#submitting-changes-tested-compilation} |
||||
|
||||
If you are updating a package’s version, you can use nixpkgs-review to make sure all packages that depend on the updated package still compile correctly. The `nixpkgs-review` utility can look for and build all dependencies either based on uncommited changes with the `wip` option or specifying a github pull request number. |
||||
|
||||
review changes from pull request number 12345: |
||||
|
||||
```ShellSession |
||||
nix run nixpkgs.nixpkgs-review -c nixpkgs-review pr 12345 |
||||
``` |
||||
|
||||
review uncommitted changes: |
||||
|
||||
```ShellSession |
||||
nix run nixpkgs.nixpkgs-review -c nixpkgs-review wip |
||||
``` |
||||
|
||||
review changes from last commit: |
||||
|
||||
```ShellSession |
||||
nix run nixpkgs.nixpkgs-review -c nixpkgs-review rev HEAD |
||||
``` |
||||
|
||||
### Tested execution of all binary files (usually in `./result/bin/`) {#submitting-changes-tested-execution} |
||||
|
||||
It’s important to test any executables generated by a build when you change or create a package in nixpkgs. This can be done by looking in `./result/bin` and running any files in there, or at a minimum, the main executable for the package. For example, if you make a change to texlive, you probably would only check the binaries associated with the change you made rather than testing all of them. |
||||
|
||||
### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards} |
||||
|
||||
The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md). The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc\... Everyone should read and understand the standards the community has for contributing before submitting a pull request. |
||||
|
||||
## Hotfixing pull requests {#submitting-changes-hotfixing-pull-requests} |
||||
|
||||
- Make the appropriate changes in you branch. |
||||
- Don’t create additional commits, do |
||||
- `git rebase -i` |
||||
- `git push --force` to your branch. |
||||
|
||||
## Commit policy {#submitting-changes-commit-policy} |
||||
|
||||
- Commits must be sufficiently tested before being merged, both for the master and staging branches. |
||||
- Hydra builds for master and staging should not be used as testing platform, it’s a build farm for changes that have been already tested. |
||||
- When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people’s installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from \@edolstra. |
||||
|
||||
```{.graphviz caption="Staging workflow"} |
||||
digraph { |
||||
"small changes" [shape=none] |
||||
"mass-rebuilds and other large changes" [shape=none] |
||||
"critical security fixes" [shape=none] |
||||
"broken staging-next fixes" [shape=none] |
||||
|
||||
"small changes" -> master |
||||
"mass-rebuilds and other large changes" -> staging |
||||
"critical security fixes" -> master |
||||
"broken staging-next fixes" -> "staging-next" |
||||
|
||||
"staging-next" -> master [color="#E85EB0"] [label="stabilization ends"] [fontcolor="#E85EB0"] |
||||
"staging" -> "staging-next" [color="#E85EB0"] [label="stabilization starts"] [fontcolor="#E85EB0"] |
||||
|
||||
master -> "staging-next" -> staging [color="#5F5EE8"] [label="every six hours (GitHub Action)"] [fontcolor="#5F5EE8"] |
||||
} |
||||
``` |
||||
|
||||
[This GitHub Action](https://github.com/NixOS/nixpkgs/blob/master/.github/workflows/merge-staging.yml) brings changes from `master` to `staging-next` and from `staging-next` to `staging` every 6 hours. |
||||
|
||||
|
||||
### Master branch {#submitting-changes-master-branch} |
||||
|
||||
The `master` branch is the main development branch. It should only see non-breaking commits that do not cause mass rebuilds. |
||||
|
||||
### Staging branch {#submitting-changes-staging-branch} |
||||
|
||||
The `staging` branch is a development branch where mass-rebuilds go. It should only see non-breaking mass-rebuild commits. That means it is not to be used for testing, and changes must have been well tested already. If the branch is already in a broken state, please refrain from adding extra new breakages. |
||||
|
||||
### Staging-next branch {#submitting-changes-staging-next-branch} |
||||
|
||||
The `staging-next` branch is for stabilizing mass-rebuilds submitted to the `staging` branch prior to merging them into `master`. Mass-rebuilds should go via the `staging` branch. It should only see non-breaking commits that are fixing issues blocking it from being merged into the `master ` branch. |
||||
|
||||
If the branch is already in a broken state, please refrain from adding extra new breakages. Stabilize it for a few days and then merge into master. |
||||
|
||||
### Stable release branches {#submitting-changes-stable-release-branches} |
||||
|
||||
For cherry-picking a commit to a stable release branch (“backporting”), use `git cherry-pick -x <original commit>` so that the original commit id is included in the commit. |
||||
|
||||
Add a reason for the backport by using `git cherry-pick -xe <original commit>` instead when it is not obvious from the original commit message. It is not needed when it's a minor version update that includes security and bug fixes but don't add new features or when the commit fixes an otherwise broken package. |
||||
|
||||
Here is an example of a cherry-picked commit message with good reason description: |
||||
|
||||
``` |
||||
zfs: Keep trying root import until it works |
||||
|
||||
Works around #11003. |
||||
|
||||
(cherry picked from commit 98b213a11041af39b39473906b595290e2a4e2f9) |
||||
|
||||
Reason: several people cannot boot with ZFS on NVMe |
||||
``` |
||||
|
||||
Other examples of reasons are: |
||||
|
||||
- Previously the build would fail due to, e.g., `getaddrinfo` not being defined |
||||
- The previous download links were all broken |
||||
- Crash when starting on some X11 systems |
||||
@ -0,0 +1,45 @@ |
||||
# Vulnerability Roundup {#chap-vulnerability-roundup} |
||||
|
||||
## Issues {#vulnerability-roundup-issues} |
||||
|
||||
Vulnerable packages in Nixpkgs are managed using issues. |
||||
Currently opened ones can be found using the following: |
||||
|
||||
[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) |
||||
|
||||
Each issue correspond to a vulnerable version of a package; As a consequence: |
||||
|
||||
- One issue can contain several CVEs; |
||||
- One CVE can be shared across several issues; |
||||
- A single package can be concerned by several issues. |
||||
|
||||
|
||||
A "Vulnerability roundup" issue usually respects the following format: |
||||
|
||||
```txt |
||||
<link to relevant package search on search.nix.gsc.io>, <link to relevant files in Nixpkgs on GitHub> |
||||
|
||||
<list of related CVEs, their CVSS score, and the impacted NixOS version> |
||||
|
||||
<list of the scanned Nixpkgs versions> |
||||
|
||||
<list of relevant contributors> |
||||
``` |
||||
|
||||
Note that there can be an extra comment containing links to previously reported (and still open) issues for the same package. |
||||
|
||||
|
||||
## Triaging and Fixing {#vulnerability-roundup-triaging-and-fixing} |
||||
|
||||
**Note**: An issue can be a "false positive" (i.e. automatically opened, but without the package it refers to being actually vulnerable). |
||||
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. |
||||
|
||||
If you are investigating a "true positive": |
||||
|
||||
- Find the earliest patched version or a code patch in the CVE details; |
||||
- Is the issue already patched (version up-to-date or patch applied manually) in Nixpkgs's `master` branch? |
||||
- **No**: |
||||
- [Submit a security fix](#submitting-changes-submitting-security-fixes); |
||||
- Once the fix is merged into `master`, [submit the change to the vulnerable release branch(es)](https://nixos.org/manual/nixpkgs/stable/#submitting-changes-stable-release-branches); |
||||
- **Yes**: [Backport the change to the vulnerable release branch(es)](https://nixos.org/manual/nixpkgs/stable/#submitting-changes-stable-release-branches). |
||||
- When the patch has made it into all the relevant branches (`master`, and the vulnerable releases), close the relevant issue(s). |
||||
@ -0,0 +1,39 @@ |
||||
{ pkgs ? (import ./.. { }), nixpkgs ? { }}: |
||||
let |
||||
lib = pkgs.lib; |
||||
doc-support = import ./doc-support { inherit pkgs nixpkgs; }; |
||||
in pkgs.stdenv.mkDerivation { |
||||
name = "nixpkgs-manual"; |
||||
|
||||
nativeBuildInputs = with pkgs; [ |
||||
pandoc |
||||
graphviz |
||||
libxml2 |
||||
libxslt |
||||
zip |
||||
jing |
||||
xmlformat |
||||
]; |
||||
|
||||
src = lib.cleanSource ./.; |
||||
|
||||
postPatch = '' |
||||
ln -s ${doc-support} ./doc-support/result |
||||
''; |
||||
|
||||
installPhase = '' |
||||
dest="$out/share/doc/nixpkgs" |
||||
mkdir -p "$(dirname "$dest")" |
||||
mv out/html "$dest" |
||||
mv "$dest/index.html" "$dest/manual.html" |
||||
|
||||
mv out/epub/manual.epub "$dest/nixpkgs-manual.epub" |
||||
|
||||
mkdir -p $out/nix-support/ |
||||
echo "doc manual $dest manual.html" >> $out/nix-support/hydra-build-products |
||||
echo "doc manual $dest nixpkgs-manual.epub" >> $out/nix-support/hydra-build-products |
||||
''; |
||||
|
||||
# Environment variables |
||||
PANDOC_LUA_FILTERS_DIR = "${pkgs.pandoc-lua-filters}/share/pandoc/filters"; |
||||
} |
||||
@ -0,0 +1,45 @@ |
||||
{ pkgs ? (import ../.. {}), nixpkgs ? { }}: |
||||
let |
||||
locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; }; |
||||
functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs; }; |
||||
version = pkgs.lib.version; |
||||
|
||||
epub-xsl = pkgs.writeText "epub.xsl" '' |
||||
<?xml version='1.0'?> |
||||
<xsl:stylesheet |
||||
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
||||
version="1.0"> |
||||
<xsl:import href="${pkgs.docbook_xsl_ns}/xml/xsl/docbook/epub/docbook.xsl" /> |
||||
<xsl:import href="${./parameters.xml}"/> |
||||
</xsl:stylesheet> |
||||
''; |
||||
|
||||
xhtml-xsl = pkgs.writeText "xhtml.xsl" '' |
||||
<?xml version='1.0'?> |
||||
<xsl:stylesheet |
||||
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
||||
version="1.0"> |
||||
<xsl:import href="${pkgs.docbook_xsl_ns}/xml/xsl/docbook/xhtml/docbook.xsl" /> |
||||
<xsl:import href="${./parameters.xml}"/> |
||||
</xsl:stylesheet> |
||||
''; |
||||
in pkgs.runCommand "doc-support" {} |
||||
'' |
||||
mkdir result |
||||
( |
||||
cd result |
||||
ln -s ${locationsXml} ./function-locations.xml |
||||
ln -s ${functionDocs} ./function-docs |
||||
|
||||
ln -s ${pkgs.docbook5}/xml/rng/docbook/docbook.rng ./docbook.rng |
||||
ln -s ${pkgs.docbook_xsl_ns}/xml/xsl ./xsl |
||||
ln -s ${epub-xsl} ./epub.xsl |
||||
ln -s ${xhtml-xsl} ./xhtml.xsl |
||||
|
||||
ln -s ${../../nixos/doc/xmlformat.conf} ./xmlformat.conf |
||||
ln -s ${pkgs.documentation-highlighter} ./highlightjs |
||||
|
||||
echo -n "${version}" > ./version |
||||
) |
||||
mv result $out |
||||
'' |
||||
@ -0,0 +1,26 @@ |
||||
# Generates the documentation for library functons via nixdoc. To add |
||||
# another library function file to this list, the include list in the |
||||
# file `doc/functions/library.xml` must also be updated. |
||||
|
||||
{ pkgs ? import ./.. {}, locationsXml }: |
||||
|
||||
with pkgs; stdenv.mkDerivation { |
||||
name = "nixpkgs-lib-docs"; |
||||
src = ./../../lib; |
||||
|
||||
buildInputs = [ nixdoc ]; |
||||
installPhase = '' |
||||
function docgen { |
||||
nixdoc -c "$1" -d "$2" -f "../lib/$1.nix" > "$out/$1.xml" |
||||
} |
||||
|
||||
mkdir -p $out |
||||
ln -s ${locationsXml} $out/locations.xml |
||||
|
||||
docgen strings 'String manipulation functions' |
||||
docgen trivial 'Miscellaneous functions' |
||||
docgen lists 'List manipulation functions' |
||||
docgen debug 'Debugging functions' |
||||
docgen options 'NixOS / nixpkgs option handling' |
||||
''; |
||||
} |
||||
@ -0,0 +1,85 @@ |
||||
{ pkgs ? (import ./.. { }), nixpkgs ? { }}: |
||||
let |
||||
revision = pkgs.lib.trivial.revisionWithDefault (nixpkgs.revision or "master"); |
||||
|
||||
libDefPos = set: |
||||
builtins.map |
||||
(name: { |
||||
name = name; |
||||
location = builtins.unsafeGetAttrPos name set; |
||||
}) |
||||
(builtins.attrNames set); |
||||
|
||||
libset = toplib: |
||||
builtins.map |
||||
(subsetname: { |
||||
subsetname = subsetname; |
||||
functions = libDefPos toplib.${subsetname}; |
||||
}) |
||||
(builtins.filter |
||||
(name: builtins.isAttrs toplib.${name}) |
||||
(builtins.attrNames toplib)); |
||||
|
||||
nixpkgsLib = pkgs.lib; |
||||
|
||||
flattenedLibSubset = { subsetname, functions }: |
||||
builtins.map |
||||
(fn: { |
||||
name = "lib.${subsetname}.${fn.name}"; |
||||
value = fn.location; |
||||
}) |
||||
functions; |
||||
|
||||
locatedlibsets = libs: builtins.map flattenedLibSubset (libset libs); |
||||
removeFilenamePrefix = prefix: filename: |
||||
let |
||||
prefixLen = (builtins.stringLength prefix) + 1; # +1 to remove the leading / |
||||
filenameLen = builtins.stringLength filename; |
||||
substr = builtins.substring prefixLen filenameLen filename; |
||||
in substr; |
||||
|
||||
removeNixpkgs = removeFilenamePrefix (builtins.toString pkgs.path); |
||||
|
||||
liblocations = |
||||
builtins.filter |
||||
(elem: elem.value != null) |
||||
(nixpkgsLib.lists.flatten |
||||
(locatedlibsets nixpkgsLib)); |
||||
|
||||
fnLocationRelative = { name, value }: |
||||
{ |
||||
inherit name; |
||||
value = value // { file = removeNixpkgs value.file; }; |
||||
}; |
||||
|
||||
relativeLocs = (builtins.map fnLocationRelative liblocations); |
||||
sanitizeId = builtins.replaceStrings |
||||
[ "'" ] |
||||
[ "-prime" ]; |
||||
|
||||
urlPrefix = "https://github.com/NixOS/nixpkgs/blob/${revision}"; |
||||
xmlstrings = (nixpkgsLib.strings.concatMapStrings |
||||
({ name, value }: |
||||
'' |
||||
<section><title>${name}</title> |
||||
<para xml:id="${sanitizeId name}"> |
||||
Located at |
||||
<link |
||||
xlink:href="${urlPrefix}/${value.file}#L${builtins.toString value.line}">${value.file}:${builtins.toString value.line}</link> |
||||
in <literal><nixpkgs></literal>. |
||||
</para> |
||||
</section> |
||||
'') |
||||
relativeLocs); |
||||
|
||||
in pkgs.writeText |
||||
"locations.xml" |
||||
'' |
||||
<section xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" |
||||
version="5"> |
||||
<title>All the locations for every lib function</title> |
||||
<para>This file is only for inclusion by other files.</para> |
||||
${xmlstrings} |
||||
</section> |
||||
'' |
||||
@ -0,0 +1,14 @@ |
||||
<?xml version='1.0'?> |
||||
<xsl:stylesheet |
||||
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
||||
version="1.0"> |
||||
<xsl:param name="section.autolabel" select="1" /> |
||||
<xsl:param name="section.label.includes.component.label" select="1" /> |
||||
<xsl:param name="html.stylesheet" select="'style.css overrides.css highlightjs/mono-blue.css'" /> |
||||
<xsl:param name="html.script" select="'./highlightjs/highlight.pack.js ./highlightjs/loader.js'" /> |
||||
<xsl:param name="xref.with.number.and.title" select="1" /> |
||||
<xsl:param name="use.id.as.filename" select="1" /> |
||||
<xsl:param name="toc.section.depth" select="0" /> |
||||
<xsl:param name="admon.style" select="''" /> |
||||
<xsl:param name="callout.graphics.extension" select="'.svg'" /> |
||||
</xsl:stylesheet> |
||||
@ -0,0 +1,14 @@ |
||||
<chapter xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="chap-functions"> |
||||
<title>Functions reference</title> |
||||
<para> |
||||
The nixpkgs repository has several utility functions to manipulate Nix expressions. |
||||
</para> |
||||
<xi:include href="functions/library.xml" /> |
||||
<xi:include href="functions/generators.xml" /> |
||||
<xi:include href="functions/debug.xml" /> |
||||
<xi:include href="functions/prefer-remote-fetch.xml" /> |
||||
<xi:include href="functions/nix-gitignore.xml" /> |
||||
</chapter> |
||||
@ -0,0 +1,14 @@ |
||||
<section xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="sec-debug"> |
||||
<title>Debugging Nix Expressions</title> |
||||
|
||||
<para> |
||||
Nix is a unityped, dynamic language, this means every value can potentially appear anywhere. Since it is also non-strict, evaluation order and what ultimately is evaluated might surprise you. Therefore it is important to be able to debug nix expressions. |
||||
</para> |
||||
|
||||
<para> |
||||
In the <literal>lib/debug.nix</literal> file you will find a number of functions that help (pretty-)printing values while evaluation is runnnig. You can even specify how deep these values should be printed recursively, and transform them on the fly. Please consult the docstrings in <literal>lib/debug.nix</literal> for usage information. |
||||
</para> |
||||
</section> |
||||
@ -0,0 +1,28 @@ |
||||
<section xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="sec-functions-library"> |
||||
<title>Nixpkgs Library Functions</title> |
||||
|
||||
<para> |
||||
Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or through <code>import <nixpkgs/lib></code>. |
||||
</para> |
||||
|
||||
<xi:include href="./library/asserts.xml" /> |
||||
|
||||
<xi:include href="./library/attrsets.xml" /> |
||||
|
||||
<!-- These docs are generated via nixdoc. To add another generated |
||||
library function file to this list, the file |
||||
`lib-function-docs.nix` must also be updated. --> |
||||
|
||||
<xi:include href="./library/generated/strings.xml" /> |
||||
|
||||
<xi:include href="./library/generated/trivial.xml" /> |
||||
|
||||
<xi:include href="./library/generated/lists.xml" /> |
||||
|
||||
<xi:include href="./library/generated/debug.xml" /> |
||||
|
||||
<xi:include href="./library/generated/options.xml" /> |
||||
</section> |
||||
@ -0,0 +1,112 @@ |
||||
<section xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="sec-functions-library-asserts"> |
||||
<title>Assert functions</title> |
||||
|
||||
<section xml:id="function-library-lib.asserts.assertMsg"> |
||||
<title><function>lib.asserts.assertMsg</function></title> |
||||
|
||||
<subtitle><literal>assertMsg :: Bool -> String -> Bool</literal> |
||||
</subtitle> |
||||
|
||||
<xi:include href="./locations.xml" xpointer="lib.asserts.assertMsg" /> |
||||
|
||||
<para> |
||||
Print a trace message if <literal>pred</literal> is false. |
||||
</para> |
||||
|
||||
<para> |
||||
Intended to be used to augment asserts with helpful error messages. |
||||
</para> |
||||
|
||||
<variablelist> |
||||
<varlistentry> |
||||
<term> |
||||
<varname>pred</varname> |
||||
</term> |
||||
<listitem> |
||||
<para> |
||||
Condition under which the <varname>msg</varname> should <emphasis>not</emphasis> be printed. |
||||
</para> |
||||
</listitem> |
||||
</varlistentry> |
||||
<varlistentry> |
||||
<term> |
||||
<varname>msg</varname> |
||||
</term> |
||||
<listitem> |
||||
<para> |
||||
Message to print. |
||||
</para> |
||||
</listitem> |
||||
</varlistentry> |
||||
</variablelist> |
||||
|
||||
<example xml:id="function-library-lib.asserts.assertMsg-example-false"> |
||||
<title>Printing when the predicate is false</title> |
||||
<programlisting><![CDATA[ |
||||
assert lib.asserts.assertMsg ("foo" == "bar") "foo is not bar, silly" |
||||
stderr> trace: foo is not bar, silly |
||||
stderr> assert failed |
||||
]]></programlisting> |
||||
</example> |
||||
</section> |
||||
|
||||
<section xml:id="function-library-lib.asserts.assertOneOf"> |
||||
<title><function>lib.asserts.assertOneOf</function></title> |
||||
|
||||
<subtitle><literal>assertOneOf :: String -> String -> |
||||
StringList -> Bool</literal> |
||||
</subtitle> |
||||
|
||||
<xi:include href="./locations.xml" xpointer="lib.asserts.assertOneOf" /> |
||||
|
||||
<para> |
||||
Specialized <function>asserts.assertMsg</function> for checking if <varname>val</varname> is one of the elements of <varname>xs</varname>. Useful for checking enums. |
||||
</para> |
||||
|
||||
<variablelist> |
||||
<varlistentry> |
||||
<term> |
||||
<varname>name</varname> |
||||
</term> |
||||
<listitem> |
||||
<para> |
||||
The name of the variable the user entered <varname>val</varname> into, for inclusion in the error message. |
||||
</para> |
||||
</listitem> |
||||
</varlistentry> |
||||
<varlistentry> |
||||
<term> |
||||
<varname>val</varname> |
||||
</term> |
||||
<listitem> |
||||
<para> |
||||
The value of what the user provided, to be compared against the values in <varname>xs</varname>. |
||||
</para> |
||||
</listitem> |
||||
</varlistentry> |
||||
<varlistentry> |
||||
<term> |
||||
<varname>xs</varname> |
||||
</term> |
||||
<listitem> |
||||
<para> |
||||
The list of valid values. |
||||
</para> |
||||
</listitem> |
||||
</varlistentry> |
||||
</variablelist> |
||||
|
||||
<example xml:id="function-library-lib.asserts.assertOneOf-example"> |
||||
<title>Ensuring a user provided a possible value</title> |
||||
<programlisting><![CDATA[ |
||||
let sslLibrary = "bearssl"; |
||||
in lib.asserts.assertOneOf "sslLibrary" sslLibrary [ "openssl" "libressl" ]; |
||||
=> false |
||||
stderr> trace: sslLibrary must be one of "openssl", "libressl", but is: "bearssl" |
||||
]]></programlisting> |
||||
</example> |
||||
</section> |
||||
</section> |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,70 @@ |
||||
<section xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="sec-pkgs-nix-gitignore"> |
||||
<title>pkgs.nix-gitignore</title> |
||||
|
||||
<para> |
||||
<function>pkgs.nix-gitignore</function> is a function that acts similarly to <literal>builtins.filterSource</literal> but also allows filtering with the help of the gitignore format. |
||||
</para> |
||||
|
||||
<section xml:id="sec-pkgs-nix-gitignore-usage"> |
||||
<title>Usage</title> |
||||
|
||||
<para> |
||||
<literal>pkgs.nix-gitignore</literal> exports a number of functions, but you'll most likely need either <literal>gitignoreSource</literal> or <literal>gitignoreSourcePure</literal>. As their first argument, they both accept either 1. a file with gitignore lines or 2. a string with gitignore lines, or 3. a list of either of the two. They will be concatenated into a single big string. |
||||
</para> |
||||
|
||||
<programlisting><![CDATA[ |
||||
{ pkgs ? import <nixpkgs> {} }: |
||||
|
||||
nix-gitignore.gitignoreSource [] ./source |
||||
# Simplest version |
||||
|
||||
nix-gitignore.gitignoreSource "supplemental-ignores\n" ./source |
||||
# This one reads the ./source/.gitignore and concats the auxiliary ignores |
||||
|
||||
nix-gitignore.gitignoreSourcePure "ignore-this\nignore-that\n" ./source |
||||
# Use this string as gitignore, don't read ./source/.gitignore. |
||||
|
||||
nix-gitignore.gitignoreSourcePure ["ignore-this\nignore-that\n", ~/.gitignore] ./source |
||||
# It also accepts a list (of strings and paths) that will be concatenated |
||||
# once the paths are turned to strings via readFile. |
||||
]]></programlisting> |
||||
|
||||
<para> |
||||
These functions are derived from the <literal>Filter</literal> functions by setting the first filter argument to <literal>(_: _: true)</literal>: |
||||
</para> |
||||
|
||||
<programlisting><![CDATA[ |
||||
gitignoreSourcePure = gitignoreFilterSourcePure (_: _: true); |
||||
gitignoreSource = gitignoreFilterSource (_: _: true); |
||||
]]></programlisting> |
||||
|
||||
<para> |
||||
Those filter functions accept the same arguments the <literal>builtins.filterSource</literal> function would pass to its filters, thus <literal>fn: gitignoreFilterSourcePure fn ""</literal> should be extensionally equivalent to <literal>filterSource</literal>. The file is blacklisted iff it's blacklisted by either your filter or the gitignoreFilter. |
||||
</para> |
||||
|
||||
<para> |
||||
If you want to make your own filter from scratch, you may use |
||||
</para> |
||||
|
||||
<programlisting><![CDATA[ |
||||
gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root; |
||||
]]></programlisting> |
||||
</section> |
||||
|
||||
<section xml:id="sec-pkgs-nix-gitignore-usage-recursive"> |
||||
<title>gitignore files in subdirectories</title> |
||||
|
||||
<para> |
||||
If you wish to use a filter that would search for .gitignore files in subdirectories, just like git does by default, use this function: |
||||
</para> |
||||
|
||||
<programlisting><![CDATA[ |
||||
gitignoreFilterRecursiveSource = filter: patterns: root: |
||||
# OR |
||||
gitignoreRecursiveSource = gitignoreFilterSourcePure (_: _: true); |
||||
]]></programlisting> |
||||
</section> |
||||
</section> |
||||
@ -0,0 +1,21 @@ |
||||
<section xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" |
||||
xmlns:xi="http://www.w3.org/2001/xinclude" |
||||
xml:id="sec-prefer-remote-fetch"> |
||||
<title>prefer-remote-fetch overlay</title> |
||||
|
||||
<para> |
||||
<function>prefer-remote-fetch</function> is an overlay that download sources on remote builder. This is useful when the evaluating machine has a slow upload while the builder can fetch faster directly from the source. To use it, put the following snippet as a new overlay: |
||||
<programlisting> |
||||
self: super: |
||||
(super.prefer-remote-fetch self super) |
||||
</programlisting> |
||||
A full configuration example for that sets the overlay up for your own account, could look like this |
||||
<screen> |
||||
<prompt>$ </prompt>mkdir ~/.config/nixpkgs/overlays/ |
||||
<prompt>$ </prompt>cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix <<EOF |
||||
self: super: super.prefer-remote-fetch self super |
||||
EOF |
||||
</screen> |
||||
</para> |
||||
</section> |
||||
@ -0,0 +1,187 @@ |
||||
# Agda {#agda} |
||||
|
||||
## How to use Agda |
||||
|
||||
Agda is available as the [agda](https://search.nixos.org/packages?channel=unstable&show=agda&from=0&size=30&sort=relevance&query=agda) |
||||
package. |
||||
|
||||
The `agda` package installs an Agda-wrapper, which calls `agda` with `--library-file` |
||||
set to a generated library-file within the nix store, this means your library-file in |
||||
`$HOME/.agda/libraries` will be ignored. By default the agda package installs Agda |
||||
with no libraries, i.e. the generated library-file is empty. To use Agda with libraries, |
||||
the `agda.withPackages` function can be used. This function either takes: |
||||
|
||||
* A list of packages, |
||||
* or a function which returns a list of packages when given the `agdaPackages` attribute set, |
||||
* or an attribute set containing a list of packages and a GHC derivation for compilation (see below). |
||||
* or an attribute set containing a function which returns a list of packages when given the `agdaPackages` attribute set and a GHC derivation for compilation (see below). |
||||
|
||||
For example, suppose we wanted a version of Agda which has access to the standard library. This can be obtained with the expressions: |
||||
|
||||
```nix |
||||
agda.withPackages [ agdaPackages.standard-library ] |
||||
``` |
||||
|
||||
or |
||||
|
||||
```nix |
||||
agda.withPackages (p: [ p.standard-library ]) |
||||
``` |
||||
|
||||
or can be called as in the [Compiling Agda](#compiling-agda) section. |
||||
|
||||
If you want to use a different version of a library (for instance a development version) |
||||
override the `src` attribute of the package to point to your local repository |
||||
|
||||
```nix |
||||
agda.withPackages (p: [ |
||||
(p.standard-library.overrideAttrs (oldAttrs: { |
||||
version = "local version"; |
||||
src = /path/to/local/repo/agda-stdlib; |
||||
})) |
||||
]) |
||||
``` |
||||
|
||||
You can also reference a GitHub repository |
||||
```nix |
||||
agda.withPackages (p: [ |
||||
(p.standard-library.overrideAttrs (oldAttrs: { |
||||
version = "1.5"; |
||||
src = fetchFromGitHub { |
||||
repo = "agda-stdlib"; |
||||
owner = "agda"; |
||||
rev = "v1.5"; |
||||
sha256 = "16fcb7ssj6kj687a042afaa2gq48rc8abihpm14k684ncihb2k4w"; |
||||
}; |
||||
})) |
||||
]) |
||||
``` |
||||
|
||||
If you want to use a library not added to Nixpkgs, you can add a |
||||
dependency to a local library by calling `agdaPackages.mkDerivation`. |
||||
```nix |
||||
agda.withPackages (p: [ |
||||
(p.mkDerivation { |
||||
pname = "your-agda-lib"; |
||||
version = "1.0.0"; |
||||
src = /path/to/your-agda-lib; |
||||
}) |
||||
]) |
||||
``` |
||||
|
||||
Again you can reference GitHub |
||||
|
||||
```nix |
||||
agda.withPackages (p: [ |
||||
(p.mkDerivation { |
||||
pname = "your-agda-lib"; |
||||
version = "1.0.0"; |
||||
src = fetchFromGitHub { |
||||
repo = "repo"; |
||||
owner = "owner"; |
||||
version = "..."; |
||||
rev = "..."; |
||||
sha256 = "..."; |
||||
}; |
||||
}) |
||||
]) |
||||
``` |
||||
|
||||
See [Building Agda Packages](#building-agda-packages) for more information on `mkDerivation`. |
||||
|
||||
Agda will not by default use these libraries. To tell Agda to use a library we have some options: |
||||
|
||||
* Call `agda` with the library flag: |
||||
```ShellSession |
||||
$ agda -l standard-library -i . MyFile.agda |
||||
``` |
||||
* Write a `my-library.agda-lib` file for the project you are working on which may look like: |
||||
``` |
||||
name: my-library |
||||
include: . |
||||
depend: standard-library |
||||
``` |
||||
* Create the file `~/.agda/defaults` and add any libraries you want to use by default. |
||||
|
||||
More information can be found in the [official Agda documentation on library management](https://agda.readthedocs.io/en/v2.6.1/tools/package-system.html). |
||||
|
||||
## Compiling Agda |
||||
Agda modules can be compiled using the GHC backend with the `--compile` flag. A version of `ghc` with `ieee754` is made available to the Agda program via the `--with-compiler` flag. |
||||
This can be overridden by a different version of `ghc` as follows: |
||||
|
||||
```nix |
||||
agda.withPackages { |
||||
pkgs = [ ... ]; |
||||
ghc = haskell.compiler.ghcHEAD; |
||||
} |
||||
``` |
||||
|
||||
## Writing Agda packages |
||||
To write a nix derivation for an Agda library, first check that the library has a `*.agda-lib` file. |
||||
|
||||
A derivation can then be written using `agdaPackages.mkDerivation`. This has similar arguments to `stdenv.mkDerivation` with the following additions: |
||||
|
||||
* `everythingFile` can be used to specify the location of the `Everything.agda` file, defaulting to `./Everything.agda`. If this file does not exist then either it should be patched in or the `buildPhase` should be overridden (see below). |
||||
* `libraryName` should be the name that appears in the `*.agda-lib` file, defaulting to `pname`. |
||||
* `libraryFile` should be the file name of the `*.agda-lib` file, defaulting to `${libraryName}.agda-lib`. |
||||
|
||||
Here is an example `default.nix` |
||||
|
||||
```nix |
||||
{ nixpkgs ? <nixpkgs> }: |
||||
with (import nixpkgs {}); |
||||
agdaPackages.mkDerivation { |
||||
version = "1.0"; |
||||
pname = "my-agda-lib"; |
||||
src = ./.; |
||||
buildInputs = [ |
||||
agdaPackages.standard-library |
||||
]; |
||||
} |
||||
``` |
||||
|
||||
### Building Agda packages |
||||
The default build phase for `agdaPackages.mkDerivation` simply runs `agda` on the `Everything.agda` file. |
||||
If something else is needed to build the package (e.g. `make`) then the `buildPhase` should be overridden. |
||||
Additionally, a `preBuild` or `configurePhase` can be used if there are steps that need to be done prior to checking the `Everything.agda` file. |
||||
`agda` and the Agda libraries contained in `buildInputs` are made available during the build phase. |
||||
|
||||
### Installing Agda packages |
||||
The default install phase copies Agda source files, Agda interface files (`*.agdai`) and `*.agda-lib` files to the output directory. |
||||
This can be overridden. |
||||
|
||||
By default, Agda sources are files ending on `.agda`, or literate Agda files ending on `.lagda`, `.lagda.tex`, `.lagda.org`, `.lagda.md`, `.lagda.rst`. The list of recognised Agda source extensions can be extended by setting the `extraExtensions` config variable. |
||||
|
||||
## Adding Agda packages to Nixpkgs |
||||
|
||||
To add an Agda package to `nixpkgs`, the derivation should be written to `pkgs/development/libraries/agda/${library-name}/` and an entry should be added to `pkgs/top-level/agda-packages.nix`. Here it is called in a scope with access to all other Agda libraries, so the top line of the `default.nix` can look like: |
||||
|
||||
```nix |
||||
{ mkDerivation, standard-library, fetchFromGitHub }: |
||||
``` |
||||
|
||||
Note that the derivation function is called with `mkDerivation` set to `agdaPackages.mkDerivation`, therefore you |
||||
could use a similar set as in your `default.nix` from [Writing Agda Packages](#writing-agda-packages) with |
||||
`agdaPackages.mkDerivation` replaced with `mkDerivation`. |
||||
|
||||
Here is an example skeleton derivation for iowa-stdlib: |
||||
|
||||
```nix |
||||
mkDerivation { |
||||
version = "1.5.0"; |
||||
pname = "iowa-stdlib"; |
||||
|
||||
src = ... |
||||
|
||||
libraryFile = ""; |
||||
libraryName = "IAL-1.3"; |
||||
|
||||
buildPhase = '' |
||||
patchShebangs find-deps.sh |
||||
make |
||||
''; |
||||
} |
||||
``` |
||||
This library has a file called `.agda-lib`, and so we give an empty string to `libraryFile` as nothing precedes `.agda-lib` in the filename. This file contains `name: IAL-1.3`, and so we let `libraryName = "IAL-1.3"`. This library does not use an `Everything.agda` file and instead has a Makefile, so there is no need to set `everythingFile` and we set a custom `buildPhase`. |
||||
|
||||
When writing an Agda package it is essential to make sure that no `.agda-lib` file gets added to the store as a single file (for example by using `writeText`). This causes Agda to think that the nix store is a Agda library and it will attempt to write to it whenever it typechecks something. See [https://github.com/agda/agda/issues/4613](https://github.com/agda/agda/issues/4613). |
||||
@ -0,0 +1,345 @@ |
||||
# Android {#android} |
||||
|
||||
The Android build environment provides three major features and a number of |
||||
supporting features. |
||||
|
||||
Deploying an Android SDK installation with plugins |
||||
-------------------------------------------------- |
||||
The first use case is deploying the SDK with a desired set of plugins or subsets |
||||
of an SDK. |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
let |
||||
androidComposition = androidenv.composeAndroidPackages { |
||||
toolsVersion = "26.1.1"; |
||||
platformToolsVersion = "30.0.5"; |
||||
buildToolsVersions = [ "30.0.3" ]; |
||||
includeEmulator = false; |
||||
emulatorVersion = "30.3.4"; |
||||
platformVersions = [ "28" "29" "30" ]; |
||||
includeSources = false; |
||||
includeSystemImages = false; |
||||
systemImageTypes = [ "google_apis_playstore" ]; |
||||
abiVersions = [ "armeabi-v7a" "arm64-v8a" ]; |
||||
cmakeVersions = [ "3.10.2" ]; |
||||
includeNDK = true; |
||||
ndkVersions = ["22.0.7026061"]; |
||||
useGoogleAPIs = false; |
||||
useGoogleTVAddOns = false; |
||||
includeExtras = [ |
||||
"extras;google;gcm" |
||||
]; |
||||
}; |
||||
in |
||||
androidComposition.androidsdk |
||||
``` |
||||
|
||||
The above function invocation states that we want an Android SDK with the above |
||||
specified plugin versions. By default, most plugins are disabled. Notable |
||||
exceptions are the tools, platform-tools and build-tools sub packages. |
||||
|
||||
The following parameters are supported: |
||||
|
||||
* `toolsVersion`, specifies the version of the tools package to use |
||||
* `platformsToolsVersion` specifies the version of the `platform-tools` plugin |
||||
* `buildToolsVersions` specifies the versions of the `build-tools` plugins to |
||||
use. |
||||
* `includeEmulator` specifies whether to deploy the emulator package (`false` |
||||
by default). When enabled, the version of the emulator to deploy can be |
||||
specified by setting the `emulatorVersion` parameter. |
||||
* `cmakeVersions` specifies which CMake versions should be deployed. |
||||
* `includeNDK` specifies that the Android NDK bundle should be included. |
||||
Defaults to: `false`. |
||||
* `ndkVersions` specifies the NDK versions that we want to use. These are linked |
||||
under the `ndk` directory of the SDK root, and the first is linked under the |
||||
`ndk-bundle` directory. |
||||
* `ndkVersion` is equivalent to specifying one entry in `ndkVersions`, and |
||||
`ndkVersions` overrides this parameter if provided. |
||||
* `includeExtras` is an array of identifier strings referring to arbitrary |
||||
add-on packages that should be installed. |
||||
* `platformVersions` specifies which platform SDK versions should be included. |
||||
|
||||
For each platform version that has been specified, we can apply the following |
||||
options: |
||||
|
||||
* `includeSystemImages` specifies whether a system image for each platform SDK |
||||
should be included. |
||||
* `includeSources` specifies whether the sources for each SDK version should be |
||||
included. |
||||
* `useGoogleAPIs` specifies that for each selected platform version the |
||||
Google API should be included. |
||||
* `useGoogleTVAddOns` specifies that for each selected platform version the |
||||
Google TV add-on should be included. |
||||
|
||||
For each requested system image we can specify the following options: |
||||
|
||||
* `systemImageTypes` specifies what kind of system images should be included. |
||||
Defaults to: `default`. |
||||
* `abiVersions` specifies what kind of ABI version of each system image should |
||||
be included. Defaults to: `armeabi-v7a`. |
||||
|
||||
Most of the function arguments have reasonable default settings. |
||||
|
||||
You can specify license names: |
||||
|
||||
* `extraLicenses` is a list of license names. |
||||
You can get these names from repo.json or `querypackages.sh licenses`. The SDK |
||||
license (`android-sdk-license`) is accepted for you if you set accept_license |
||||
to true. If you are doing something like working with preview SDKs, you will |
||||
want to add `android-sdk-preview-license` or whichever license applies here. |
||||
|
||||
Additionally, you can override the repositories that composeAndroidPackages will |
||||
pull from: |
||||
|
||||
* `repoJson` specifies a path to a generated repo.json file. You can generate this |
||||
by running `generate.sh`, which in turn will call into `mkrepo.rb`. |
||||
* `repoXmls` is an attribute set containing paths to repo XML files. If specified, |
||||
it takes priority over `repoJson`, and will trigger a local build writing out a |
||||
repo.json to the Nix store based on the given repository XMLs. |
||||
|
||||
```nix |
||||
repoXmls = { |
||||
packages = [ ./xml/repository2-1.xml ]; |
||||
images = [ |
||||
./xml/android-sys-img2-1.xml |
||||
./xml/android-tv-sys-img2-1.xml |
||||
./xml/android-wear-sys-img2-1.xml |
||||
./xml/android-wear-cn-sys-img2-1.xml |
||||
./xml/google_apis-sys-img2-1.xml |
||||
./xml/google_apis_playstore-sys-img2-1.xml |
||||
]; |
||||
addons = [ ./xml/addon2-1.xml ]; |
||||
}; |
||||
``` |
||||
|
||||
When building the above expression with: |
||||
|
||||
```bash |
||||
$ nix-build |
||||
``` |
||||
|
||||
The Android SDK gets deployed with all desired plugin versions. |
||||
|
||||
We can also deploy subsets of the Android SDK. For example, to only the |
||||
`platform-tools` package, you can evaluate the following expression: |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
let |
||||
androidComposition = androidenv.composeAndroidPackages { |
||||
# ... |
||||
}; |
||||
in |
||||
androidComposition.platform-tools |
||||
``` |
||||
|
||||
Using predefined Android package compositions |
||||
--------------------------------------------- |
||||
In addition to composing an Android package set manually, it is also possible |
||||
to use a predefined composition that contains all basic packages for a specific |
||||
Android version, such as version 9.0 (API-level 28). |
||||
|
||||
The following Nix expression can be used to deploy the entire SDK with all basic |
||||
plugins: |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
androidenv.androidPkgs_9_0.androidsdk |
||||
``` |
||||
|
||||
It is also possible to use one plugin only: |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
androidenv.androidPkgs_9_0.platform-tools |
||||
``` |
||||
|
||||
Building an Android application |
||||
------------------------------- |
||||
In addition to the SDK, it is also possible to build an Ant-based Android |
||||
project and automatically deploy all the Android plugins that a project |
||||
requires. |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
androidenv.buildApp { |
||||
name = "MyAndroidApp"; |
||||
src = ./myappsources; |
||||
release = true; |
||||
|
||||
# If release is set to true, you need to specify the following parameters |
||||
keyStore = ./keystore; |
||||
keyAlias = "myfirstapp"; |
||||
keyStorePassword = "mykeystore"; |
||||
keyAliasPassword = "myfirstapp"; |
||||
|
||||
# Any Android SDK parameters that install all the relevant plugins that a |
||||
# build requires |
||||
platformVersions = [ "24" ]; |
||||
|
||||
# When we include the NDK, then ndk-build is invoked before Ant gets invoked |
||||
includeNDK = true; |
||||
} |
||||
``` |
||||
|
||||
Aside from the app-specific build parameters (`name`, `src`, `release` and |
||||
keystore parameters), the `buildApp {}` function supports all the function |
||||
parameters that the SDK composition function (the function shown in the |
||||
previous section) supports. |
||||
|
||||
This build function is particularly useful when it is desired to use |
||||
[Hydra](https://nixos.org/hydra): the Nix-based continuous integration solution |
||||
to build Android apps. An Android APK gets exposed as a build product and can be |
||||
installed on any Android device with a web browser by navigating to the build |
||||
result page. |
||||
|
||||
Spawning emulator instances |
||||
--------------------------- |
||||
For testing purposes, it can also be quite convenient to automatically generate |
||||
scripts that spawn emulator instances with all desired configuration settings. |
||||
|
||||
An emulator spawn script can be configured by invoking the `emulateApp {}` |
||||
function: |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
androidenv.emulateApp { |
||||
name = "emulate-MyAndroidApp"; |
||||
platformVersion = "28"; |
||||
abiVersion = "x86"; # armeabi-v7a, mips, x86_64 |
||||
systemImageType = "google_apis_playstore"; |
||||
} |
||||
``` |
||||
|
||||
Additional flags may be applied to the Android SDK's emulator through the runtime environment variable `$NIX_ANDROID_EMULATOR_FLAGS`. |
||||
|
||||
It is also possible to specify an APK to deploy inside the emulator |
||||
and the package and activity names to launch it: |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
androidenv.emulateApp { |
||||
name = "emulate-MyAndroidApp"; |
||||
platformVersion = "24"; |
||||
abiVersion = "armeabi-v7a"; # mips, x86, x86_64 |
||||
systemImageType = "default"; |
||||
useGoogleAPIs = false; |
||||
app = ./MyApp.apk; |
||||
package = "MyApp"; |
||||
activity = "MainActivity"; |
||||
} |
||||
``` |
||||
|
||||
In addition to prebuilt APKs, you can also bind the APK parameter to a |
||||
`buildApp {}` function invocation shown in the previous example. |
||||
|
||||
Notes on environment variables in Android projects |
||||
-------------------------------------------------- |
||||
* `ANDROID_SDK_ROOT` should point to the Android SDK. In your Nix expressions, this should be |
||||
`${androidComposition.androidsdk}/libexec/android-sdk`. Note that `ANDROID_HOME` is deprecated, |
||||
but if you rely on tools that need it, you can export it too. |
||||
* `ANDROID_NDK_ROOT` should point to the Android NDK, if you're doing NDK development. |
||||
In your Nix expressions, this should be `${ANDROID_SDK_ROOT}/ndk-bundle`. |
||||
|
||||
If you are running the Android Gradle plugin, you need to export GRADLE_OPTS to override aapt2 |
||||
to point to the aapt2 binary in the Nix store as well, or use a FHS environment so the packaged |
||||
aapt2 can run. If you don't want to use a FHS environment, something like this should work: |
||||
|
||||
```nix |
||||
let |
||||
buildToolsVersion = "30.0.3"; |
||||
|
||||
# Use buildToolsVersion when you define androidComposition |
||||
androidComposition = <...>; |
||||
in |
||||
pkgs.mkShell rec { |
||||
ANDROID_SDK_ROOT = "${androidComposition.androidsdk}/libexec/android-sdk"; |
||||
ANDROID_NDK_ROOT = "${ANDROID_SDK_ROOT}/ndk-bundle"; |
||||
|
||||
# Use the same buildToolsVersion here |
||||
GRADLE_OPTS = "-Dorg.gradle.project.android.aapt2FromMavenOverride=${ANDROID_SDK_ROOT}/build-tools/${buildToolsVersion}/aapt2"; |
||||
} |
||||
``` |
||||
|
||||
If you are using cmake, you need to add it to PATH in a shell hook or FHS env profile. |
||||
The path is suffixed with a build number, but properly prefixed with the version. |
||||
So, something like this should suffice: |
||||
|
||||
```nix |
||||
let |
||||
cmakeVersion = "3.10.2"; |
||||
|
||||
# Use cmakeVersion when you define androidComposition |
||||
androidComposition = <...>; |
||||
in |
||||
pkgs.mkShell rec { |
||||
ANDROID_SDK_ROOT = "${androidComposition.androidsdk}/libexec/android-sdk"; |
||||
ANDROID_NDK_ROOT = "${ANDROID_SDK_ROOT}/ndk-bundle"; |
||||
|
||||
# Use the same cmakeVersion here |
||||
shellHook = '' |
||||
export PATH="$(echo "$ANDROID_SDK_ROOT/cmake/${cmakeVersion}".*/bin):$PATH" |
||||
''; |
||||
} |
||||
``` |
||||
|
||||
Note that running Android Studio with ANDROID_SDK_ROOT set will automatically write a |
||||
`local.properties` file with `sdk.dir` set to $ANDROID_SDK_ROOT if one does not already |
||||
exist. If you are using the NDK as well, you may have to add `ndk.dir` to this file. |
||||
|
||||
An example shell.nix that does all this for you is provided in examples/shell.nix. |
||||
This shell.nix includes a shell hook that overwrites local.properties with the correct |
||||
sdk.dir and ndk.dir values. This will ensure that the SDK and NDK directories will |
||||
both be correct when you run Android Studio inside nix-shell. |
||||
|
||||
Notes on improving build.gradle compatibility |
||||
--------------------------------------------- |
||||
Ensure that your buildToolsVersion and ndkVersion match what is declared in androidenv. |
||||
If you are using cmake, make sure its declared version is correct too. |
||||
|
||||
Otherwise, you may get cryptic errors from aapt2 and the Android Gradle plugin warning |
||||
that it cannot install the build tools because the SDK directory is not writeable. |
||||
|
||||
```gradle |
||||
android { |
||||
buildToolsVersion "30.0.3" |
||||
ndkVersion = "22.0.7026061" |
||||
externalNativeBuild { |
||||
cmake { |
||||
version "3.10.2" |
||||
} |
||||
} |
||||
} |
||||
|
||||
``` |
||||
|
||||
Querying the available versions of each plugin |
||||
---------------------------------------------- |
||||
repo.json provides all the options in one file now. |
||||
|
||||
A shell script in the `pkgs/development/mobile/androidenv/` subdirectory can be used to retrieve all |
||||
possible options: |
||||
|
||||
```bash |
||||
./querypackages.sh packages |
||||
``` |
||||
|
||||
The above command-line instruction queries all package versions in repo.json. |
||||
|
||||
Updating the generated expressions |
||||
---------------------------------- |
||||
repo.json is generated from XML files that the Android Studio package manager uses. |
||||
To update the expressions run the `generate.sh` script that is stored in the |
||||
`pkgs/development/mobile/androidenv/` subdirectory: |
||||
|
||||
```bash |
||||
./generate.sh |
||||
``` |
||||
@ -0,0 +1,289 @@ |
||||
# BEAM Languages (Erlang, Elixir & LFE) {#sec-beam} |
||||
|
||||
## Introduction {#beam-introduction} |
||||
|
||||
In this document and related Nix expressions, we use the term, _BEAM_, to describe the environment. BEAM is the name of the Erlang Virtual Machine and, as far as we're concerned, from a packaging perspective, all languages that run on the BEAM are interchangeable. That which varies, like the build system, is transparent to users of any given BEAM package, so we make no distinction. |
||||
|
||||
## Structure {#beam-structure} |
||||
|
||||
All BEAM-related expressions are available via the top-level `beam` attribute, which includes: |
||||
|
||||
- `interpreters`: a set of compilers running on the BEAM, including multiple Erlang/OTP versions (`beam.interpreters.erlangR22`, etc), Elixir (`beam.interpreters.elixir`) and LFE (Lisp Flavoured Erlang) (`beam.interpreters.lfe`). |
||||
|
||||
- `packages`: a set of package builders (Mix and rebar3), each compiled with a specific Erlang/OTP version, e.g. `beam.packages.erlang22`. |
||||
|
||||
The default Erlang compiler, defined by `beam.interpreters.erlang`, is aliased as `erlang`. The default BEAM package set is defined by `beam.packages.erlang` and aliased at the top level as `beamPackages`. |
||||
|
||||
To create a package builder built with a custom Erlang version, use the lambda, `beam.packagesWith`, which accepts an Erlang/OTP derivation and produces a package builder similar to `beam.packages.erlang`. |
||||
|
||||
Many Erlang/OTP distributions available in `beam.interpreters` have versions with ODBC and/or Java enabled or without wx (no observer support). For example, there's `beam.interpreters.erlangR22_odbc_javac`, which corresponds to `beam.interpreters.erlangR22` and `beam.interpreters.erlangR22_nox`, which corresponds to `beam.interpreters.erlangR22`. |
||||
|
||||
## Build Tools {#build-tools} |
||||
|
||||
### Rebar3 {#build-tools-rebar3} |
||||
|
||||
We provide a version of Rebar3, under `rebar3`. We also provide a helper to fetch Rebar3 dependencies from a lockfile under `fetchRebar3Deps`. |
||||
|
||||
We also provide a version on Rebar3 with plugins included, under `rebar3WithPlugins`. This package is a function which takes two arguments: `plugins`, a list of nix derivations to include as plugins (loaded only when specified in `rebar.config`), and `globalPlugins`, which should always be loaded by rebar3. Example: `rebar3WithPlugins { globalPlugins = [beamPackages.pc]; }`. |
||||
|
||||
When adding a new plugin it is important that the `packageName` attribute is the same as the atom used by rebar3 to refer to the plugin. |
||||
|
||||
### Mix & Erlang.mk {#build-tools-other} |
||||
|
||||
Erlang.mk works exactly as expected. There is a bootstrap process that needs to be run, which is supported by the `buildErlangMk` derivation. |
||||
|
||||
For Elixir applications use `mixRelease` to make a release. See examples for more details. |
||||
|
||||
There is also a `buildMix` helper, whose behavior is closer to that of `buildErlangMk` and `buildRebar3`. The primary difference is that mixRelease makes a release, while buildMix only builds the package, making it useful for libraries and other dependencies. |
||||
|
||||
## How to Install BEAM Packages {#how-to-install-beam-packages} |
||||
|
||||
BEAM builders are not registered at the top level, simply because they are not relevant to the vast majority of Nix users. To install any of those builders into your profile, refer to them by their attribute path `beamPackages.rebar3`: |
||||
|
||||
```ShellSession |
||||
$ nix-env -f "<nixpkgs>" -iA beamPackages.rebar3 |
||||
``` |
||||
|
||||
## Packaging BEAM Applications {#packaging-beam-applications} |
||||
|
||||
### Erlang Applications {#packaging-erlang-applications} |
||||
|
||||
#### Rebar3 Packages {#rebar3-packages} |
||||
|
||||
The Nix function, `buildRebar3`, defined in `beam.packages.erlang.buildRebar3` and aliased at the top level, can be used to build a derivation that understands how to build a Rebar3 project. |
||||
|
||||
If a package needs to compile native code via Rebar3's port compilation mechanism, add `compilePort = true;` to the derivation. |
||||
|
||||
#### Erlang.mk Packages {#erlang-mk-packages} |
||||
|
||||
Erlang.mk functions similarly to Rebar3, except we use `buildErlangMk` instead of `buildRebar3`. |
||||
|
||||
#### Mix Packages {#mix-packages} |
||||
|
||||
`mixRelease` is used to make a release in the mix sense. Dependencies will need to be fetched with `fetchMixDeps` and passed to it. |
||||
|
||||
#### mixRelease - Elixir Phoenix example |
||||
|
||||
Here is how your `default.nix` file would look. |
||||
|
||||
```nix |
||||
with import <nixpkgs> { }; |
||||
|
||||
let |
||||
packages = beam.packagesWith beam.interpreters.erlang; |
||||
src = builtins.fetchgit { |
||||
url = "ssh://git@github.com/your_id/your_repo"; |
||||
rev = "replace_with_your_commit"; |
||||
}; |
||||
|
||||
pname = "your_project"; |
||||
version = "0.0.1"; |
||||
mixEnv = "prod"; |
||||
|
||||
mixDeps = packages.fetchMixDeps { |
||||
pname = "mix-deps-${pname}"; |
||||
inherit src mixEnv version; |
||||
# nix will complain and tell you the right value to replace this with |
||||
sha256 = lib.fakeSha256; |
||||
# if you have build time environment variables add them here |
||||
MY_ENV_VAR="my_value"; |
||||
}; |
||||
|
||||
nodeDependencies = (pkgs.callPackage ./assets/default.nix { }).shell.nodeDependencies; |
||||
|
||||
frontEndFiles = stdenvNoCC.mkDerivation { |
||||
pname = "frontend-${pname}"; |
||||
|
||||
nativeBuildInputs = [ nodejs ]; |
||||
|
||||
inherit version src; |
||||
|
||||
buildPhase = '' |
||||
cp -r ./assets $TEMPDIR |
||||
|
||||
mkdir -p $TEMPDIR/assets/node_modules/.cache |
||||
cp -r ${nodeDependencies}/lib/node_modules $TEMPDIR/assets |
||||
export PATH="${nodeDependencies}/bin:$PATH" |
||||
|
||||
cd $TEMPDIR/assets |
||||
webpack --config ./webpack.config.js |
||||
cd .. |
||||
''; |
||||
|
||||
installPhase = '' |
||||
cp -r ./priv/static $out/ |
||||
''; |
||||
|
||||
outputHashAlgo = "sha256"; |
||||
outputHashMode = "recursive"; |
||||
# nix will complain and tell you the right value to replace this with |
||||
outputHash = lib.fakeSha256; |
||||
|
||||
impureEnvVars = lib.fetchers.proxyImpureEnvVars; |
||||
}; |
||||
|
||||
|
||||
in packages.mixRelease { |
||||
inherit src pname version mixEnv mixDeps; |
||||
# if you have build time environment variables add them here |
||||
MY_ENV_VAR="my_value"; |
||||
preInstall = '' |
||||
mkdir -p ./priv/static |
||||
cp -r ${frontEndFiles} ./priv/static |
||||
''; |
||||
} |
||||
``` |
||||
|
||||
Setup will require the following steps: |
||||
|
||||
- Move your secrets to runtime environment variables. For more information refer to the [runtime.exs docs](https://hexdocs.pm/mix/Mix.Tasks.Release.html#module-runtime-configuration). On a fresh Phoenix build that would mean that both `DATABASE_URL` and `SECRET_KEY` need to be moved to `runtime.exs`. |
||||
- `cd assets` and `nix-shell -p node2nix --run node2nix --development` will generate a Nix expression containing your frontend dependencies |
||||
- commit and push those changes |
||||
- you can now `nix-build .` |
||||
- To run the release, set the `RELEASE_TMP` environment variable to a directory that your program has write access to. It will be used to store the BEAM settings. |
||||
|
||||
#### Example of creating a service for an Elixir - Phoenix project |
||||
|
||||
In order to create a service with your release, you could add a `service.nix` |
||||
in your project with the following |
||||
|
||||
```nix |
||||
{config, pkgs, lib, ...}: |
||||
|
||||
let |
||||
release = pkgs.callPackage ./default.nix; |
||||
release_name = "app"; |
||||
working_directory = "/home/app"; |
||||
in |
||||
{ |
||||
systemd.services.${release_name} = { |
||||
wantedBy = [ "multi-user.target" ]; |
||||
after = [ "network.target" "postgresql.service" ]; |
||||
requires = [ "network-online.target" "postgresql.service" ]; |
||||
description = "my app"; |
||||
environment = { |
||||
# RELEASE_TMP is used to write the state of the |
||||
# VM configuration when the system is running |
||||
# it needs to be a writable directory |
||||
RELEASE_TMP = working_directory; |
||||
# can be generated in an elixir console with |
||||
# Base.encode32(:crypto.strong_rand_bytes(32)) |
||||
RELEASE_COOKIE = "my_cookie"; |
||||
MY_VAR = "my_var"; |
||||
}; |
||||
serviceConfig = { |
||||
Type = "exec"; |
||||
DynamicUser = true; |
||||
WorkingDirectory = working_directory; |
||||
# Implied by DynamicUser, but just to emphasize due to RELEASE_TMP |
||||
PrivateTmp = true; |
||||
ExecStart = '' |
||||
${release}/bin/${release_name} start |
||||
''; |
||||
ExecStop = '' |
||||
${release}/bin/${release_name} stop |
||||
''; |
||||
ExecReload = '' |
||||
${release}/bin/${release_name} restart |
||||
''; |
||||
Restart = "on-failure"; |
||||
RestartSec = 5; |
||||
StartLimitBurst = 3; |
||||
StartLimitInterval = 10; |
||||
}; |
||||
# disksup requires bash |
||||
path = [ pkgs.bash ]; |
||||
}; |
||||
|
||||
environment.systemPackages = [ release ]; |
||||
} |
||||
``` |
||||
|
||||
## How to Develop {#how-to-develop} |
||||
|
||||
### Creating a Shell {#creating-a-shell} |
||||
|
||||
Usually, we need to create a `shell.nix` file and do our development inside of the environment specified therein. Just install your version of Erlang and any other interpreters, and then use your normal build tools. As an example with Elixir: |
||||
|
||||
```nix |
||||
{ pkgs ? import "<nixpkgs"> {} }: |
||||
|
||||
with pkgs; |
||||
|
||||
let |
||||
|
||||
elixir = beam.packages.erlangR22.elixir_1_9; |
||||
|
||||
in |
||||
mkShell { |
||||
buildInputs = [ elixir ]; |
||||
|
||||
ERL_INCLUDE_PATH="${erlang}/lib/erlang/usr/include"; |
||||
} |
||||
``` |
||||
|
||||
#### Elixir - Phoenix project |
||||
|
||||
Here is an example `shell.nix`. |
||||
|
||||
```nix |
||||
with import <nixpkgs> { }; |
||||
|
||||
let |
||||
# define packages to install |
||||
basePackages = [ |
||||
git |
||||
# replace with beam.packages.erlang.elixir_1_11 if you need |
||||
beam.packages.erlang.elixir |
||||
nodejs |
||||
postgresql_13 |
||||
# only used for frontend dependencies |
||||
# you are free to use yarn2nix as well |
||||
nodePackages.node2nix |
||||
# formatting js file |
||||
nodePackages.prettier |
||||
]; |
||||
|
||||
inputs = basePackages ++ lib.optionals stdenv.isLinux [ inotify-tools ] |
||||
++ lib.optionals stdenv.isDarwin |
||||
(with darwin.apple_sdk.frameworks; [ CoreFoundation CoreServices ]); |
||||
|
||||
# define shell startup command |
||||
hooks = '' |
||||
# this allows mix to work on the local directory |
||||
mkdir -p .nix-mix .nix-hex |
||||
export MIX_HOME=$PWD/.nix-mix |
||||
export HEX_HOME=$PWD/.nix-mix |
||||
export PATH=$MIX_HOME/bin:$HEX_HOME/bin:$PATH |
||||
# TODO: not sure how to make hex available without installing it afterwards. |
||||
mix local.hex --if-missing |
||||
export LANG=en_US.UTF-8 |
||||
export ERL_AFLAGS="-kernel shell_history enabled" |
||||
|
||||
# postges related |
||||
# keep all your db data in a folder inside the project |
||||
export PGDATA="$PWD/db" |
||||
|
||||
# phoenix related env vars |
||||
export POOL_SIZE=15 |
||||
export DB_URL="postgresql://postgres:postgres@localhost:5432/db" |
||||
export PORT=4000 |
||||
export MIX_ENV=dev |
||||
# add your project env vars here, word readable in the nix store. |
||||
export ENV_VAR="your_env_var" |
||||
''; |
||||
|
||||
in mkShell { |
||||
buildInputs = inputs; |
||||
shellHook = hooks; |
||||
} |
||||
``` |
||||
|
||||
Initializing the project will require the following steps: |
||||
|
||||
- create the db directory `initdb ./db` (inside your mix project folder) |
||||
- create the postgres user `createuser postgres -ds` |
||||
- create the db `createdb db` |
||||
- start the postgres instance `pg_ctl -l "$PGDATA/server.log" start` |
||||
- add the `/db` folder to your `.gitignore` |
||||
- you can start your phoenix server and get a shell with `iex -S mix phx.server` |
||||
@ -0,0 +1,158 @@ |
||||
# Bower {#sec-bower} |
||||
|
||||
[Bower](https://bower.io) is a package manager for web site front-end components. Bower packages (comprising of build artefacts and sometimes sources) are stored in `git` repositories, typically on Github. The package registry is run by the Bower team with package metadata coming from the `bower.json` file within each package. |
||||
|
||||
The end result of running Bower is a `bower_components` directory which can be included in the web app's build process. |
||||
|
||||
Bower can be run interactively, by installing `nodePackages.bower`. More interestingly, the Bower components can be declared in a Nix derivation, with the help of `nodePackages.bower2nix`. |
||||
|
||||
## bower2nix usage {#ssec-bower2nix-usage} |
||||
|
||||
Suppose you have a `bower.json` with the following contents: |
||||
|
||||
### Example bower.json {#ex-bowerJson} |
||||
|
||||
```json |
||||
"name": "my-web-app", |
||||
"dependencies": { |
||||
"angular": "~1.5.0", |
||||
"bootstrap": "~3.3.6" |
||||
} |
||||
``` |
||||
|
||||
Running `bower2nix` will produce something like the following output: |
||||
|
||||
```nix |
||||
{ fetchbower, buildEnv }: |
||||
buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ |
||||
(fetchbower "angular" "1.5.3" "~1.5.0" "1749xb0firxdra4rzadm4q9x90v6pzkbd7xmcyjk6qfza09ykk9y") |
||||
(fetchbower "bootstrap" "3.3.6" "~3.3.6" "1vvqlpbfcy0k5pncfjaiskj3y6scwifxygfqnw393sjfxiviwmbv") |
||||
(fetchbower "jquery" "2.2.2" "1.9.1 - 2" "10sp5h98sqwk90y4k6hbdviwqzvzwqf47r3r51pakch5ii2y7js1") |
||||
]; |
||||
``` |
||||
|
||||
Using the `bower2nix` command line arguments, the output can be redirected to a file. A name like `bower-packages.nix` would be fine. |
||||
|
||||
The resulting derivation is a union of all the downloaded Bower packages (and their dependencies). To use it, they still need to be linked together by Bower, which is where `buildBowerComponents` is useful. |
||||
|
||||
## buildBowerComponents function {#ssec-build-bower-components} |
||||
|
||||
The function is implemented in [pkgs/development/bower-modules/generic/default.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix). |
||||
|
||||
### Example buildBowerComponents {#ex-buildBowerComponents} |
||||
|
||||
```{=docbook} |
||||
<programlisting language="nix"> |
||||
bowerComponents = buildBowerComponents { |
||||
name = "my-web-app"; |
||||
generated = ./bower-packages.nix; <co xml:id="ex-buildBowerComponents-1" /> |
||||
src = myWebApp; <co xml:id="ex-buildBowerComponents-2" /> |
||||
}; |
||||
</programlisting> |
||||
``` |
||||
|
||||
In ["buildBowerComponents" example](#ex-buildBowerComponents) the following arguments are of special significance to the function: |
||||
|
||||
```{=docbook} |
||||
<calloutlist> |
||||
<callout arearefs="ex-buildBowerComponents-1"> |
||||
<para> |
||||
<varname>generated</varname> specifies the file which was created by <command>bower2nix</command>. |
||||
</para> |
||||
</callout> |
||||
<callout arearefs="ex-buildBowerComponents-2"> |
||||
<para> |
||||
<varname>src</varname> is your project's sources. It needs to contain a <filename>bower.json</filename> file. |
||||
</para> |
||||
</callout> |
||||
</calloutlist> |
||||
``` |
||||
|
||||
`buildBowerComponents` will run Bower to link together the output of `bower2nix`, resulting in a `bower_components` directory which can be used. |
||||
|
||||
Here is an example of a web frontend build process using `gulp`. You might use `grunt`, or anything else. |
||||
|
||||
### Example build script (gulpfile.js) {#ex-bowerGulpFile} |
||||
|
||||
```javascript |
||||
var gulp = require('gulp'); |
||||
|
||||
gulp.task('default', [], function () { |
||||
gulp.start('build'); |
||||
}); |
||||
|
||||
gulp.task('build', [], function () { |
||||
console.log("Just a dummy gulp build"); |
||||
gulp |
||||
.src(["./bower_components/**/*"]) |
||||
.pipe(gulp.dest("./gulpdist/")); |
||||
}); |
||||
``` |
||||
|
||||
### Example Full example — default.nix {#ex-buildBowerComponentsDefaultNix} |
||||
|
||||
```{=docbook} |
||||
<programlisting language="nix"> |
||||
{ myWebApp ? { outPath = ./.; name = "myWebApp"; } |
||||
, pkgs ? import <nixpkgs> {} |
||||
}: |
||||
|
||||
pkgs.stdenv.mkDerivation { |
||||
name = "my-web-app-frontend"; |
||||
src = myWebApp; |
||||
|
||||
buildInputs = [ pkgs.nodePackages.gulp ]; |
||||
|
||||
bowerComponents = pkgs.buildBowerComponents { <co xml:id="ex-buildBowerComponentsDefault-1" /> |
||||
name = "my-web-app"; |
||||
generated = ./bower-packages.nix; |
||||
src = myWebApp; |
||||
}; |
||||
|
||||
buildPhase = '' |
||||
cp --reflink=auto --no-preserve=mode -R $bowerComponents/bower_components . <co xml:id="ex-buildBowerComponentsDefault-2" /> |
||||
export HOME=$PWD <co xml:id="ex-buildBowerComponentsDefault-3" /> |
||||
${pkgs.nodePackages.gulp}/bin/gulp build <co xml:id="ex-buildBowerComponentsDefault-4" /> |
||||
''; |
||||
|
||||
installPhase = "mv gulpdist $out"; |
||||
} |
||||
</programlisting> |
||||
``` |
||||
|
||||
A few notes about [Full example — `default.nix`](#ex-buildBowerComponentsDefaultNix): |
||||
|
||||
```{=docbook} |
||||
<calloutlist> |
||||
<callout arearefs="ex-buildBowerComponentsDefault-1"> |
||||
<para> |
||||
The result of <varname>buildBowerComponents</varname> is an input to the frontend build. |
||||
</para> |
||||
</callout> |
||||
<callout arearefs="ex-buildBowerComponentsDefault-2"> |
||||
<para> |
||||
Whether to symlink or copy the <filename>bower_components</filename> directory depends on the build tool in use. In this case a copy is used to avoid <command>gulp</command> silliness with permissions. |
||||
</para> |
||||
</callout> |
||||
<callout arearefs="ex-buildBowerComponentsDefault-3"> |
||||
<para> |
||||
<command>gulp</command> requires <varname>HOME</varname> to refer to a writeable directory. |
||||
</para> |
||||
</callout> |
||||
<callout arearefs="ex-buildBowerComponentsDefault-4"> |
||||
<para> |
||||
The actual build command. Other tools could be used. |
||||
</para> |
||||
</callout> |
||||
</calloutlist> |
||||
``` |
||||
|
||||
## Troubleshooting {#ssec-bower2nix-troubleshooting} |
||||
|
||||
### ENOCACHE errors from buildBowerComponents |
||||
|
||||
This means that Bower was looking for a package version which doesn't exist in the generated `bower-packages.nix`. |
||||
|
||||
If `bower.json` has been updated, then run `bower2nix` again. |
||||
|
||||
It could also be a bug in `bower2nix` or `fetchbower`. If possible, try reformulating the version specification in `bower.json`. |
||||
@ -0,0 +1,81 @@ |
||||
# Coq and coq packages {#sec-language-coq} |
||||
|
||||
## Coq derivation: `coq` |
||||
|
||||
The Coq derivation is overridable through the `coq.override overrides`, where overrides is an attribute set which contains the arguments to override. We recommend overriding either of the following |
||||
|
||||
* `version` (optional, defaults to the latest version of Coq selected for nixpkgs, see `pkgs/top-level/coq-packages` to witness this choice), which follows the conventions explained in the `coqPackages` section below, |
||||
* `customOCamlPackage` (optional, defaults to `null`, which lets Coq choose a version automatically), which can be set to any of the ocaml packages attribute of `ocaml-ng` (such as `ocaml-ng.ocamlPackages_4_10` which is the default for Coq 8.11 for example). |
||||
* `coq-version` (optional, defaults to the short version e.g. "8.10"), is a version number of the form "x.y" that indicates which Coq's version build behavior to mimic when using a source which is not a release. E.g. `coq.override { version = "d370a9d1328a4e1cdb9d02ee032f605a9d94ec7a"; coq-version = "8.10"; }`. |
||||
|
||||
## Coq packages attribute sets: `coqPackages` |
||||
|
||||
The recommended way of defining a derivation for a Coq library, is to use the `coqPackages.mkCoqDerivation` function, which is essentially a specialization of `mkDerivation` taking into account most of the specifics of Coq libraries. The following attributes are supported: |
||||
|
||||
* `pname` (required) is the name of the package, |
||||
* `version` (optional, defaults to `null`), is the version to fetch and build, |
||||
this attribute is interpreted in several ways depending on its type and pattern: |
||||
* if it is a known released version string, i.e. from the `release` attribute below, the according release is picked, and the `version` attribute of the resulting derivation is set to this release string, |
||||
* if it is a majorMinor `"x.y"` prefix of a known released version (as defined above), then the latest `"x.y.z"` known released version is selected (for the ordering given by `versionAtLeast`), |
||||
* if it is a path or a string representing an absolute path (i.e. starting with `"/"`), the provided path is selected as a source, and the `version` attribute of the resulting derivation is set to `"dev"`, |
||||
* if it is a string of the form `owner:branch` then it tries to download the `branch` of owner `owner` for a project of the same name using the same vcs, and the `version` attribute of the resulting derivation is set to `"dev"`, additionally if the owner is not provided (i.e. if the `owner:` prefix is missing), it defaults to the original owner of the package (see below), |
||||
* if it is a string of the form `"#N"`, and the domain is github, then it tries to download the current head of the pull request `#N` from github, |
||||
* `defaultVersion` (optional). Coq libraries may be compatible with some specific versions of Coq only. The `defaultVersion` attribute is used when no `version` is provided (or if `version = null`) to select the version of the library to use by default, depending on the context. This selection will mainly depend on a `coq` version number but also possibly on other packages versions (e.g. `mathcomp`). If its value ends up to be `null`, the package is marked for removal in end-user `coqPackages` attribute set. |
||||
* `release` (optional, defaults to `{}`), lists all the known releases of the library and for each of them provides an attribute set with at least a `sha256` attribute (you may put the empty string `""` in order to automatically insert a fake sha256, this will trigger an error which will allow you to find the correct sha256), each attribute set of the list of releases also takes optional overloading arguments for the fetcher as below (i.e.`domain`, `owner`, `repo`, `rev` assuming the default fetcher is used) and optional overrides for the result of the fetcher (i.e. `version` and `src`). |
||||
* `fetcher` (optional, defaults to a generic fetching mechanism supporting github or gitlab based infrastructures), is a function that takes at least an `owner`, a `repo`, a `rev`, and a `sha256` and returns an attribute set with a `version` and `src`. |
||||
* `repo` (optional, defaults to the value of `pname`), |
||||
* `owner` (optional, defaults to `"coq-community"`). |
||||
* `domain` (optional, defaults to `"github.com"`), domains including the strings `"github"` or `"gitlab"` in their names are automatically supported, otherwise, one must change the `fetcher` argument to support them (cf `pkgs/development/coq-modules/heq/default.nix` for an example), |
||||
* `releaseRev` (optional, defaults to `(v: v)`), provides a default mapping from release names to revision hashes/branch names/tags, |
||||
* `displayVersion` (optional), provides a way to alter the computation of `name` from `pname`, by explaining how to display version numbers, |
||||
* `namePrefix` (optional), provides a way to alter the computation of `name` from `pname`, by explaining which dependencies must occur in `name`, |
||||
* `extraBuildInputs` (optional), by default `buildInputs` just contains `coq`, this allows to add more build inputs, |
||||
* `mlPlugin` (optional, defaults to `false`). Some extensions (plugins) might require OCaml and sometimes other OCaml packages. Standard dependencies can be added by setting the current option to `true`. For a finer grain control, the `coq.ocamlPackages` attribute can be used in `extraBuildInputs` to depend on the same package set Coq was built against. |
||||
* `useDune2ifVersion` (optional, default to `(x: false)` uses Dune2 to build the package if the provided predicate evaluates to true on the version, e.g. `useDune2if = versions.isGe "1.1"` will use dune if the version of the package is greater or equal to `"1.1"`, |
||||
* `useDune2` (optional, defaults to `false`) uses Dune2 to build the package if set to true, the presence of this attribute overrides the behavior of the previous one. |
||||
* `enableParallelBuilding` (optional, defaults to `true`), since it is activated by default, we provide a way to disable it. |
||||
* `extraInstallFlags` (optional), allows to extend `installFlags` which initializes the variable `COQMF_COQLIB` so as to install in the proper subdirectory. Indeed Coq libraries should be installed in `$(out)/lib/coq/${coq.coq-version}/user-contrib/`. Such directories are automatically added to the `$COQPATH` environment variable by the hook defined in the Coq derivation. |
||||
* `setCOQBIN` (optional, defaults to `true`), by default, the environment variable `$COQBIN` is set to the current Coq's binary, but one can disable this behavior by setting it to `false`, |
||||
* `useMelquiondRemake` (optional, default to `null`) is an attribute set, which, if given, overloads the `preConfigurePhases`, `configureFlags`, `buildPhase`, and `installPhase` attributes of the derivation for a specific use in libraries using `remake` as set up by Guillaume Melquiond for `flocq`, `gappalib`, `interval`, and `coquelicot` (see the corresponding derivation for concrete examples of use of this option). For backward compatibility, the attribute `useMelquiondRemake.logpath` must be set to the logical root of the library (otherwise, one can pass `useMelquiondRemake = {}` to activate this without backward compatibility). |
||||
* `dropAttrs`, `keepAttrs`, `dropDerivationAttrs` are all optional and allow to tune which attribute is added or removed from the final call to `mkDerivation`. |
||||
|
||||
It also takes other standard `mkDerivation` attributes, they are added as such, except for `meta` which extends an automatically computed `meta` (where the `platform` is the same as `coq` and the homepage is automatically computed). |
||||
|
||||
Here is a simple package example. It is a pure Coq library, thus it depends on Coq. It builds on the Mathematical Components library, thus it also takes some `mathcomp` derivations as `extraBuildInputs`. |
||||
|
||||
```nix |
||||
{ lib, mkCoqDerivation, version ? null |
||||
, coq, mathcomp, mathcomp-finmap, mathcomp-bigenough }: |
||||
with lib; mkCoqDerivation { |
||||
/* namePrefix leads to e.g. `name = coq8.11-mathcomp1.11-multinomials-1.5.2` */ |
||||
namePrefix = [ "coq" "mathcomp" ]; |
||||
pname = "multinomials"; |
||||
owner = "math-comp"; |
||||
inherit version; |
||||
defaultVersion = with versions; switch [ coq.version mathcomp.version ] [ |
||||
{ cases = [ (range "8.7" "8.12") "1.11.0" ]; out = "1.5.2"; } |
||||
{ cases = [ (range "8.7" "8.11") (range "1.8" "1.10") ]; out = "1.5.0"; } |
||||
{ cases = [ (range "8.7" "8.10") (range "1.8" "1.10") ]; out = "1.4"; } |
||||
{ cases = [ "8.6" (range "1.6" "1.7") ]; out = "1.1"; } |
||||
] null; |
||||
release = { |
||||
"1.5.2".sha256 = "15aspf3jfykp1xgsxf8knqkxv8aav2p39c2fyirw7pwsfbsv2c4s"; |
||||
"1.5.1".sha256 = "13nlfm2wqripaq671gakz5mn4r0xwm0646araxv0nh455p9ndjs3"; |
||||
"1.5.0".sha256 = "064rvc0x5g7y1a0nip6ic91vzmq52alf6in2bc2dmss6dmzv90hw"; |
||||
"1.5.0".rev = "1.5"; |
||||
"1.4".sha256 = "0vnkirs8iqsv8s59yx1fvg1nkwnzydl42z3scya1xp1b48qkgn0p"; |
||||
"1.3".sha256 = "0l3vi5n094nx3qmy66hsv867fnqm196r8v605kpk24gl0aa57wh4"; |
||||
"1.2".sha256 = "1mh1w339dslgv4f810xr1b8v2w7rpx6fgk9pz96q0fyq49fw2xcq"; |
||||
"1.1".sha256 = "1q8alsm89wkc0lhcvxlyn0pd8rbl2nnxg81zyrabpz610qqjqc3s"; |
||||
"1.0".sha256 = "1qmbxp1h81cy3imh627pznmng0kvv37k4hrwi2faa101s6bcx55m"; |
||||
}; |
||||
|
||||
propagatedBuildInputs = |
||||
[ mathcomp.ssreflect mathcomp.algebra mathcomp-finmap mathcomp-bigenough ]; |
||||
|
||||
meta = { |
||||
description = "A Coq/SSReflect Library for Monoidal Rings and Multinomials"; |
||||
license = licenses.cecill-c; |
||||
}; |
||||
} |
||||
``` |
||||
@ -0,0 +1,71 @@ |
||||
# Crystal {#crystal} |
||||
|
||||
## Building a Crystal package |
||||
|
||||
This section uses [Mint](https://github.com/mint-lang/mint) as an example for how to build a Crystal package. |
||||
|
||||
If the Crystal project has any dependencies, the first step is to get a `shards.nix` file encoding those. Get a copy of the project and go to its root directory such that its `shard.lock` file is in the current directory, then run `crystal2nix` in it |
||||
```bash |
||||
$ git clone https://github.com/mint-lang/mint |
||||
$ cd mint |
||||
$ git checkout 0.5.0 |
||||
$ nix-shell -p crystal2nix --run crystal2nix |
||||
``` |
||||
|
||||
This should have generated a `shards.nix` file. |
||||
|
||||
Next create a Nix file for your derivation and use `pkgs.crystal.buildCrystalPackage` as follows: |
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
crystal.buildCrystalPackage rec { |
||||
pname = "mint"; |
||||
version = "0.5.0"; |
||||
|
||||
src = fetchFromGitHub { |
||||
owner = "mint-lang"; |
||||
repo = "mint"; |
||||
rev = version; |
||||
sha256 = "0vxbx38c390rd2ysvbwgh89v2232sh5rbsp3nk9wzb70jybpslvl"; |
||||
}; |
||||
|
||||
# Insert the path to your shards.nix file here |
||||
shardsFile = ./shards.nix; |
||||
|
||||
... |
||||
} |
||||
``` |
||||
|
||||
This won't build anything yet, because we haven't told it what files build. We can specify a mapping from binary names to source files with the `crystalBinaries` attribute. The project's compilation instructions should show this. For Mint, the binary is called "mint", which is compiled from the source file `src/mint.cr`, so we'll specify this as follows: |
||||
|
||||
```nix |
||||
crystalBinaries.mint.src = "src/mint.cr"; |
||||
|
||||
# ... |
||||
``` |
||||
|
||||
Additionally you can override the default `crystal build` options (which are currently `--release --progress --no-debug --verbose`) with |
||||
|
||||
```nix |
||||
crystalBinaries.mint.options = [ "--release" "--verbose" ]; |
||||
``` |
||||
|
||||
Depending on the project, you might need additional steps to get it to compile successfully. In Mint's case, we need to link against openssl, so in the end the Nix file looks as follows: |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
crystal.buildCrystalPackage rec { |
||||
version = "0.5.0"; |
||||
pname = "mint"; |
||||
src = fetchFromGitHub { |
||||
owner = "mint-lang"; |
||||
repo = "mint"; |
||||
rev = version; |
||||
sha256 = "0vxbx38c390rd2ysvbwgh89v2232sh5rbsp3nk9wzb70jybpslvl"; |
||||
}; |
||||
|
||||
shardsFile = ./shards.nix; |
||||
crystalBinaries.mint.src = "src/mint.cr"; |
||||
|
||||
buildInputs = [ openssl ]; |
||||
} |
||||
``` |
||||
@ -0,0 +1,75 @@ |
||||
# Dotnet |
||||
|
||||
## Local Development Workflow |
||||
|
||||
For local development, it's recommended to use nix-shell to create a dotnet environment: |
||||
|
||||
```nix |
||||
# shell.nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
mkShell { |
||||
name = "dotnet-env"; |
||||
packages = [ |
||||
dotnet-sdk_3 |
||||
]; |
||||
} |
||||
``` |
||||
|
||||
### Using many sdks in a workflow |
||||
|
||||
It's very likely that more than one sdk will be needed on a given project. Dotnet provides several different frameworks (E.g dotnetcore, aspnetcore, etc.) as well as many versions for a given framework. Normally, dotnet is able to fetch a framework and install it relative to the executable. However, this would mean writing to the nix store in nixpkgs, which is read-only. To support the many-sdk use case, one can compose an environment using `dotnetCorePackages.combinePackages`: |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
mkShell { |
||||
name = "dotnet-env"; |
||||
packages = [ |
||||
(with dotnetCorePackages; combinePackages [ |
||||
sdk_3_1 |
||||
sdk_3_0 |
||||
sdk_2_1 |
||||
]) |
||||
]; |
||||
} |
||||
``` |
||||
|
||||
This will produce a dotnet installation that has the dotnet 3.1, 3.0, and 2.1 sdk. The first sdk listed will have it's cli utility present in the resulting environment. Example info output: |
||||
|
||||
```ShellSesssion |
||||
$ dotnet --info |
||||
.NET Core SDK (reflecting any global.json): |
||||
Version: 3.1.101 |
||||
Commit: b377529961 |
||||
|
||||
... |
||||
|
||||
.NET Core SDKs installed: |
||||
2.1.803 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/sdk] |
||||
3.0.102 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/sdk] |
||||
3.1.101 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/sdk] |
||||
|
||||
.NET Core runtimes installed: |
||||
Microsoft.AspNetCore.All 2.1.15 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.AspNetCore.All] |
||||
Microsoft.AspNetCore.App 2.1.15 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.AspNetCore.App] |
||||
Microsoft.AspNetCore.App 3.0.2 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.AspNetCore.App] |
||||
Microsoft.AspNetCore.App 3.1.1 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.AspNetCore.App] |
||||
Microsoft.NETCore.App 2.1.15 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.NETCore.App] |
||||
Microsoft.NETCore.App 3.0.2 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.NETCore.App] |
||||
Microsoft.NETCore.App 3.1.1 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.NETCore.App] |
||||
``` |
||||
|
||||
## dotnet-sdk vs dotnetCorePackages.sdk |
||||
|
||||
The `dotnetCorePackages.sdk_X_Y` is preferred over the old dotnet-sdk as both major and minor version are very important for a dotnet environment. If a given minor version isn't present (or was changed), then this will likely break your ability to build a project. |
||||
|
||||
## dotnetCorePackages.sdk vs dotnetCorePackages.net vs dotnetCorePackages.netcore vs dotnetCorePackages.aspnetcore |
||||
|
||||
The `dotnetCorePackages.sdk` contains both a runtime and the full sdk of a given version. The `net`, `netcore` and `aspnetcore` packages are meant to serve as minimal runtimes to deploy alongside already built applications. For runtime versions >= .NET 5 `net` is used while `netcore` is used for older .NET Core runtime version. |
||||
|
||||
## Packaging a Dotnet Application |
||||
|
||||
Ideally, we would like to build against the sdk, then only have the dotnet runtime available in the runtime closure. |
||||
|
||||
TODO: Create closure-friendly way to package dotnet applications |
||||
@ -0,0 +1,184 @@ |
||||
# Emscripten {#emscripten} |
||||
|
||||
[Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler |
||||
|
||||
This section of the manual covers how to use `emscripten` in nixpkgs. |
||||
|
||||
Minimal requirements: |
||||
|
||||
* nix |
||||
* nixpkgs |
||||
|
||||
Modes of use of `emscripten`: |
||||
|
||||
* **Imperative usage** (on the command line): |
||||
|
||||
If you want to work with `emcc`, `emconfigure` and `emmake` as you are used to from Ubuntu and similar distributions you can use these commands: |
||||
|
||||
* `nix-env -i emscripten` |
||||
* `nix-shell -p emscripten` |
||||
|
||||
* **Declarative usage**: |
||||
|
||||
This mode is far more power full since this makes use of `nix` for dependency management of emscripten libraries and targets by using the `mkDerivation` which is implemented by `pkgs.emscriptenStdenv` and `pkgs.buildEmscriptenPackage`. The source for the packages is in `pkgs/top-level/emscripten-packages.nix` and the abstraction behind it in `pkgs/development/em-modules/generic/default.nix`. |
||||
* build and install all packages: |
||||
* `nix-env -iA emscriptenPackages` |
||||
|
||||
* dev-shell for zlib implementation hacking: |
||||
* `nix-shell -A emscriptenPackages.zlib` |
||||
|
||||
|
||||
## Imperative usage |
||||
|
||||
A few things to note: |
||||
|
||||
* `export EMCC_DEBUG=2` is nice for debugging |
||||
* `~/.emscripten`, the build artifact cache sometimes creates issues and needs to be removed from time to time |
||||
|
||||
|
||||
## Declarative usage |
||||
|
||||
Let's see two different examples from `pkgs/top-level/emscripten-packages.nix`: |
||||
|
||||
* `pkgs.zlib.override` |
||||
* `pkgs.buildEmscriptenPackage` |
||||
|
||||
Both are interesting concepts. |
||||
|
||||
A special requirement of the `pkgs.buildEmscriptenPackage` is the `doCheck = true` is a default meaning that each emscriptenPackage requires a `checkPhase` implemented. |
||||
|
||||
* Use `export EMCC_DEBUG=2` from within a emscriptenPackage's `phase` to get more detailed debug output what is going wrong. |
||||
* ~/.emscripten cache is requiring us to set `HOME=$TMPDIR` in individual phases. This makes compilation slower but also makes it more deterministic. |
||||
|
||||
### Usage 1: pkgs.zlib.override |
||||
|
||||
This example uses `zlib` from nixpkgs but instead of compiling **C** to **ELF** it compiles **C** to **JS** since we were using `pkgs.zlib.override` and changed stdenv to `pkgs.emscriptenStdenv`. A few adaptions and hacks were set in place to make it working. One advantage is that when `pkgs.zlib` is updated, it will automatically update this package as well. However, this can also be the downside... |
||||
|
||||
See the `zlib` example: |
||||
|
||||
zlib = (pkgs.zlib.override { |
||||
stdenv = pkgs.emscriptenStdenv; |
||||
}).overrideDerivation |
||||
(old: rec { |
||||
buildInputs = old.buildInputs ++ [ pkg-config ]; |
||||
# we need to reset this setting! |
||||
NIX_CFLAGS_COMPILE=""; |
||||
configurePhase = '' |
||||
# FIXME: Some tests require writing at $HOME |
||||
HOME=$TMPDIR |
||||
runHook preConfigure |
||||
|
||||
#export EMCC_DEBUG=2 |
||||
emconfigure ./configure --prefix=$out --shared |
||||
|
||||
runHook postConfigure |
||||
''; |
||||
dontStrip = true; |
||||
outputs = [ "out" ]; |
||||
buildPhase = '' |
||||
emmake make |
||||
''; |
||||
installPhase = '' |
||||
emmake make install |
||||
''; |
||||
checkPhase = '' |
||||
echo "================= testing zlib using node =================" |
||||
|
||||
echo "Compiling a custom test" |
||||
set -x |
||||
emcc -O2 -s EMULATE_FUNCTION_POINTER_CASTS=1 test/example.c -DZ_SOLO \ |
||||
libz.so.${old.version} -I . -o example.js |
||||
|
||||
echo "Using node to execute the test" |
||||
${pkgs.nodejs}/bin/node ./example.js |
||||
|
||||
set +x |
||||
if [ $? -ne 0 ]; then |
||||
echo "test failed for some reason" |
||||
exit 1; |
||||
else |
||||
echo "it seems to work! very good." |
||||
fi |
||||
echo "================= /testing zlib using node =================" |
||||
''; |
||||
|
||||
postPatch = pkgs.lib.optionalString pkgs.stdenv.isDarwin '' |
||||
substituteInPlace configure \ |
||||
--replace '/usr/bin/libtool' 'ar' \ |
||||
--replace 'AR="libtool"' 'AR="ar"' \ |
||||
--replace 'ARFLAGS="-o"' 'ARFLAGS="-r"' |
||||
''; |
||||
}); |
||||
|
||||
### Usage 2: pkgs.buildEmscriptenPackage |
||||
|
||||
This `xmlmirror` example features a emscriptenPackage which is defined completely from this context and no `pkgs.zlib.override` is used. |
||||
|
||||
xmlmirror = pkgs.buildEmscriptenPackage rec { |
||||
name = "xmlmirror"; |
||||
|
||||
buildInputs = [ pkg-config autoconf automake libtool gnumake libxml2 nodejs openjdk json_c ]; |
||||
nativeBuildInputs = [ pkg-config zlib ]; |
||||
|
||||
src = pkgs.fetchgit { |
||||
url = "https://gitlab.com/odfplugfest/xmlmirror.git"; |
||||
rev = "4fd7e86f7c9526b8f4c1733e5c8b45175860a8fd"; |
||||
sha256 = "1jasdqnbdnb83wbcnyrp32f36w3xwhwp0wq8lwwmhqagxrij1r4b"; |
||||
}; |
||||
|
||||
configurePhase = '' |
||||
rm -f fastXmlLint.js* |
||||
# a fix for ERROR:root:For asm.js, TOTAL_MEMORY must be a multiple of 16MB, was 234217728 |
||||
# https://gitlab.com/odfplugfest/xmlmirror/issues/8 |
||||
sed -e "s/TOTAL_MEMORY=234217728/TOTAL_MEMORY=268435456/g" -i Makefile.emEnv |
||||
# https://github.com/kripken/emscripten/issues/6344 |
||||
# https://gitlab.com/odfplugfest/xmlmirror/issues/9 |
||||
sed -e "s/\$(JSONC_LDFLAGS) \$(ZLIB_LDFLAGS) \$(LIBXML20_LDFLAGS)/\$(JSONC_LDFLAGS) \$(LIBXML20_LDFLAGS) \$(ZLIB_LDFLAGS) /g" -i Makefile.emEnv |
||||
# https://gitlab.com/odfplugfest/xmlmirror/issues/11 |
||||
sed -e "s/-o fastXmlLint.js/-s EXTRA_EXPORTED_RUNTIME_METHODS='[\"ccall\", \"cwrap\"]' -o fastXmlLint.js/g" -i Makefile.emEnv |
||||
''; |
||||
|
||||
buildPhase = '' |
||||
HOME=$TMPDIR |
||||
make -f Makefile.emEnv |
||||
''; |
||||
|
||||
outputs = [ "out" "doc" ]; |
||||
|
||||
installPhase = '' |
||||
mkdir -p $out/share |
||||
mkdir -p $doc/share/${name} |
||||
|
||||
cp Demo* $out/share |
||||
cp -R codemirror-5.12 $out/share |
||||
cp fastXmlLint.js* $out/share |
||||
cp *.xsd $out/share |
||||
cp *.js $out/share |
||||
cp *.xhtml $out/share |
||||
cp *.html $out/share |
||||
cp *.json $out/share |
||||
cp *.rng $out/share |
||||
cp README.md $doc/share/${name} |
||||
''; |
||||
checkPhase = '' |
||||
|
||||
''; |
||||
}; |
||||
|
||||
### Declarative debugging |
||||
|
||||
Use `nix-shell -I nixpkgs=/some/dir/nixpkgs -A emscriptenPackages.libz` and from there you can go trough the individual steps. This makes it easy to build a good `unit test` or list the files of the project. |
||||
|
||||
1. `nix-shell -I nixpkgs=/some/dir/nixpkgs -A emscriptenPackages.libz` |
||||
2. `cd /tmp/` |
||||
3. `unpackPhase` |
||||
4. cd libz-1.2.3 |
||||
5. `configurePhase` |
||||
6. `buildPhase` |
||||
7. ... happy hacking... |
||||
|
||||
## Summary |
||||
|
||||
Using this toolchain makes it easy to leverage `nix` from NixOS, MacOSX or even Windows (WSL+ubuntu+nix). This toolchain is reproducible, behaves like the rest of the packages from nixpkgs and contains a set of well working examples to learn and adapt from. |
||||
|
||||
If in trouble, ask the maintainers. |
||||
@ -0,0 +1,204 @@ |
||||
# GNOME {#sec-language-gnome} |
||||
|
||||
## Packaging GNOME applications {#ssec-gnome-packaging} |
||||
|
||||
Programs in the GNOME universe are written in various languages but they all use GObject-based libraries like GLib, GTK or GStreamer. These libraries are often modular, relying on looking into certain directories to find their modules. However, due to Nix’s specific file system organization, this will fail without our intervention. Fortunately, the libraries usually allow overriding the directories through environment variables, either natively or thanks to a patch in nixpkgs. [Wrapping](#fun-wrapProgram) the executables to ensure correct paths are available to the application constitutes a significant part of packaging a modern desktop application. In this section, we will describe various modules needed by such applications, environment variables needed to make the modules load, and finally a script that will do the work for us. |
||||
|
||||
### Settings {#ssec-gnome-settings} |
||||
|
||||
[GSettings](https://developer.gnome.org/gio/stable/GSettings.html) API is often used for storing settings. GSettings schemas are required, to know the type and other metadata of the stored values. GLib looks for `glib-2.0/schemas/gschemas.compiled` files inside the directories of `XDG_DATA_DIRS`. |
||||
|
||||
On Linux, GSettings API is implemented using [dconf](https://wiki.gnome.org/Projects/dconf) backend. You will need to add `dconf` [GIO module](#ssec-gnome-gio-modules) to `GIO_EXTRA_MODULES` variable, otherwise the `memory` backend will be used and the saved settings will not be persistent. |
||||
|
||||
Last you will need the dconf database D-Bus service itself. You can enable it using `programs.dconf.enable`. |
||||
|
||||
Some applications will also require `gsettings-desktop-schemas` for things like reading proxy configuration or user interface customization. This dependency is often not mentioned by upstream, you should grep for `org.gnome.desktop` and `org.gnome.system` to see if the schemas are needed. |
||||
|
||||
### GIO modules {#ssec-gnome-gio-modules} |
||||
|
||||
GLib’s [GIO](https://developer.gnome.org/gio/stable/ch01.html) library supports several [extension points](https://developer.gnome.org/gio/stable/extending-gio.html). Notably, they allow: |
||||
|
||||
* implementing settings backends (already [mentioned](#ssec-gnome-settings)) |
||||
* adding TLS support |
||||
* proxy settings |
||||
* virtual file systems |
||||
|
||||
The modules are typically installed to `lib/gio/modules/` directory of a package and you need to add them to `GIO_EXTRA_MODULES` if you need any of those features. |
||||
|
||||
In particular, we recommend: |
||||
|
||||
* adding `dconf.lib` for any software on Linux that reads [GSettings](#ssec-gnome-settings) (even transitivily through e.g. GTK’s file manager) |
||||
* adding `glib-networking` for any software that accesses network using GIO or libsoup – glib-networking contains a module that implements TLS support and loads system-wide proxy settings |
||||
|
||||
To allow software to use various virtual file systems, `gvfs` package can be also added. But that is usually an optional feature so we typically use `gvfs` from the system (e.g. installed globally using NixOS module). |
||||
|
||||
### GdkPixbuf loaders {#ssec-gnome-gdk-pixbuf-loaders} |
||||
|
||||
GTK applications typically use [GdkPixbuf](https://developer.gnome.org/gdk-pixbuf/stable/) to load images. But `gdk-pixbuf` package only supports basic bitmap formats like JPEG, PNG or TIFF, requiring to use third-party loader modules for other formats. This is especially painful since GTK itself includes SVG icons, which cannot be rendered without a loader provided by `librsvg`. |
||||
|
||||
Unlike other libraries mentioned in this section, GdkPixbuf only supports a single value in its controlling environment variable `GDK_PIXBUF_MODULE_FILE`. It is supposed to point to a cache file containing information about the available loaders. Each loader package will contain a `lib/gdk-pixbuf-2.0/2.10.0/loaders.cache` file describing the default loaders in `gdk-pixbuf` package plus the loader contained in the package itself. If you want to use multiple third-party loaders, you will need to create your own cache file manually. Fortunately, this is pretty rare as [not many loaders exist](https://gitlab.gnome.org/federico/gdk-pixbuf-survey/blob/master/src/modules.md). |
||||
|
||||
`gdk-pixbuf` contains [a setup hook](#ssec-gnome-hooks-gdk-pixbuf) that sets `GDK_PIXBUF_MODULE_FILE` from dependencies but as mentioned in further section, it is pretty limited. Loaders should propagate this setup hook. |
||||
|
||||
### Icons {#ssec-gnome-icons} |
||||
|
||||
When an application uses icons, an icon theme should be available in `XDG_DATA_DIRS` during runtime. The package for the default, icon-less [hicolor-icon-theme](https://www.freedesktop.org/wiki/Software/icon-theme/) (should be propagated by every icon theme) contains [a setup hook](#ssec-gnome-hooks-hicolor-icon-theme) that will pick up icon themes from `buildInputs` and pass it to our wrapper. Unfortunately, relying on that would mean every user has to download the theme included in the package expression no matter their preference. For that reason, we leave the installation of icon theme on the user. If you use one of the desktop environments, you probably already have an icon theme installed. |
||||
|
||||
To avoid costly file system access when locating icons, GTK, [as well as Qt](https://woboq.com/blog/qicon-reads-gtk-icon-cache-in-qt57.html), can rely on `icon-theme.cache` files from the themes' top-level directories. These files are generated using `gtk-update-icon-cache`, which is expected to be run whenever an icon is added or removed to an icon theme (typically an application icon into `hicolor` theme) and some programs do indeed run this after icon installation. However, since packages are installed into their own prefix by Nix, this would lead to conflicts. For that reason, `gtk3` provides a [setup hook](#ssec-gnome-hooks-gtk-drop-icon-theme-cache) that will clean the file from installation. Since most applications only ship their own icon that will be loaded on start-up, it should not affect them too much. On the other hand, icon themes are much larger and more widely used so we need to cache them. Because we recommend installing icon themes globally, we will generate the cache files from all packages in a profile using a NixOS module. You can enable the cache generation using `gtk.iconCache.enable` option if your desktop environment does not already do that. |
||||
|
||||
### Packaging icon themes {#ssec-icon-theme-packaging} |
||||
|
||||
Icon themes may inherit from other icon themes. The inheritance is specified using the `Inherits` key in the `index.theme` file distributed with the icon theme. According to the [icon theme specification](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html), icons not provided by the theme are looked for in its parent icon themes. Therefore the parent themes should be installed as dependencies for a more complete experience regarding the icon sets used. |
||||
|
||||
The package `hicolor-icon-theme` provides a setup hook which makes symbolic links for the parent themes into the directory `share/icons` of the current theme directory in the nix store, making sure they can be found at runtime. For that to work the packages providing parent icon themes should be listed as propagated build dependencies, together with `hicolor-icon-theme`. |
||||
|
||||
Also make sure that `icon-theme.cache` is installed for each theme provided by the package, and set `dontDropIconThemeCache` to `true` so that the cache file is not removed by the `gtk3` setup hook. |
||||
|
||||
### GTK Themes {#ssec-gnome-themes} |
||||
|
||||
Previously, a GTK theme needed to be in `XDG_DATA_DIRS`. This is no longer necessary for most programs since GTK incorporated Adwaita theme. Some programs (for example, those designed for [elementary HIG](https://elementary.io/docs/human-interface-guidelines#human-interface-guidelines)) might require a special theme like `pantheon.elementary-gtk-theme`. |
||||
|
||||
### GObject introspection typelibs {#ssec-gnome-typelibs} |
||||
|
||||
[GObject introspection](https://wiki.gnome.org/Projects/GObjectIntrospection) allows applications to use C libraries in other languages easily. It does this through `typelib` files searched in `GI_TYPELIB_PATH`. |
||||
|
||||
### Various plug-ins {#ssec-gnome-plugins} |
||||
|
||||
If your application uses [GStreamer](https://gstreamer.freedesktop.org/) or [Grilo](https://wiki.gnome.org/Projects/Grilo), you should set `GST_PLUGIN_SYSTEM_PATH_1_0` and `GRL_PLUGIN_PATH`, respectively. |
||||
|
||||
## Onto `wrapGAppsHook` {#ssec-gnome-hooks} |
||||
|
||||
Given the requirements above, the package expression would become messy quickly: |
||||
|
||||
```nix |
||||
preFixup = '' |
||||
for f in $(find $out/bin/ $out/libexec/ -type f -executable); do |
||||
wrapProgram "$f" \ |
||||
--prefix GIO_EXTRA_MODULES : "${getLib dconf}/lib/gio/modules" \ |
||||
--prefix XDG_DATA_DIRS : "$out/share" \ |
||||
--prefix XDG_DATA_DIRS : "$out/share/gsettings-schemas/${name}" \ |
||||
--prefix XDG_DATA_DIRS : "${gsettings-desktop-schemas}/share/gsettings-schemas/${gsettings-desktop-schemas.name}" \ |
||||
--prefix XDG_DATA_DIRS : "${hicolor-icon-theme}/share" \ |
||||
--prefix GI_TYPELIB_PATH : "${lib.makeSearchPath "lib/girepository-1.0" [ pango json-glib ]}" |
||||
done |
||||
''; |
||||
``` |
||||
|
||||
Fortunately, there is [`wrapGAppsHook`]{#ssec-gnome-hooks-wrapgappshook}. It works in conjunction with other setup hooks that populate environment variables, and it will then wrap all executables in `bin` and `libexec` directories using said variables. |
||||
|
||||
For convenience, it also adds `dconf.lib` for a GIO module implementing a GSettings backend using `dconf`, `gtk3` for GSettings schemas, and `librsvg` for GdkPixbuf loader to the closure. There is also [`wrapGAppsHook4`]{#ssec-gnome-hooks-wrapgappshook4}, which replaces GTK 3 with GTK 4. And in case you are packaging a program without a graphical interface, you might want to use [`wrapGAppsNoGuiHook`]{#ssec-gnome-hooks-wrapgappsnoguihook}, which runs the same script as `wrapGAppsHook` but does not bring `gtk3` and `librsvg` into the closure. |
||||
|
||||
- `wrapGAppsHook` itself will add the package’s `share` directory to `XDG_DATA_DIRS`. |
||||
|
||||
- []{#ssec-gnome-hooks-glib} `glib` setup hook will populate `GSETTINGS_SCHEMAS_PATH` and then `wrapGAppsHook` will prepend it to `XDG_DATA_DIRS`. |
||||
|
||||
- []{#ssec-gnome-hooks-gdk-pixbuf} `gdk-pixbuf` setup hook will populate `GDK_PIXBUF_MODULE_FILE` with the path to biggest `loaders.cache` file from the dependencies containing [GdkPixbuf loaders](ssec-gnome-gdk-pixbuf-loaders). This works fine when there are only two packages containing loaders (`gdk-pixbuf` and e.g. `librsvg`) – it will choose the second one, reasonably expecting that it will be bigger since it describes extra loader in addition to the default ones. But when there are more than two loader packages, this logic will break. One possible solution would be constructing a custom cache file for each package containing a program like `services/x11/gdk-pixbuf.nix` NixOS module does. `wrapGAppsHook` copies the `GDK_PIXBUF_MODULE_FILE` environment variable into the produced wrapper. |
||||
|
||||
- []{#ssec-gnome-hooks-gtk-drop-icon-theme-cache} One of `gtk3`’s setup hooks will remove `icon-theme.cache` files from package’s icon theme directories to avoid conflicts. Icon theme packages should prevent this with `dontDropIconThemeCache = true;`. |
||||
|
||||
- []{#ssec-gnome-hooks-dconf} `dconf.lib` is a dependency of `wrapGAppsHook`, which then also adds it to the `GIO_EXTRA_MODULES` variable. |
||||
|
||||
- []{#ssec-gnome-hooks-hicolor-icon-theme} `hicolor-icon-theme`’s setup hook will add icon themes to `XDG_ICON_DIRS` which is prepended to `XDG_DATA_DIRS` by `wrapGAppsHook`. |
||||
|
||||
- []{#ssec-gnome-hooks-gobject-introspection} `gobject-introspection` setup hook populates `GI_TYPELIB_PATH` variable with `lib/girepository-1.0` directories of dependencies, which is then added to wrapper by `wrapGAppsHook`. It also adds `share` directories of dependencies to `XDG_DATA_DIRS`, which is intended to promote GIR files but it also [pollutes the closures](https://github.com/NixOS/nixpkgs/issues/32790) of packages using `wrapGAppsHook`. |
||||
|
||||
::: warning |
||||
The setup hook [currently](https://github.com/NixOS/nixpkgs/issues/56943) does not work in expressions with `strictDeps` enabled, like Python packages. In those cases, you will need to disable it with `strictDeps = false;`. |
||||
::: |
||||
|
||||
- []{#ssec-gnome-hooks-gst-grl-plugins} Setup hooks of `gst_all_1.gstreamer` and `grilo` will populate the `GST_PLUGIN_SYSTEM_PATH_1_0` and `GRL_PLUGIN_PATH` variables, respectively, which will then be added to the wrapper by `wrapGAppsHook`. |
||||
|
||||
You can also pass additional arguments to `makeWrapper` using `gappsWrapperArgs` in `preFixup` hook: |
||||
|
||||
```nix |
||||
preFixup = '' |
||||
gappsWrapperArgs+=( |
||||
# Thumbnailers |
||||
--prefix XDG_DATA_DIRS : "${gdk-pixbuf}/share" |
||||
--prefix XDG_DATA_DIRS : "${librsvg}/share" |
||||
--prefix XDG_DATA_DIRS : "${shared-mime-info}/share" |
||||
) |
||||
''; |
||||
``` |
||||
|
||||
## Updating GNOME packages {#ssec-gnome-updating} |
||||
|
||||
Most GNOME package offer [`updateScript`](#var-passthru-updateScript), it is therefore possible to update to latest source tarball by running `nix-shell maintainers/scripts/update.nix --argstr package gnome.nautilus` or even en masse with `nix-shell maintainers/scripts/update.nix --argstr path gnome`. Read the package’s `NEWS` file to see what changed. |
||||
|
||||
## Frequently encountered issues {#ssec-gnome-common-issues} |
||||
|
||||
#### `GLib-GIO-ERROR **: 06:04:50.903: No GSettings schemas are installed on the system` {#ssec-gnome-common-issues-no-schemas} |
||||
|
||||
There are no schemas available in `XDG_DATA_DIRS`. Temporarily add a random package containing schemas like `gsettings-desktop-schemas` to `buildInputs`. [`glib`](#ssec-gnome-hooks-glib) and [`wrapGAppsHook`](#ssec-gnome-hooks-wrapgappshook) setup hooks will take care of making the schemas available to application and you will see the actual missing schemas with the [next error](#ssec-gnome-common-issues-missing-schema). Or you can try looking through the source code for the actual schemas used. |
||||
|
||||
#### `GLib-GIO-ERROR **: 06:04:50.903: Settings schema ‘org.gnome.foo’ is not installed` {#ssec-gnome-common-issues-missing-schema} |
||||
|
||||
Package is missing some GSettings schemas. You can find out the package containing the schema with `nix-locate org.gnome.foo.gschema.xml` and let the hooks handle the wrapping as [above](#ssec-gnome-common-issues-no-schemas). |
||||
|
||||
#### When using `wrapGAppsHook` with special derivers you can end up with double wrapped binaries. {#ssec-gnome-common-issues-double-wrapped} |
||||
|
||||
This is because derivers like `python.pkgs.buildPythonApplication` or `qt5.mkDerivation` have setup-hooks automatically added that produce wrappers with makeWrapper. The simplest way to workaround that is to disable the `wrapGAppsHook` automatic wrapping with `dontWrapGApps = true;` and pass the arguments it intended to pass to makeWrapper to another. |
||||
|
||||
In the case of a Python application it could look like: |
||||
|
||||
```nix |
||||
python3.pkgs.buildPythonApplication { |
||||
pname = "gnome-music"; |
||||
version = "3.32.2"; |
||||
|
||||
nativeBuildInputs = [ |
||||
wrapGAppsHook |
||||
gobject-introspection |
||||
... |
||||
]; |
||||
|
||||
dontWrapGApps = true; |
||||
|
||||
# Arguments to be passed to `makeWrapper`, only used by buildPython* |
||||
preFixup = '' |
||||
makeWrapperArgs+=("''${gappsWrapperArgs[@]}") |
||||
''; |
||||
} |
||||
``` |
||||
|
||||
And for a QT app like: |
||||
|
||||
```nix |
||||
mkDerivation { |
||||
pname = "calibre"; |
||||
version = "3.47.0"; |
||||
|
||||
nativeBuildInputs = [ |
||||
wrapGAppsHook |
||||
qmake |
||||
... |
||||
]; |
||||
|
||||
dontWrapGApps = true; |
||||
|
||||
# Arguments to be passed to `makeWrapper`, only used by qt5’s mkDerivation |
||||
preFixup = '' |
||||
qtWrapperArgs+=("''${gappsWrapperArgs[@]}") |
||||
''; |
||||
} |
||||
``` |
||||
|
||||
#### I am packaging a project that cannot be wrapped, like a library or GNOME Shell extension. {#ssec-gnome-common-issues-unwrappable-package} |
||||
|
||||
You can rely on applications depending on the library setting the necessary environment variables but that is often easy to miss. Instead we recommend to patch the paths in the source code whenever possible. Here are some examples: |
||||
|
||||
- []{#ssec-gnome-common-issues-unwrappable-package-gnome-shell-ext} [Replacing a `GI_TYPELIB_PATH` in GNOME Shell extension](https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/gnome-3/core/gnome-shell-extensions/default.nix#L21-L24) – we are using `substituteAll` to include the path to a typelib into a patch. |
||||
|
||||
- []{#ssec-gnome-common-issues-unwrappable-package-gsettings} The following examples are hardcoding GSettings schema paths. To get the schema paths we use the functions |
||||
|
||||
* `glib.getSchemaPath` Takes a nix package attribute as an argument. |
||||
|
||||
* `glib.makeSchemaPath` Takes a package output like `$out` and a derivation name. You should use this if the schemas you need to hardcode are in the same derivation. |
||||
|
||||
[]{#ssec-gnome-common-issues-unwrappable-package-gsettings-vala} [Hard-coding GSettings schema path in Vala plug-in (dynamically loaded library)](https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86) – here, `substituteAll` cannot be used since the schema comes from the same package preventing us from pass its path to the function, probably due to a [Nix bug](https://github.com/NixOS/nix/issues/1846). |
||||
|
||||
[]{#ssec-gnome-common-issues-unwrappable-package-gsettings-c} [Hard-coding GSettings schema path in C library](https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34) – nothing special other than using [Coccinelle patch](https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467) to generate the patch itself. |
||||
|
||||
#### I need to wrap a binary outside `bin` and `libexec` directories. {#ssec-gnome-common-issues-weird-location} |
||||
|
||||
You can manually trigger the wrapping with `wrapGApp` in `preFixup` phase. It takes a path to a program as a first argument; the remaining arguments are passed directly to [`wrapProgram`](#fun-wrapProgram) function. |
||||
@ -0,0 +1,140 @@ |
||||
# Go {#sec-language-go} |
||||
|
||||
## Go modules {#ssec-language-go} |
||||
|
||||
The function `buildGoModule` builds Go programs managed with Go modules. It builds a [Go Modules](https://github.com/golang/go/wiki/Modules) through a two phase build: |
||||
|
||||
- An intermediate fetcher derivation. This derivation will be used to fetch all of the dependencies of the Go module. |
||||
- A final derivation will use the output of the intermediate derivation to build the binaries and produce the final output. |
||||
|
||||
### Example for `buildGoModule` {#ex-buildGoModule} |
||||
|
||||
In the following is an example expression using `buildGoModule`, the following arguments are of special significance to the function: |
||||
|
||||
- `vendorSha256`: is the hash of the output of the intermediate fetcher derivation. `vendorSha256` can also take `null` as an input. When `null` is used as a value, rather than fetching the dependencies and vendoring them, we use the vendoring included within the source repo. If you'd like to not have to update this field on dependency changes, run `go mod vendor` in your source repo and set `vendorSha256 = null;` |
||||
- `runVend`: runs the vend command to generate the vendor directory. This is useful if your code depends on c code and go mod tidy does not include the needed sources to build. |
||||
|
||||
```nix |
||||
pet = buildGoModule rec { |
||||
pname = "pet"; |
||||
version = "0.3.4"; |
||||
|
||||
src = fetchFromGitHub { |
||||
owner = "knqyf263"; |
||||
repo = "pet"; |
||||
rev = "v${version}"; |
||||
sha256 = "0m2fzpqxk7hrbxsgqplkg7h2p7gv6s1miymv3gvw0cz039skag0s"; |
||||
}; |
||||
|
||||
vendorSha256 = "1879j77k96684wi554rkjxydrj8g3hpp0kvxz03sd8dmwr3lh83j"; |
||||
|
||||
runVend = true; |
||||
|
||||
meta = with lib; { |
||||
description = "Simple command-line snippet manager, written in Go"; |
||||
homepage = "https://github.com/knqyf263/pet"; |
||||
license = licenses.mit; |
||||
maintainers = with maintainers; [ kalbasit ]; |
||||
platforms = platforms.linux ++ platforms.darwin; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
## `buildGoPackage` (legacy) {#ssec-go-legacy} |
||||
|
||||
The function `buildGoPackage` builds legacy Go programs, not supporting Go modules. |
||||
|
||||
### Example for `buildGoPackage` |
||||
|
||||
In the following is an example expression using buildGoPackage, the following arguments are of special significance to the function: |
||||
|
||||
- `goPackagePath` specifies the package's canonical Go import path. |
||||
- `goDeps` is where the Go dependencies of a Go program are listed as a list of package source identified by Go import path. It could be imported as a separate `deps.nix` file for readability. The dependency data structure is described below. |
||||
|
||||
```nix |
||||
deis = buildGoPackage rec { |
||||
pname = "deis"; |
||||
version = "1.13.0"; |
||||
|
||||
goPackagePath = "github.com/deis/deis"; |
||||
|
||||
src = fetchFromGitHub { |
||||
owner = "deis"; |
||||
repo = "deis"; |
||||
rev = "v${version}"; |
||||
sha256 = "1qv9lxqx7m18029lj8cw3k7jngvxs4iciwrypdy0gd2nnghc68sw"; |
||||
}; |
||||
|
||||
goDeps = ./deps.nix; |
||||
} |
||||
``` |
||||
|
||||
The `goDeps` attribute can be imported from a separate `nix` file that defines which Go libraries are needed and should be included in `GOPATH` for `buildPhase`: |
||||
|
||||
```nix |
||||
# deps.nix |
||||
[ # goDeps is a list of Go dependencies. |
||||
{ |
||||
# goPackagePath specifies Go package import path. |
||||
goPackagePath = "gopkg.in/yaml.v2"; |
||||
fetch = { |
||||
# `fetch type` that needs to be used to get package source. |
||||
# If `git` is used there should be `url`, `rev` and `sha256` defined next to it. |
||||
type = "git"; |
||||
url = "https://gopkg.in/yaml.v2"; |
||||
rev = "a83829b6f1293c91addabc89d0571c246397bbf4"; |
||||
sha256 = "1m4dsmk90sbi17571h6pld44zxz7jc4lrnl4f27dpd1l8g5xvjhh"; |
||||
}; |
||||
} |
||||
{ |
||||
goPackagePath = "github.com/docopt/docopt-go"; |
||||
fetch = { |
||||
type = "git"; |
||||
url = "https://github.com/docopt/docopt-go"; |
||||
rev = "784ddc588536785e7299f7272f39101f7faccc3f"; |
||||
sha256 = "0wwz48jl9fvl1iknvn9dqr4gfy1qs03gxaikrxxp9gry6773v3sj"; |
||||
}; |
||||
} |
||||
] |
||||
``` |
||||
|
||||
To extract dependency information from a Go package in automated way use [go2nix](https://github.com/kamilchm/go2nix). It can produce complete derivation and `goDeps` file for Go programs. |
||||
|
||||
You may use Go packages installed into the active Nix profiles by adding the following to your ~/.bashrc: |
||||
|
||||
```bash |
||||
for p in $NIX_PROFILES; do |
||||
GOPATH="$p/share/go:$GOPATH" |
||||
done |
||||
``` |
||||
|
||||
## Attributes used by the builders {#ssec-go-common-attributes} |
||||
|
||||
Both `buildGoModule` and `buildGoPackage` can be tweaked to behave slightly differently, if the following attributes are used: |
||||
|
||||
### `buildFlagsArray` and `buildFlags`: {#ex-goBuildFlags-noarray} |
||||
|
||||
These attributes set build flags supported by `go build`. We recommend using `buildFlagsArray`. The most common use case of these attributes is to make the resulting executable aware of its own version. For example: |
||||
|
||||
```nix |
||||
buildFlagsArray = [ |
||||
# Note: single quotes are not needed. |
||||
"-ldflags=-X main.Version=${version} -X main.Commit=${version}" |
||||
]; |
||||
``` |
||||
|
||||
```nix |
||||
buildFlagsArray = '' |
||||
-ldflags= |
||||
-X main.Version=${version} |
||||
-X main.Commit=${version} |
||||
''; |
||||
``` |
||||
|
||||
### `deleteVendor` {#var-go-deleteVendor} |
||||
|
||||
Removes the pre-existing vendor directory. This should only be used if the dependencies included in the vendor folder are broken or incomplete. |
||||
|
||||
### `subPackages` {#var-go-subPackages} |
||||
|
||||
Limits the builder from building child packages that have not been listed. If <varname>subPackages</varname> is not specified, all child packages will be built. |
||||
@ -0,0 +1,7 @@ |
||||
# Haskell {#haskell} |
||||
|
||||
The documentation for the Haskell infrastructure is published at |
||||
<https://haskell4nix.readthedocs.io/>. The source code for that |
||||
site lives in the `doc/` sub-directory of the |
||||
[`cabal2nix` Git repository](https://github.com/NixOS/cabal2nix) |
||||
and changes can be submitted there. |
||||
@ -0,0 +1,144 @@ |
||||
# Idris {#idris} |
||||
|
||||
## Installing Idris |
||||
|
||||
The easiest way to get a working idris version is to install the `idris` attribute: |
||||
|
||||
```ShellSesssion |
||||
$ # On NixOS |
||||
$ nix-env -i nixos.idris |
||||
$ # On non-NixOS |
||||
$ nix-env -i nixpkgs.idris |
||||
``` |
||||
|
||||
This however only provides the `prelude` and `base` libraries. To install idris with additional libraries, you can use the `idrisPackages.with-packages` function, e.g. in an overlay in `~/.config/nixpkgs/overlays/my-idris.nix`: |
||||
|
||||
```nix |
||||
self: super: { |
||||
myIdris = with self.idrisPackages; with-packages [ contrib pruviloj ]; |
||||
} |
||||
``` |
||||
|
||||
And then: |
||||
|
||||
```ShellSesssion |
||||
$ # On NixOS |
||||
$ nix-env -iA nixos.myIdris |
||||
$ # On non-NixOS |
||||
$ nix-env -iA nixpkgs.myIdris |
||||
``` |
||||
|
||||
To see all available Idris packages: |
||||
```ShellSesssion |
||||
$ # On NixOS |
||||
$ nix-env -qaPA nixos.idrisPackages |
||||
$ # On non-NixOS |
||||
$ nix-env -qaPA nixpkgs.idrisPackages |
||||
``` |
||||
|
||||
Similarly, entering a `nix-shell`: |
||||
```ShellSesssion |
||||
$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])' |
||||
``` |
||||
|
||||
## Starting Idris with library support |
||||
|
||||
To have access to these libraries in idris, call it with an argument `-p <library name>` for each library: |
||||
|
||||
```ShellSesssion |
||||
$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])' |
||||
[nix-shell:~]$ idris -p contrib -p pruviloj |
||||
``` |
||||
|
||||
A listing of all available packages the Idris binary has access to is available via `--listlibs`: |
||||
|
||||
```ShellSesssion |
||||
$ idris --listlibs |
||||
00prelude-idx.ibc |
||||
pruviloj |
||||
base |
||||
contrib |
||||
prelude |
||||
00pruviloj-idx.ibc |
||||
00base-idx.ibc |
||||
00contrib-idx.ibc |
||||
``` |
||||
|
||||
## Building an Idris project with Nix |
||||
|
||||
As an example of how a Nix expression for an Idris package can be created, here is the one for `idrisPackages.yaml`: |
||||
|
||||
```nix |
||||
{ lib |
||||
, build-idris-package |
||||
, fetchFromGitHub |
||||
, contrib |
||||
, lightyear |
||||
}: |
||||
build-idris-package { |
||||
name = "yaml"; |
||||
version = "2018-01-25"; |
||||
|
||||
# This is the .ipkg file that should be built, defaults to the package name |
||||
# In this case it should build `Yaml.ipkg` instead of `yaml.ipkg` |
||||
# This is only necessary because the yaml packages ipkg file is |
||||
# different from its package name here. |
||||
ipkgName = "Yaml"; |
||||
# Idris dependencies to provide for the build |
||||
idrisDeps = [ contrib lightyear ]; |
||||
|
||||
src = fetchFromGitHub { |
||||
owner = "Heather"; |
||||
repo = "Idris.Yaml"; |
||||
rev = "5afa51ffc839844862b8316faba3bafa15656db4"; |
||||
sha256 = "1g4pi0swmg214kndj85hj50ccmckni7piprsxfdzdfhg87s0avw7"; |
||||
}; |
||||
|
||||
meta = with lib; { |
||||
description = "Idris YAML lib"; |
||||
homepage = "https://github.com/Heather/Idris.Yaml"; |
||||
license = licenses.mit; |
||||
maintainers = [ maintainers.brainrape ]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
Assuming this file is saved as `yaml.nix`, it's buildable using |
||||
|
||||
```ShellSesssion |
||||
$ nix-build -E '(import <nixpkgs> {}).idrisPackages.callPackage ./yaml.nix {}' |
||||
``` |
||||
|
||||
Or it's possible to use |
||||
|
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
{ |
||||
yaml = idrisPackages.callPackage ./yaml.nix {}; |
||||
} |
||||
``` |
||||
|
||||
in another file (say `default.nix`) to be able to build it with |
||||
|
||||
```ShellSesssion |
||||
$ nix-build -A yaml |
||||
``` |
||||
|
||||
## Passing options to `idris` commands |
||||
|
||||
The `build-idris-package` function provides also optional input values to set additional options for the used `idris` commands. |
||||
|
||||
Specifically, you can set `idrisBuildOptions`, `idrisTestOptions`, `idrisInstallOptions` and `idrisDocOptions` to provide additional options to the `idris` command respectively when building, testing, installing and generating docs for your package. |
||||
|
||||
For example you could set |
||||
|
||||
```nix |
||||
build-idris-package { |
||||
idrisBuildOptions = [ "--log" "1" "--verbose" ] |
||||
|
||||
... |
||||
} |
||||
``` |
||||
|
||||
to require verbose output during `idris` build phase. |
||||
@ -0,0 +1,36 @@ |
||||
<chapter xmlns="http://docbook.org/ns/docbook" |
||||
xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xml:id="chap-language-support"> |
||||
<title>Languages and frameworks</title> |
||||
<para> |
||||
The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter. |
||||
</para> |
||||
<xi:include href="agda.section.xml" /> |
||||
<xi:include href="android.section.xml" /> |
||||
<xi:include href="beam.section.xml" /> |
||||
<xi:include href="bower.section.xml" /> |
||||
<xi:include href="coq.section.xml" /> |
||||
<xi:include href="crystal.section.xml" /> |
||||
<xi:include href="dhall.section.xml" /> |
||||
<xi:include href="emscripten.section.xml" /> |
||||
<xi:include href="gnome.section.xml" /> |
||||
<xi:include href="go.section.xml" /> |
||||
<xi:include href="haskell.section.xml" /> |
||||
<xi:include href="idris.section.xml" /> |
||||
<xi:include href="ios.section.xml" /> |
||||
<xi:include href="java.section.xml" /> |
||||
<xi:include href="lua.section.xml" /> |
||||
<xi:include href="maven.section.xml" /> |
||||
<xi:include href="node.section.xml" /> |
||||
<xi:include href="ocaml.section.xml" /> |
||||
<xi:include href="perl.section.xml" /> |
||||
<xi:include href="php.section.xml" /> |
||||
<xi:include href="python.section.xml" /> |
||||
<xi:include href="qt.section.xml" /> |
||||
<xi:include href="r.section.xml" /> |
||||
<xi:include href="ruby.section.xml" /> |
||||
<xi:include href="rust.section.xml" /> |
||||
<xi:include href="texlive.section.xml" /> |
||||
<xi:include href="titanium.section.xml" /> |
||||
<xi:include href="vim.section.xml" /> |
||||
</chapter> |
||||
@ -0,0 +1,224 @@ |
||||
# iOS {#ios} |
||||
|
||||
This component is basically a wrapper/workaround that makes it possible to |
||||
expose an Xcode installation as a Nix package by means of symlinking to the |
||||
relevant executables on the host system. |
||||
|
||||
Since Xcode can't be packaged with Nix, nor we can publish it as a Nix package |
||||
(because of its license) this is basically the only integration strategy |
||||
making it possible to do iOS application builds that integrate with other |
||||
components of the Nix ecosystem |
||||
|
||||
The primary objective of this project is to use the Nix expression language to |
||||
specify how iOS apps can be built from source code, and to automatically spawn |
||||
iOS simulator instances for testing. |
||||
|
||||
This component also makes it possible to use [Hydra](https://nixos.org/hydra), |
||||
the Nix-based continuous integration server to regularly build iOS apps and to |
||||
do wireless ad-hoc installations of enterprise IPAs on iOS devices through |
||||
Hydra. |
||||
|
||||
The Xcode build environment implements a number of features. |
||||
|
||||
Deploying a proxy component wrapper exposing Xcode |
||||
-------------------------------------------------- |
||||
The first use case is deploying a Nix package that provides symlinks to the Xcode |
||||
installation on the host system. This package can be used as a build input to |
||||
any build function implemented in the Nix expression language that requires |
||||
Xcode. |
||||
|
||||
```nix |
||||
let |
||||
pkgs = import <nixpkgs> {}; |
||||
|
||||
xcodeenv = import ./xcodeenv { |
||||
inherit (pkgs) stdenv; |
||||
}; |
||||
in |
||||
xcodeenv.composeXcodeWrapper { |
||||
version = "9.2"; |
||||
xcodeBaseDir = "/Applications/Xcode.app"; |
||||
} |
||||
``` |
||||
|
||||
By deploying the above expression with `nix-build` and inspecting its content |
||||
you will notice that several Xcode-related executables are exposed as a Nix |
||||
package: |
||||
|
||||
```bash |
||||
$ ls result/bin |
||||
lrwxr-xr-x 1 sander staff 94 1 jan 1970 Simulator -> /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app/Contents/MacOS/Simulator |
||||
lrwxr-xr-x 1 sander staff 17 1 jan 1970 codesign -> /usr/bin/codesign |
||||
lrwxr-xr-x 1 sander staff 17 1 jan 1970 security -> /usr/bin/security |
||||
lrwxr-xr-x 1 sander staff 21 1 jan 1970 xcode-select -> /usr/bin/xcode-select |
||||
lrwxr-xr-x 1 sander staff 61 1 jan 1970 xcodebuild -> /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild |
||||
lrwxr-xr-x 1 sander staff 14 1 jan 1970 xcrun -> /usr/bin/xcrun |
||||
``` |
||||
|
||||
Building an iOS application |
||||
--------------------------- |
||||
We can build an iOS app executable for the simulator, or an IPA/xcarchive file |
||||
for release purposes, e.g. ad-hoc, enterprise or store installations, by |
||||
executing the `xcodeenv.buildApp {}` function: |
||||
|
||||
```nix |
||||
let |
||||
pkgs = import <nixpkgs> {}; |
||||
|
||||
xcodeenv = import ./xcodeenv { |
||||
inherit (pkgs) stdenv; |
||||
}; |
||||
in |
||||
xcodeenv.buildApp { |
||||
name = "MyApp"; |
||||
src = ./myappsources; |
||||
sdkVersion = "11.2"; |
||||
|
||||
target = null; # Corresponds to the name of the app by default |
||||
configuration = null; # Release for release builds, Debug for debug builds |
||||
scheme = null; # -scheme will correspond to the app name by default |
||||
sdk = null; # null will set it to 'iphonesimulator` for simulator builds or `iphoneos` to real builds |
||||
xcodeFlags = ""; |
||||
|
||||
release = true; |
||||
certificateFile = ./mycertificate.p12; |
||||
certificatePassword = "secret"; |
||||
provisioningProfile = ./myprovisioning.profile; |
||||
signMethod = "ad-hoc"; # 'enterprise' or 'store' |
||||
generateIPA = true; |
||||
generateXCArchive = false; |
||||
|
||||
enableWirelessDistribution = true; |
||||
installURL = "/installipa.php"; |
||||
bundleId = "mycompany.myapp"; |
||||
appVersion = "1.0"; |
||||
|
||||
# Supports all xcodewrapper parameters as well |
||||
xcodeBaseDir = "/Applications/Xcode.app"; |
||||
} |
||||
``` |
||||
|
||||
The above function takes a variety of parameters: |
||||
* The `name` and `src` parameters are mandatory and specify the name of the app |
||||
and the location where the source code resides |
||||
* `sdkVersion` specifies which version of the iOS SDK to use. |
||||
|
||||
It also possile to adjust the `xcodebuild` parameters. This is only needed in |
||||
rare circumstances. In most cases the default values should suffice: |
||||
|
||||
* Specifies which `xcodebuild` target to build. By default it takes the target |
||||
that has the same name as the app. |
||||
* The `configuration` parameter can be overridden if desired. By default, it |
||||
will do a debug build for the simulator and a release build for real devices. |
||||
* The `scheme` parameter specifies which `-scheme` parameter to propagate to |
||||
`xcodebuild`. By default, it corresponds to the app name. |
||||
* The `sdk` parameter specifies which SDK to use. By default, it picks |
||||
`iphonesimulator` for simulator builds and `iphoneos` for release builds. |
||||
* The `xcodeFlags` parameter specifies arbitrary command line parameters that |
||||
should be propagated to `xcodebuild`. |
||||
|
||||
By default, builds are carried out for the iOS simulator. To do release builds |
||||
(builds for real iOS devices), you must set the `release` parameter to `true`. |
||||
In addition, you need to set the following parameters: |
||||
|
||||
* `certificateFile` refers to a P12 certificate file. |
||||
* `certificatePassword` specifies the password of the P12 certificate. |
||||
* `provisioningProfile` refers to the provision profile needed to sign the app |
||||
* `signMethod` should refer to `ad-hoc` for signing the app with an ad-hoc |
||||
certificate, `enterprise` for enterprise certificates and `app-store` for App |
||||
store certificates. |
||||
* `generateIPA` specifies that we want to produce an IPA file (this is probably |
||||
what you want) |
||||
* `generateXCArchive` specifies thet we want to produce an xcarchive file. |
||||
|
||||
When building IPA files on Hydra and when it is desired to allow iOS devices to |
||||
install IPAs by browsing to the Hydra build products page, you can enable the |
||||
`enableWirelessDistribution` parameter. |
||||
|
||||
When enabled, you need to configure the following options: |
||||
|
||||
* The `installURL` parameter refers to the URL of a PHP script that composes the |
||||
`itms-services://` URL allowing iOS devices to install the IPA file. |
||||
* `bundleId` refers to the bundle ID value of the app |
||||
* `appVersion` refers to the app's version number |
||||
|
||||
To use wireless adhoc distributions, you must also install the corresponding |
||||
PHP script on a web server (see section: 'Installing the PHP script for wireless |
||||
ad hoc installations from Hydra' for more information). |
||||
|
||||
In addition to the build parameters, you can also specify any parameters that |
||||
the `xcodeenv.composeXcodeWrapper {}` function takes. For example, the |
||||
`xcodeBaseDir` parameter can be overridden to refer to a different Xcode |
||||
version. |
||||
|
||||
Spawning simulator instances |
||||
---------------------------- |
||||
In addition to building iOS apps, we can also automatically spawn simulator |
||||
instances: |
||||
|
||||
```nix |
||||
let |
||||
pkgs = import <nixpkgs> {}; |
||||
|
||||
xcodeenv = import ./xcodeenv { |
||||
inherit (pkgs) stdenv; |
||||
}; |
||||
in |
||||
xcode.simulateApp { |
||||
name = "simulate"; |
||||
|
||||
# Supports all xcodewrapper parameters as well |
||||
xcodeBaseDir = "/Applications/Xcode.app"; |
||||
} |
||||
``` |
||||
|
||||
The above expression produces a script that starts the simulator from the |
||||
provided Xcode installation. The script can be started as follows: |
||||
|
||||
```bash |
||||
./result/bin/run-test-simulator |
||||
``` |
||||
|
||||
By default, the script will show an overview of UDID for all available simulator |
||||
instances and asks you to pick one. You can also provide a UDID as a |
||||
command-line parameter to launch an instance automatically: |
||||
|
||||
```bash |
||||
./result/bin/run-test-simulator 5C93129D-CF39-4B1A-955F-15180C3BD4B8 |
||||
``` |
||||
|
||||
You can also extend the simulator script to automatically deploy and launch an |
||||
app in the requested simulator instance: |
||||
|
||||
```nix |
||||
let |
||||
pkgs = import <nixpkgs> {}; |
||||
|
||||
xcodeenv = import ./xcodeenv { |
||||
inherit (pkgs) stdenv; |
||||
}; |
||||
in |
||||
xcode.simulateApp { |
||||
name = "simulate"; |
||||
bundleId = "mycompany.myapp"; |
||||
app = xcode.buildApp { |
||||
# ... |
||||
}; |
||||
|
||||
# Supports all xcodewrapper parameters as well |
||||
xcodeBaseDir = "/Applications/Xcode.app"; |
||||
} |
||||
``` |
||||
|
||||
By providing the result of an `xcode.buildApp {}` function and configuring the |
||||
app bundle id, the app gets deployed automatically and started. |
||||
|
||||
Troubleshooting |
||||
--------------- |
||||
In some rare cases, it may happen that after a failure, changes are not picked |
||||
up. Most likely, this is caused by a derived data cache that Xcode maintains. |
||||
To wipe it you can run: |
||||
|
||||
```bash |
||||
$ rm -rf ~/Library/Developer/Xcode/DerivedData |
||||
``` |
||||
@ -0,0 +1,91 @@ |
||||
# Java {#sec-language-java} |
||||
|
||||
Ant-based Java packages are typically built from source as follows: |
||||
|
||||
```nix |
||||
stdenv.mkDerivation { |
||||
name = "..."; |
||||
src = fetchurl { ... }; |
||||
|
||||
nativeBuildInputs = [ jdk ant ]; |
||||
|
||||
buildPhase = "ant"; |
||||
} |
||||
``` |
||||
|
||||
Note that `jdk` is an alias for the OpenJDK (self-built where available, |
||||
or pre-built via Zulu). Platforms with OpenJDK not (yet) in Nixpkgs |
||||
(`Aarch32`, `Aarch64`) point to the (unfree) `oraclejdk`. |
||||
|
||||
JAR files that are intended to be used by other packages should be |
||||
installed in `$out/share/java`. JDKs have a stdenv setup hook that add |
||||
any JARs in the `share/java` directories of the build inputs to the |
||||
`CLASSPATH` environment variable. For instance, if the package `libfoo` |
||||
installs a JAR named `foo.jar` in its `share/java` directory, and |
||||
another package declares the attribute |
||||
|
||||
```nix |
||||
buildInputs = [ libfoo ]; |
||||
nativeBuildInputs = [ jdk ]; |
||||
``` |
||||
|
||||
then `CLASSPATH` will be set to |
||||
`/nix/store/...-libfoo/share/java/foo.jar`. |
||||
|
||||
Private JARs should be installed in a location like |
||||
`$out/share/package-name`. |
||||
|
||||
If your Java package provides a program, you need to generate a wrapper |
||||
script to run it using a JRE. You can use `makeWrapper` for this: |
||||
|
||||
```nix |
||||
nativeBuildInputs = [ makeWrapper ]; |
||||
|
||||
installPhase = '' |
||||
mkdir -p $out/bin |
||||
makeWrapper ${jre}/bin/java $out/bin/foo \ |
||||
--add-flags "-cp $out/share/java/foo.jar org.foo.Main" |
||||
''; |
||||
``` |
||||
|
||||
Since the introduction of the Java Platform Module System in Java 9, |
||||
Java distributions typically no longer ship with a general-purpose JRE: |
||||
instead, they allow generating a JRE with only the modules required for |
||||
your application(s). Because we can't predict what modules will be |
||||
needed on a general-purpose system, the default jre package is the full |
||||
JDK. When building a minimal system/image, you can override the |
||||
`modules` parameter on `jre_minimal` to build a JRE with only the |
||||
modules relevant for you: |
||||
|
||||
```nix |
||||
let |
||||
my_jre = pkgs.jre_minimal.override { |
||||
modules = [ |
||||
# The modules used by 'something' and 'other' combined: |
||||
"java.base" |
||||
"java.logging" |
||||
]; |
||||
}; |
||||
something = (pkgs.something.override { jre = my_jre; }); |
||||
other = (pkgs.other.override { jre = my_jre; }); |
||||
in |
||||
... |
||||
``` |
||||
|
||||
Note all JDKs passthru `home`, so if your application requires |
||||
environment variables like `JAVA_HOME` being set, that can be done in a |
||||
generic fashion with the `--set` argument of `makeWrapper`: |
||||
|
||||
```bash |
||||
--set JAVA_HOME ${jdk.home} |
||||
``` |
||||
|
||||
It is possible to use a different Java compiler than `javac` from the |
||||
OpenJDK. For instance, to use the GNU Java Compiler: |
||||
|
||||
```nix |
||||
nativeBuildInputs = [ gcj ant ]; |
||||
``` |
||||
|
||||
Here, Ant will automatically use `gij` (the GNU Java Runtime) instead of |
||||
the OpenJRE. |
||||
@ -0,0 +1,245 @@ |
||||
# User's Guide to Lua Infrastructure {#users-guide-to-lua-infrastructure} |
||||
|
||||
## Using Lua |
||||
|
||||
### Overview of Lua |
||||
|
||||
Several versions of the Lua interpreter are available: luajit, lua 5.1, 5.2, 5.3. |
||||
The attribute `lua` refers to the default interpreter, it is also possible to refer to specific versions, e.g. `lua5_2` refers to Lua 5.2. |
||||
|
||||
Lua libraries are in separate sets, with one set per interpreter version. |
||||
|
||||
The interpreters have several common attributes. One of these attributes is |
||||
`pkgs`, which is a package set of Lua libraries for this specific |
||||
interpreter. E.g., the `busted` package corresponding to the default interpreter |
||||
is `lua.pkgs.busted`, and the lua 5.2 version is `lua5_2.pkgs.busted`. |
||||
The main package set contains aliases to these package sets, e.g. |
||||
`luaPackages` refers to `lua5_1.pkgs` and `lua52Packages` to |
||||
`lua5_2.pkgs`. |
||||
|
||||
### Installing Lua and packages |
||||
|
||||
#### Lua environment defined in separate `.nix` file |
||||
|
||||
Create a file, e.g. `build.nix`, with the following expression |
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
lua5_2.withPackages (ps: with ps; [ busted luafilesystem ]) |
||||
``` |
||||
and install it in your profile with |
||||
```shell |
||||
nix-env -if build.nix |
||||
``` |
||||
Now you can use the Lua interpreter, as well as the extra packages (`busted`, |
||||
`luafilesystem`) that you added to the environment. |
||||
|
||||
#### Lua environment defined in `~/.config/nixpkgs/config.nix` |
||||
|
||||
If you prefer to, you could also add the environment as a package override to the Nixpkgs set, e.g. |
||||
using `config.nix`, |
||||
```nix |
||||
{ # ... |
||||
|
||||
packageOverrides = pkgs: with pkgs; { |
||||
myLuaEnv = lua5_2.withPackages (ps: with ps; [ busted luafilesystem ]); |
||||
}; |
||||
} |
||||
``` |
||||
and install it in your profile with |
||||
```shell |
||||
nix-env -iA nixpkgs.myLuaEnv |
||||
``` |
||||
The environment is installed by referring to the attribute, and considering |
||||
the `nixpkgs` channel was used. |
||||
|
||||
#### Lua environment defined in `/etc/nixos/configuration.nix` |
||||
|
||||
For the sake of completeness, here's another example how to install the environment system-wide. |
||||
|
||||
```nix |
||||
{ # ... |
||||
|
||||
environment.systemPackages = with pkgs; [ |
||||
(lua.withPackages(ps: with ps; [ busted luafilesystem ])) |
||||
]; |
||||
} |
||||
``` |
||||
|
||||
### How to override a Lua package using overlays? |
||||
|
||||
Use the following overlay template: |
||||
|
||||
```nix |
||||
final: prev: |
||||
{ |
||||
|
||||
lua = prev.lua.override { |
||||
packageOverrides = luaself: luaprev: { |
||||
|
||||
luarocks-nix = luaprev.luarocks-nix.overrideAttrs(oa: { |
||||
pname = "luarocks-nix"; |
||||
src = /home/my_luarocks/repository; |
||||
}); |
||||
}; |
||||
|
||||
luaPackages = lua.pkgs; |
||||
} |
||||
``` |
||||
|
||||
### Temporary Lua environment with `nix-shell` |
||||
|
||||
|
||||
There are two methods for loading a shell with Lua packages. The first and recommended method |
||||
is to create an environment with `lua.buildEnv` or `lua.withPackages` and load that. E.g. |
||||
```sh |
||||
$ nix-shell -p 'lua.withPackages(ps: with ps; [ busted luafilesystem ])' |
||||
``` |
||||
opens a shell from which you can launch the interpreter |
||||
```sh |
||||
[nix-shell:~] lua |
||||
``` |
||||
The other method, which is not recommended, does not create an environment and requires you to list the packages directly, |
||||
|
||||
```sh |
||||
$ nix-shell -p lua.pkgs.busted lua.pkgs.luafilesystem |
||||
``` |
||||
Again, it is possible to launch the interpreter from the shell. |
||||
The Lua interpreter has the attribute `pkgs` which contains all Lua libraries for that specific interpreter. |
||||
|
||||
|
||||
## Developing with Lua |
||||
|
||||
Now that you know how to get a working Lua environment with Nix, it is time |
||||
to go forward and start actually developing with Lua. There are two ways to |
||||
package lua software, either it is on luarocks and most of it can be taken care |
||||
of by the luarocks2nix converter or the packaging has to be done manually. |
||||
Let's present the luarocks way first and the manual one in a second time. |
||||
|
||||
### Packaging a library on luarocks |
||||
|
||||
[Luarocks.org](www.luarocks.org) is the main repository of lua packages. |
||||
The site proposes two types of packages, the rockspec and the src.rock |
||||
(equivalent of a [rockspec](https://github.com/luarocks/luarocks/wiki/Rockspec-format) but with the source). |
||||
These packages can have different build types such as `cmake`, `builtin` etc . |
||||
|
||||
Luarocks-based packages are generated in pkgs/development/lua-modules/generated-packages.nix from |
||||
the whitelist maintainers/scripts/luarocks-packages.csv and updated by running maintainers/scripts/update-luarocks-packages. |
||||
|
||||
[luarocks2nix](https://github.com/nix-community/luarocks) is a tool capable of generating nix derivations from both rockspec and src.rock (and favors the src.rock). |
||||
The automation only goes so far though and some packages need to be customized. |
||||
These customizations go in `pkgs/development/lua-modules/overrides.nix`. |
||||
For instance if the rockspec defines `external_dependencies`, these need to be manually added in its rockspec file then it won't work. |
||||
|
||||
You can try converting luarocks packages to nix packages with the command `nix-shell -p luarocks-nix` and then `luarocks nix PKG_NAME`. |
||||
Nix rely on luarocks to install lua packages, basically it runs: |
||||
`luarocks make --deps-mode=none --tree $out` |
||||
|
||||
#### Packaging a library manually |
||||
|
||||
You can develop your package as you usually would, just don't forget to wrap it |
||||
within a `toLuaModule` call, for instance |
||||
```nix |
||||
mynewlib = toLuaModule ( stdenv.mkDerivation { ... }); |
||||
``` |
||||
|
||||
There is also the `buildLuaPackage` function that can be used when lua modules |
||||
are not packaged for luarocks. You can see a few examples at `pkgs/top-level/lua-packages.nix`. |
||||
|
||||
## Lua Reference |
||||
|
||||
### Lua interpreters |
||||
|
||||
Versions 5.1, 5.2 and 5.3 of the lua interpreter are available as |
||||
respectively `lua5_1`, `lua5_2` and `lua5_3`. Luajit is available too. |
||||
The Nix expressions for the interpreters can be found in `pkgs/development/interpreters/lua-5`. |
||||
|
||||
|
||||
#### Attributes on lua interpreters packages |
||||
|
||||
Each interpreter has the following attributes: |
||||
|
||||
- `interpreter`. Alias for `${pkgs.lua}/bin/lua`. |
||||
- `buildEnv`. Function to build lua interpreter environments with extra packages bundled together. See section *lua.buildEnv function* for usage and documentation. |
||||
- `withPackages`. Simpler interface to `buildEnv`. |
||||
- `pkgs`. Set of Lua packages for that specific interpreter. The package set can be modified by overriding the interpreter and passing `packageOverrides`. |
||||
|
||||
|
||||
#### `buildLuarocksPackage` function |
||||
|
||||
The `buildLuarocksPackage` function is implemented in `pkgs/development/interpreters/lua-5/build-lua-package.nix` |
||||
The following is an example: |
||||
```nix |
||||
luaposix = buildLuarocksPackage { |
||||
pname = "luaposix"; |
||||
version = "34.0.4-1"; |
||||
|
||||
src = fetchurl { |
||||
url = "https://raw.githubusercontent.com/rocks-moonscript-org/moonrocks-mirror/master/luaposix-34.0.4-1.src.rock"; |
||||
sha256 = "0yrm5cn2iyd0zjd4liyj27srphvy0gjrjx572swar6zqr4dwjqp2"; |
||||
}; |
||||
disabled = (luaOlder "5.1") || (luaAtLeast "5.4"); |
||||
propagatedBuildInputs = [ bit32 lua std_normalize ]; |
||||
|
||||
meta = with lib; { |
||||
homepage = "https://github.com/luaposix/luaposix/"; |
||||
description = "Lua bindings for POSIX"; |
||||
maintainers = with maintainers; [ vyp lblasc ]; |
||||
license.fullName = "MIT/X11"; |
||||
}; |
||||
}; |
||||
``` |
||||
|
||||
The `buildLuarocksPackage` delegates most tasks to luarocks: |
||||
|
||||
* it adds `luarocks` as an unpacker for `src.rock` files (zip files really). |
||||
* configurePhase` writes a temporary luarocks configuration file which location |
||||
is exported via the environment variable `LUAROCKS_CONFIG`. |
||||
* the `buildPhase` does nothing. |
||||
* `installPhase` calls `luarocks make --deps-mode=none --tree $out` to build and |
||||
install the package |
||||
* In the `postFixup` phase, the `wrapLuaPrograms` bash function is called to |
||||
wrap all programs in the `$out/bin/*` directory to include `$PATH` |
||||
environment variable and add dependent libraries to script's `LUA_PATH` and |
||||
`LUA_CPATH`. |
||||
|
||||
By default `meta.platforms` is set to the same value as the interpreter unless overridden otherwise. |
||||
|
||||
#### `buildLuaApplication` function |
||||
|
||||
The `buildLuaApplication` function is practically the same as `buildLuaPackage`. |
||||
The difference is that `buildLuaPackage` by default prefixes the names of the packages with the version of the interpreter. |
||||
Because with an application we're not interested in multiple version the prefix is dropped. |
||||
|
||||
#### lua.withPackages function |
||||
|
||||
The `lua.withPackages` takes a function as an argument that is passed the set of lua packages and returns the list of packages to be included in the environment. |
||||
Using the `withPackages` function, the previous example for the luafilesystem environment can be written like this: |
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
lua.withPackages (ps: [ps.luafilesystem]) |
||||
``` |
||||
|
||||
`withPackages` passes the correct package set for the specific interpreter version as an argument to the function. In the above example, `ps` equals `luaPackages`. |
||||
But you can also easily switch to using `lua5_2`: |
||||
```nix |
||||
with import <nixpkgs> {}; |
||||
|
||||
lua5_2.withPackages (ps: [ps.lua]) |
||||
``` |
||||
|
||||
Now, `ps` is set to `lua52Packages`, matching the version of the interpreter. |
||||
|
||||
|
||||
### Possible Todos |
||||
|
||||
* export/use version specific variables such as `LUA_PATH_5_2`/`LUAROCKS_CONFIG_5_2` |
||||
* let luarocks check for dependencies via exporting the different rocktrees in temporary config |
||||
|
||||
### Lua Contributing guidelines |
||||
|
||||
Following rules should be respected: |
||||
|
||||
* Make sure libraries build for all Lua interpreters. |
||||
* Commit names of Lua libraries should reflect that they are Lua libraries, so write for example `luaPackages.luafilesystem: 1.11 -> 1.12`. |
||||
@ -0,0 +1,51 @@ |
||||
# Node.js {#node.js} |
||||
|
||||
The `pkgs/development/node-packages` folder contains a generated collection of |
||||
[NPM packages](https://npmjs.com/) that can be installed with the Nix package |
||||
manager. |
||||
|
||||
As a rule of thumb, the package set should only provide *end user* software |
||||
packages, such as command-line utilities. Libraries should only be added to the |
||||
package set if there is a non-NPM package that requires it. |
||||
|
||||
When it is desired to use NPM libraries in a development project, use the |
||||
`node2nix` generator directly on the `package.json` configuration file of the |
||||
project. |
||||
|
||||
The package set provides support for the official stable Node.js versions. |
||||
The latest stable LTS release in `nodePackages`, as well as the latest stable |
||||
Current release in `nodePackages_latest`. |
||||
|
||||
If your package uses native addons, you need to examine what kind of native |
||||
build system it uses. Here are some examples: |
||||
|
||||
* `node-gyp` |
||||
* `node-gyp-builder` |
||||
* `node-pre-gyp` |
||||
|
||||
After you have identified the correct system, you need to override your package |
||||
expression while adding in build system as a build input. For example, `dat` |
||||
requires `node-gyp-build`, so [we override](https://github.com/NixOS/nixpkgs/blob/32f5e5da4a1b3f0595527f5195ac3a91451e9b56/pkgs/development/node-packages/default.nix#L37-L40) its expression in [`default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/node-packages/default.nix): |
||||
|
||||
```nix |
||||
dat = super.dat.override { |
||||
buildInputs = [ self.node-gyp-build pkgs.libtool pkgs.autoconf pkgs.automake ]; |
||||
meta.broken = since "12"; |
||||
}; |
||||
``` |
||||
|
||||
To add a package from NPM to nixpkgs: |
||||
|
||||
1. Modify `pkgs/development/node-packages/node-packages.json` to add, update |
||||
or remove package entries to have it included in `nodePackages` and |
||||
`nodePackages_latest`. |
||||
2. Run the script: `(cd pkgs/development/node-packages && ./generate.sh)`. |
||||
3. Build your new package to test your changes: |
||||
`cd /path/to/nixpkgs && nix-build -A nodePackages.<new-or-updated-package>`. |
||||
To build against the latest stable Current Node.js version (e.g. 14.x): |
||||
`nix-build -A nodePackages_latest.<new-or-updated-package>` |
||||
4. Add and commit all modified and generated files. |
||||
|
||||
For more information about the generation process, consult the |
||||
[README.md](https://github.com/svanderburg/node2nix) file of the `node2nix` |
||||
tool. |
||||
@ -0,0 +1,70 @@ |
||||
# OCaml {#sec-language-ocaml} |
||||
|
||||
OCaml libraries should be installed in `$(out)/lib/ocaml/${ocaml.version}/site-lib/`. Such directories are automatically added to the `$OCAMLPATH` environment variable when building another package that depends on them or when opening a `nix-shell`. |
||||
|
||||
Given that most of the OCaml ecosystem is now built with dune, nixpkgs includes a convenience build support function called `buildDunePackage` that will build an OCaml package using dune, OCaml and findlib and any additional dependencies provided as `buildInputs` or `propagatedBuildInputs`. |
||||
|
||||
Here is a simple package example. It defines an (optional) attribute `minimumOCamlVersion` that will be used to throw a descriptive evaluation error if building with an older OCaml is attempted. It uses the `fetchFromGitHub` fetcher to get its source. It sets the `doCheck` (optional) attribute to `true` which means that tests will be run with `dune runtest -p angstrom` after the build (`dune build -p angstrom`) is complete. It uses `alcotest` as a build input (because it is needed to run the tests) and `bigstringaf` and `result` as propagated build inputs (thus they will also be available to libraries depending on this library). The library will be installed using the `angstrom.install` file that dune generates. |
||||
|
||||
```nix |
||||
{ lib |
||||
, fetchFromGitHub |
||||
, buildDunePackage |
||||
, alcotest |
||||
, result |
||||
, bigstringaf |
||||
}: |
||||
|
||||
buildDunePackage rec { |
||||
pname = "angstrom"; |
||||
version = "0.10.0"; |
||||
|
||||
minimumOCamlVersion = "4.03"; |
||||
|
||||
src = fetchFromGitHub { |
||||
owner = "inhabitedtype"; |
||||
repo = pname; |
||||
rev = version; |
||||
sha256 = "0lh6024yf9ds0nh9i93r9m6p5psi8nvrqxl5x7jwl13zb0r9xfpw"; |
||||
}; |
||||
|
||||
buildInputs = [ alcotest ]; |
||||
propagatedBuildInputs = [ bigstringaf result ]; |
||||
doCheck = true; |
||||
|
||||
meta = with lib; { |
||||
homepage = "https://github.com/inhabitedtype/angstrom"; |
||||
description = "OCaml parser combinators built for speed and memory efficiency"; |
||||
license = licenses.bsd3; |
||||
maintainers = with maintainers; [ sternenseemann ]; |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
Here is a second example, this time using a source archive generated with `dune-release`. It is a good idea to use this archive when it is available as it will usually contain substituted variables such as a `%%VERSION%%` field. This library does not depend on any other OCaml library and no tests are run after building it. |
||||
|
||||
```nix |
||||
{ lib |
||||
, fetchurl |
||||
, buildDunePackage |
||||
}: |
||||
|
||||
buildDunePackage rec { |
||||
pname = "wtf8"; |
||||
version = "1.0.1"; |
||||
|
||||
minimumOCamlVersion = "4.01"; |
||||
|
||||
src = fetchurl { |
||||
url = "https://github.com/flowtype/ocaml-${pname}/releases/download/v${version}/${pname}-${version}.tbz"; |
||||
sha256 = "1msg3vycd3k8qqj61sc23qks541cxpb97vrnrvrhjnqxsqnh6ygq"; |
||||
}; |
||||
|
||||
meta = with lib; { |
||||
homepage = "https://github.com/flowtype/ocaml-wtf8"; |
||||
description = "WTF-8 is a superset of UTF-8 that allows unpaired surrogates."; |
||||
license = licenses.mit; |
||||
maintainers = [ maintainers.eqyiel ]; |
||||
}; |
||||
} |
||||
``` |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue