Commit graph

1770 commits

Author SHA1 Message Date
Sebastián Mancilla 8f94a33b38 treewide: ensure pre/post phase hooks are strings
Some derivations use lib.optional or lib.optionals when setting pre/post
phase hooks. Ensure the proper lib.optionalString is used.
2021-08-20 19:08:42 -04:00
figsoda 4b93f966c5 doc: stdenv: document meta.mainProgram 2021-08-19 14:00:04 -04:00
github-actions[bot] ef802e744e
Merge staging-next into staging 2021-08-17 18:01:53 +00:00
Ben Siraphob 6b7decf64b
Merge pull request #134413 from Zimmi48/package-hydra-battles 2021-08-17 08:32:21 -05:00
Théo Zimmermann 90654cce7d
coqPackages.mkCoqDerivation: fix useDune2
- Reuse build phase from the `buildDunePackage` function.
- Only install the package that was just built (useful for monorepo support).
- Introduces `opam-name` to override the default package name to build with Dune.
2021-08-17 14:38:47 +02:00
Jörg Thalheim f251e39c45
Merge pull request #128134 from xaverdh/linux-package-set
move linux packages out of all-packages
2021-08-15 08:14:35 +01:00
Arnout Engelen d09e0be1c4
nixpkgs-docs: when to prefer passthru.tests over installCheckPhase
And mention you can have either lightweight 'package' or
more heavyweight 'NixOS' (module) tests.

This was suggested at
https://github.com/ryantm/nixpkgs-update/issues/260#issuecomment-821287971
and discussed further at
https://github.com/NixOS/nixpkgs/pull/119731
2021-08-14 09:47:21 +02:00
Dominik Xaver Hörl b4e9cd8596 docs: adjust to the new structure of kernel packages 2021-08-12 12:22:05 +02:00
Matthieu Coudron fa1dedee47 doc: updated lua doc
mentions lua 5.4 + fixed an error
2021-08-09 21:37:58 +02:00
Matthieu Coudron 560a4e4e08 update-luarocks-packages: use pluginupdate.py
Trying to reuse the update scripts used by kakoune/vim to provide the
user with an unified convergence. Some stuff doesn't work yet (parallel
download, caching) but I (anyone else welcome to try too) will improve
it in other PRs.
2021-08-09 21:37:56 +02:00
Doron Behar d74960e8db
Merge pull request #105494 from alunduil/missing-operator-mapAttr-doc 2021-08-07 17:14:41 +00:00
zowoq a4461b97c6 buildGoModule: add proxyVendor 2021-08-06 09:10:09 +10:00
zowoq b60dde0c1e buildGo{Module,Package}: add tags argument
Simpler method of setting tags rather than using some combination of buildFlags, buildFlagsArray, preBuild, etc

Using `lib.concatStringsSep ","` as space separated tags are deprecated in go.
2021-08-06 09:09:58 +10:00
Kid 8d65161801
doc: remove unnecessary parentheses 2021-08-05 21:57:20 +08:00
adisbladis f09a770d9c
Merge pull request #130021 from neosimsim/fix-emacs-override-examples
emacs: fix overrideScope' examples
2021-08-04 03:08:33 -05:00
Jörg Thalheim 5f31fe07cc
Merge pull request #132351 from figsoda/rust-doc
doc: rust: improve documentation on cargoLock.lockFile
2021-08-02 21:23:09 +01:00
davidak 2859cc8aa0
Merge pull request #130207 from hercules-ci/passthru-sensible-timeout
doc/coding-conventions: Increase passthru test timeout 3s -> 60s
2021-08-02 07:43:02 +02:00
figsoda a3925908e4 doc: rust: improve documentation on cargoLock.lockFile 2021-08-01 17:01:13 -04:00
Alyssa Ross fc11b5eaa4
doc: rust: add missing semicolon 2021-07-30 08:37:25 +00:00
Ryan Mulligan 9e55528940
Merge pull request #126001 from est31/master
Add the -a param to the docs
2021-07-28 12:00:47 -07:00
Niklas Hambüchen fe5f3f65e2 manuals: Describe how to link NixOS tests from packages 2021-07-27 17:39:33 +02:00
Martin Weinelt 12e2b98017
Merge branch 'master' into staging-next 2021-07-19 23:16:25 +02:00
Guillaume Girol 23462c6941
Merge pull request #130206 from symphorien/treesitter-doc
vimPlugins.nvim-treesitter: document plugins
2021-07-19 19:07:37 +00:00
Guillaume Girol f620722174 vimPlugins.nvim-treesitter: document plugins 2021-07-18 14:40:49 +02:00
github-actions[bot] fa7a791586
Merge master into staging-next 2021-07-16 00:01:36 +00:00
Robert Hensing 840fd0a4f8 doc/coding-conventions: Increase passthru test timeout 3s -> 60s
3s is too small a margin for a loaded slow system to start a bloated
program.
This leads to problems when tests are written on decent dev hardware
but later run on build farms of potentially slower hardware,
particularly in the case of non x86.

The chance of needing the timeout is actually very small, so those
rare 57s are a reasonable price to pay for fewer timeouts on build
farms, each of which should be investigated and usually fixed by
increasing the timeout.
2021-07-14 19:03:58 +02:00
Jan Tojnar da95ab11b4 doc: Add helper for converting DocBook files to Markdown 2021-07-13 02:21:22 +02:00
Jan Tojnar 04b59b0328 doc: Linkify man page references 2021-07-13 02:21:22 +02:00
Jan Tojnar c9139dfa1a doc: Add support for MyST roles
Officially, only the manpage role is supported at the moment.

Unlike in rST, the syntax uses braces instead of colons:

    {manpage}`nix.conf(5)`
2021-07-13 02:10:57 +02:00
Jan Tojnar df55fbb62a doc: comment lua scripts 2021-07-12 22:57:29 +02:00
Jan Tojnar a49d36b979 doc: Move lua filters to subdirectory 2021-07-12 22:57:28 +02:00
Alexander Ben Nasrallah c81250a1d3 emacs: fix overrideScope' examples 2021-07-12 16:48:10 +02:00
Mauricio Scheffer a7784fe00a buildFHSUserEnv: document profile parameter 2021-07-11 18:12:19 +01:00
Dmitry Kalinkin 280e629ee0
Merge branch 'master' into staging-next 2021-07-08 04:38:15 -04:00
slotThe 2c529c3cb8 Link to Libera, Matrix instead of Freenode
The project has moved away from Freenode as an IRC network[1], and there
is now a quite large channel on Libera.  As such, we should point users
towards that instead.

This also changes all examples to refer to libera instead of freenode
as, with the recent deletion of all freenode channels, it is perhaps
where most communities are to be found nowadays.

Finally, also link to the official Matrix room[2] as an alternative to
IRC.

Related: https://github.com/NixOS/nixpkgs/pull/129384

[1]: https://discourse.nixos.org/t/join-us-on-matrix-at-nix-nixos-org-migrating-from-freenode
[2]: https://github.com/NixOS/rfcs/pull/94
2021-07-06 16:35:37 +02:00
github-actions[bot] 3ddb8d5a79
Merge staging-next into staging 2021-07-06 00:02:03 +00:00
Niklas Hambüchen 7cfaba911d manual: Hardening: Remove now-nonexistent ArchWiki link.
The page has been replaced by the much more general page
https://wiki.archlinux.org/title/Security#Packages
which is barely talking about hardening flags any more.
2021-07-05 22:57:52 +02:00
Robert Schütz a2c9f04849 fixup! python3: 3.8 -> 3.9 2021-07-05 12:34:02 -07:00
Frederik Rietdijk 94cd70bae2 python3: 3.8 -> 3.9 2021-07-05 12:34:02 -07:00
Niklas Hambüchen ac36a0f9eb manual: hardening: Fix disabled flags prose being in previous section
This confused the hell out of me, as I didn't spot the

> The following flags are disabled by default ...

when reading about `pie`, because that sentence was hidden in the
previous hardening flag's section.

Also explain that `pie` hardening is on by default on musl.
2021-07-05 16:32:55 +02:00
Robert Schütz 1ec5651913 treewide: use pythonPackages.python-dateutil instead of pythonPackages.dateutil 2021-07-03 13:45:57 +02:00
Mario Rodas 39916f933e beam: update reference to nodejs package
nodejs-15_x has reached EOL, and removed from nixpkgs.
2021-07-01 04:20:00 +00:00
Chris Martin 023489f623 docs: update Steam instructions to use steam-run-native package
pkgs.steam-run-native is defined as exactly the expression that
these instructions tell you to write, so the instruction is no
longer necessary since we can just tell you to use that.
2021-07-01 02:43:10 -06:00
Luke Granger-Brown e8d4f67e8a
Merge pull request #128123 from Mazurel/master
hy: 0.19.0 -> 1.0a1 and improvements
2021-06-30 23:03:13 +01:00
Robert Hensing 4c4c00e9f1
Merge pull request #124875 from hercules-ci/lib-sources
lib.sources: docs, tests, refactoring
2021-06-28 14:02:37 +02:00
Mazurel 30a15dbc5e hy: 0.19.0 -> 1.0a1 and improvements 2021-06-27 12:34:28 +02:00
Domen Kožar 6556d64f45
Merge pull request #128163 from nh2/github-actions-backport-link-to-criteria
Make backport bot link to criteria, make `CONTRIBUTING.md` more prominent
2021-06-26 17:36:14 +02:00
Niklas Hambüchen 3c29ced243 CONTRIBUTING.md: Move to repo root, where it is more visible.
We found that many users found it difficult to locate this document.

Github supports it in the root, see:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
2021-06-26 04:51:38 +02:00
Martin Weinelt b607aadaac
Merge branch 'master' into staging-next 2021-06-22 23:55:21 +02:00
Graham Fawcett d26902aef9
Refresh the Ocaml package examples; document useDune2 (#127520)
The current example in the manual no longer builds, mainly because
`useDune2 = true` is required, but also because the inputs have changed.
The new examples are copied verbatim from nixpkgs.
2021-06-22 18:53:27 +02:00
rnhmjoj ad5deab11a
doc/functions/generators: fix code block
Small fixup of 606bf6d.
2021-06-22 14:03:36 +02:00
github-actions[bot] dd892e7e2f
Merge master into staging-next 2021-06-18 12:04:55 +00:00
Jan Tojnar f07dcbef64
nixos/doc: Synchronize the Markdown generator with Nixpkgs
Switch to CommonMark with our extensions.
2021-06-18 00:07:00 +02:00
github-actions[bot] 8b9fa8d446
Merge staging-next into staging 2021-06-16 18:04:48 +00:00
Jan Tojnar 8d7b497e7f
Merge pull request #126591 from jtojnar/glib-networking-doc
doc/gnome: document GIO modules
2021-06-16 17:06:25 +02:00
github-actions[bot] de8250217d
Merge staging-next into staging 2021-06-13 00:10:27 +00:00
Ryan Mulligan 740d9fe090
Merge pull request #125671 from SFrijters/doc-improve-make-clean
doc: Clean up generated media directory
2021-06-12 16:51:03 -07:00
Alyssa Ross b0b5ef7286 stdenv: introduce dontAddStaticConfigureFlags
With removeUnknownConfigureFlags, it's impossible to express a package
that needs --enable-static, but will not accept --disable-shared,
without overriding the result of removeUnknownConfigureFlags _again_
in pkgs/top-level/static.nix.

It would be much better (and more in line with the rest of Nixpkgs) if
we encoded changes needed for static builds in package definitions
themselves, rather than in an ever-expanding list in static.nix.  This
is especially true when doing it in static.nix is going to require
multiple overrides to express what could be expressed with stdenv
options.

So as a step in that direction, and to fix the problem described
above, here I replace removeUnknownConfigureFlags with a new stdenv
option, dontAddStaticConfigureFlags.  With this mechanism, a package
that needs one but not both of the flags just needs to set
dontAddStaticConfigureFlags and then set up configureFlags manually
based on stdenv.hostPlatform.isStatic.
2021-06-11 14:16:05 -07:00
Ryan Mulligan 606bf6dc17 doc/functions/generators: convert to CommonMark 2021-06-11 06:06:42 -07:00
Jan Tojnar 653bd18d51
doc/gnome: document GIO modules
In particular, that glib-networking is required for TLS support.
2021-06-11 14:04:06 +02:00
Vladimír Čunát 2ee781417e
nixos/*: replace alsa* aliases
The attributes got renamed in PR #126440 and in some places this caused
evaluation errors, e.g. the tarball job was saying (locally)
> attribute 'alsaUtils' missing, at /build/source/nixos/modules/services/audio/alsa.nix:6:4
and I suspect that trunk-combined jobset's failure to evaluate was also caused.
2021-06-10 09:46:55 +02:00
Jonathan Ringer 0a6008f4e5 doc/manual: Add backport criteria 2021-06-09 00:13:49 -07:00
Ryan Mulligan c682532fce doc/functions/prefer-remote-fetch: convert to CommonMark 2021-06-07 20:18:39 -07:00
Ryan Mulligan e560790890
Merge pull request #125957 from ryantm/md-debug
doc/functions/debug: convert to CommonMark
2021-06-07 19:57:22 -07:00
Ryan Mulligan fbfdc8fc0b doc/functions/debug: convert to CommonMark 2021-06-07 19:56:38 -07:00
Ryan Mulligan 2f92034d30
Merge pull request #125838 from jtojnar/strict-commonmark
doc: Parse as CommonMark
2021-06-07 06:02:29 -07:00
Jan Tojnar 3c78ad2561
doc: Use markdown syntax for xrefs
Syntax is taken from MyST:

https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07 06:34:59 +02:00
Jan Tojnar adecb00f5a
doc: Build as CommonMark
We were using Pandoc’s Markdown parser. This is non-standard and might cause issues when we finally switch to some other tool.

Since RFC 0072 agreed on CommonMark, let’s switch to that.

We will use some extensions to make the limited syntax bearable but these are official so they should be more portable.
2021-06-07 06:34:59 +02:00
Jan Tojnar 6ecc641d08
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly.

Notably:
- Line breaks in lists behave differently.
- Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75
- The auto_identifiers uses a different algorithm – I made the previous ones explicit.
- Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist

While at it, I also fixed the following issues:
- ShellSesssion was used
- Removed some pointless docbook tags.
2021-06-07 06:34:59 +02:00
est31 49bd30eb33 Add the -a param to the docs
The patch utility does not understand git formatted patches.
For text files, there is no problem, but binary files use the
git format.

The -a param makes git diff put binary files into the patch in
raw format that can be understood by the patch tool.
2021-06-06 21:45:57 +02:00
Jan Tojnar ce6b1a4f8f
doc: Document markup syntax
Not depicted:

- Diagrams using Lua filter and dot
- fenced code attributes (enabled by the attributes extension)
2021-06-06 20:05:00 +02:00
Ryan Mulligan c43e0f4873
Merge pull request #125702 from alarsyo/db-to-md-nix-gitignore
doc: nix-gitignore to CommonMark
2021-06-06 07:35:06 -07:00
Antoine Martin 26ac257e4f doc: nix-gitignore to CommonMark
Closes #125670
2021-06-05 18:20:26 +02:00
Sandro c3f5d24b8d
Merge pull request #125494 from siraben/remove-stdenv-lib 2021-06-05 16:16:28 +02:00
Jan Tojnar 7497b4721c doc: Fix make in nix-shell
When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
2021-06-05 13:25:48 +02:00
Silvan Mosberger 155ae682a5 buildGoModule/buildGoPackage: Introduce ldflags argument
Previously it was not possible to define multiple ldflags, since only
the last definition applies, and there's some quoting issues with
`buildFlagsArray`. With the new `ldflags` argument it's possible to do
this, e.g.

    ldflags = drv.ldflags or [] ++ [
      "-X main.Version=1.0"
    ]

can now properly append a flag without clearing all previous ldflags.
2021-06-05 09:54:36 +10:00
Stefan Frijters c9ecf037ec
doc: Clean up generated media directory
pandoc uses ./media to extract media files - add it to the list
of directories that need to be removed by `make clean`.
2021-06-04 15:03:46 +02:00
Ben Siraphob 68b5b850d5 coding-conventions: remove reference to stdenv.lib 2021-06-03 19:54:53 +07:00
Sandro Jäckel 89d5f4b3d0
treewide: setuptools_scm -> setuptools-scm 2021-06-03 12:44:33 +02:00
Daniël de Kok 9cca8ce446 doc: fix incorrect use of cargoDeps
Thanks to @bjornfor for reporting this error!
2021-06-01 13:14:28 +02:00
Robert Hensing 4a025692d1 lib.sources: Generate docs 2021-05-29 16:03:54 +02:00
Maximilian Bosch 9ffd1e0413
Merge pull request #124739 from SFrijters/doc-fetchpatch
doc/coding-conventions: Add documentation for fetchpatch optional arguments
2021-05-28 22:13:11 +02:00
Stefan Frijters 585f63b364
doc/coding-conventions: Add documentation for fetchpatch optional arguments 2021-05-28 14:22:46 +02:00
Daniël de Kok 1da0b1dbc9
Merge pull request #122158 from danieldk/import-cargo-lock
rustPlatform.buildRustPackage: support direct use of Cargo.lock
2021-05-28 12:07:25 +02:00
Daniël de Kok b3969f3ad7 rustPlatform.buildRustPackage: support direct use of Cargo.lock
This change introduces the cargoLock argument to buildRustPackage,
which can be used in place of cargo{Sha256,Hash} or cargoVendorDir. It
uses the importCargoLock function to build the vendor
directory. Differences compared to cargo{Sha256,Hash}:

- Requires a Cargo.lock file.
- Does not require a Cargo hash.
- Retrieves all dependencies as fixed-output derivations.

This makes buildRustPackage much easier to use as part of a Rust
project, since it does not require updating cargo{Sha256,Hash} for
every change to the lock file.
2021-05-28 08:01:28 +02:00
Daniël de Kok 2f46d77e28 rustPlatform.importCargoLock: init
This function can be used to create an output path that is a cargo
vendor directory. In contrast to e.g. fetchCargoTarball all the
dependent crates are fetched using fixed-output derivations. The
hashes for the fixed-output derivations are gathered from the
Cargo.lock file.

Usage is very simple, e.g.:

importCargoLock {
  lockFile = ./Cargo.lock;
}

would use the lockfile from the current directory.

The implementation of this function is based on Eelco Dolstra's
import-cargo:

https://github.com/edolstra/import-cargo/blob/master/flake.nix

Compared to upstream:

- We use fetchgit in place of builtins.fetchGit.
- Sync to current cargo vendoring.
2021-05-28 08:01:25 +02:00
Ryan Mulligan c8e32eddf8
Merge pull request #120319 from fricklerhandwerk/docs-to-markdown
doc/using: convert to markdown
2021-05-27 06:44:16 -07:00
Domen Kožar d71078f4f4
Merge pull request #124273 from NixOS/backporting-action
Add backporting action
2021-05-25 11:38:29 +02:00
Domen Kožar 51c7afa95e
backport action: document the workflow 2021-05-25 09:47:33 +02:00
Thomas Depierre f55c3e2f21 beam-packages: drop erlang R18 R19 R20 and cuter 2021-05-25 07:38:41 +09:00
happysalada 6d1621c324 beam: fix documentation 2021-05-25 07:36:38 +09:00
happysalada a6cfe32089 elixir: add deprecation schedule docs 2021-05-24 10:14:17 +09:00
Alyssa Ross dc3dea22be doc/submitting-changes: should -> must
To me, as a native English speaker, this doesn't change the meaning of
the sentence at all.  But to a non-native speaker, this can read like
the staging-next rules are only recommendations.  Let's make this
clearer.
2021-05-23 20:26:32 +00:00
Robert Hensing ea0c94f50d
Merge pull request #123111 from hercules-ci/writeDirectReferencesToFile
writeDirectReferencesToFile and maintenance
2021-05-17 15:44:10 +02:00
Jan Tojnar b5f84d830b doc: Add anchors to dhall sections
This will ensure the sections have stable links as well as prevent conflicts (pandoc uses heading text for ids and DocBook requires unique ids across the book).
2021-05-17 09:37:49 +02:00
Sandro f66a5695b4
Merge pull request #121252 from NixOS/SuperSandro2000-patch-1
doc/contributing: add unnecessary string conversions
2021-05-17 02:40:29 +02:00
ydlr a2f3a63953
restore buildMix and its bootstrapper (#122374)
* restore mixBuild

remove bootstrapper by going through ERL_LIBS
mix will use ERL_LIBS to find compiled dependencies

Co-authored-by: Zach <zach@hipcreativeinc.com>
2021-05-17 08:05:40 +09:00
Gabriel Gonzalez b23797e2c5
dhall: Document language support in the Nixpkgs manual (#123051) 2021-05-15 08:51:08 -07:00
Robert Hensing ed4523186e writeReferencesToFile: docs and tests 2021-05-15 17:04:25 +02:00
Robert Hensing cc60f81e69 writeDirectReferencesToFile: init 2021-05-15 17:04:25 +02:00