Commit Graph

823 Commits

Author SHA1 Message Date
Matthew Bauer
54737e329b
doc: fix incorrect example
For whatever reason, nix-build ... --argstr a.b "c" doesn't work. It fails quitely so it's best to use an example here that works.
2018-11-28 16:00:43 -06:00
Léo Gaspard
22d8291c17
Merge branch 'pr-51111'
* pr-51111:
  doc: document upgrading Ruby packages
2018-11-29 00:37:06 +09:00
Alyssa Ross
6bda83a64d
doc: document upgrading Ruby packages
As requested[1] by @Ekleog.

[1]: https://github.com/NixOS/nixpkgs/pull/51040#issuecomment-441642763
2018-11-28 13:19:22 +00:00
zimbatm
064bd03b8c
doc: tweak the coding conventions (#51113)
Encouraging to put container elements on their own lines to minimize
diffs, merge conflicts and making re-ordering easier.

Nix doesn't suffer the restrictions of other languages where commas are
used to separate list items.
2018-11-27 22:14:41 +01:00
Jörg Thalheim
afbdeb7b9b
Merge pull request #50802 from aszlig/autopatchelf-improvements
autoPatchelfHook: Fixes/improvements for Android SDK emulator
2018-11-27 10:25:26 +00:00
Jörg Thalheim
3324503824
doc: add example usage for breakpointHook (#51005) 2018-11-26 11:54:23 +00:00
Frederik Rietdijk
fd26e7be2a Merge master into staging-next 2018-11-20 11:47:26 +01:00
Pierre Bourdon
6b1d3dc590 doc/reviewing-contributions: fix build error
Regression from #50674. Section IDs cannot contain spaces.
2018-11-20 03:46:34 +01:00
aszlig
503b41b9b2
doc/stdenv: Document autoPatchelfHook changes
First of all, this makes the existing documentation a bit more clear on
what autoPatchelfHook is all about, because after discussing with
@svanderburg - who wrote a similar implementation - the rationale about
autoPatchelfHook wasn't very clear in the documentation.

I also added the recent changes around being able to use autoPatchelf
manually and the new --no-recurse flag.

Signed-off-by: aszlig <aszlig@nix.build>
2018-11-20 00:11:31 +01:00
Matthew Bauer
c2e6a4362a doc/cross-compilation: remove reference to old wiki
The link doesn’t work and it’s not very important to the documentation anyway.
2018-11-19 13:03:24 -06:00
Matthew Bauer
5e9f452385 doc/reviewing-contributions: pull-requests -> pull requests
This makes things more consistent. It’s also how GitHub refers to pull
requests.
2018-11-19 13:03:23 -06:00
Matthew Bauer
9d3108c3ae doc/cross-compilation: fixup
More cleanups and stuff. May need to be split up.
2018-11-19 13:03:23 -06:00
Matthew Bauer
ee58ab3cb9 doc/platform-notes: reword xcode warning
xcbuild doesn’t work exactly like xcode in some ways.
2018-11-19 13:03:23 -06:00
Matthew Bauer
4a49921a69 doc/stdenv: more changes
Lots of reworking here. May need to be split up.
2018-11-19 13:03:22 -06:00
Matthew Bauer
49e5bd0dbe doc/stdenv: document more setup hook
Here I document setup hooks provided by:

- cmake
- xcbuildHook
- meson
- ninja
- unzip
- wafHook
- scons
2018-11-19 13:03:09 -06:00
Matthew Bauer
4621d14b4a doc/stdenv: document prefixKey
This seems like a useful thing to document
2018-11-19 13:02:31 -06:00
Matthew Bauer
b01613c9ce doc: move checkInputs to check phase section
This makes more sense in context.
2018-11-19 13:02:31 -06:00
Matthew Bauer
32ddbe3da9 doc: typo fixes 2018-11-19 13:02:17 -06:00
Frederik Rietdijk
e343a85cfb Merge master into staging-next 2018-11-19 09:55:32 +01:00
Andrei Lapshin
e198f9e42f
Fix typo in nixpkgs manual 2018-11-19 09:09:02 +03:00
Vladimír Čunát
a995fc2dd7
Merge #26513: docs: use RFC 2119 in a section 2018-11-18 15:34:15 +01:00
Frederik Rietdijk
63c6875f26 Merge master into staging-next 2018-11-18 10:32:12 +01:00
Jörg Thalheim
552b2955d3
doc/node: document the new preferred node version 2018-11-16 21:24:25 +00:00
Benjamin Hipple
286e7a57c4 docs: fix minor grammar issues in the manual 2018-11-14 21:40:47 -05:00
Silvan Mosberger
513c659d56
Merge pull request #50182 from Infinisil/idris/doc-update
nixpkgs idris docs: Update and improve
2018-11-14 18:47:40 +01:00
Frederik Rietdijk
daf3297cb4 Merge master into staging-next 2018-11-12 18:59:08 +01:00
Théo Zimmermann
208aedb971 ocamlPackages.*: remove unnecessary unpackCmd 2018-11-12 17:25:18 +00:00
Silvan Mosberger
f8a1333c8e
nixpkgs idris docs: Update and improve 2018-11-12 13:23:31 +01:00
rht
febadf8ddb
Use RFC 2119 convention to describe package naming convention 2018-11-11 15:51:16 +00:00
Léo Gaspard
2986ce16a8
meta.tests: rename into passthru.tests
Nix currently rejects derivations in `meta` values. This works around
that limitation by using `passthru` instead.

Closes https://github.com/NixOS/nixpkgs/issues/50230
2018-11-11 23:11:46 +09:00
Léo Gaspard
cae5598611
meta.tests: drop meta.needsVMSupport
Its job is already handled by `requiredSystemFeatures`
2018-11-11 23:11:46 +09:00
Frederik Rietdijk
7863aae5b2 Merge master into staging-next 2018-11-11 08:59:44 +01:00
Benjamin Hipple
a649f1c0cd doc: fix default python interpreter
The default for `python3` is currently `python36`.
2018-11-10 13:00:10 -05:00
Frederik Rietdijk
53d00c3351 Merge master into staging-next 2018-11-10 11:08:54 +01:00
Jörg Thalheim
7e2e6e1131
Merge pull request #49684 from Zimmi48/dune-package
buildDunePackage: add support function and use it in a few packages
2018-11-07 13:01:09 +00:00
Eelco Dolstra
78090f4f09
Remove preferLocalBuild documentation
It's incorrect (preferLocalBuild does not prevent uploading to binary
caches) and is not a stdenv attribute (it's already documented in the
Nix manual).
2018-11-07 11:45:40 +01:00
Théo Zimmermann
5cd08118d9
duneBuildPackage: document 2018-11-07 10:08:08 +01:00
Timo Kaufmann
6141939d6e
Merge pull request #44439 from Ekleog/meta-tests
[RFC] Use `meta.tests` to link from packages to the tests that test them
2018-11-07 00:05:22 +01:00
Jan Path
1b111df290
docs: Remove redundancy 2018-11-05 20:16:51 +01:00
Frederik Rietdijk
b1bdce0793 python34: remove
Python 3.4 will receive it's final patch release in March 2019 and there won't
be any releases anymore after that, so also not during NixOS 2019.03.

Python 3.4 is not used anymore in Nixpkgs. In any case, migrating code from
3.4 to 3.4+ is trivial.
2018-11-04 18:48:24 +01:00
Vladimír Čunát
a92a2c8e15
Merge branch 'master' into staging
Conflict: rename of pythondaemon -> python-daemon.
2018-11-02 14:40:14 +01:00
Benjamin Hipple
baf0703010 pythonPackages.pythondaemon: rename to pythonPackages.python-daemon
This commit renames the pythondaemon module to match its module name, github
name, and pypi name, which makes it easier to find and reference. In order to
avoid breaking any external users, I've left an alias with a deprecated warning.
2018-10-30 21:09:34 +01:00
Frederik Rietdijk
1d196d99be Merge staging-next into staging 2018-10-30 20:35:15 +01:00
Frederik Rietdijk
0e0d20fb5f Merge master into staging-next 2018-10-30 19:55:48 +01:00
Léo Gaspard
02e1f00ffd
dovecot, opensmtpd: add link to test in meta.tests
Rationale
---------

Currently, tests are hard to discover. For instance, someone updating
`dovecot` might not notice that the interaction of `dovecot` with
`opensmtpd` is handled in the `opensmtpd.nix` test.

And even for someone updating `opensmtpd`, it requires manual work to go
check in `nixos/tests` whether there is actually a test, especially
given not so many packages in `nixpkgs` have tests and this is thus most
of the time useless.

Finally, for the reviewer, it is much easier to check that the “Tested
via one or more NixOS test(s)” has been checked if the file modified
already includes the list of relevant tests.

Implementation
--------------

Currently, this commit only adds the metadata in the package. Each
element of the `meta.tests` attribute is a derivation that, when it
builds successfully, means the test has passed (ie. following the same
convention as NixOS tests).

Future Work
-----------

In the future, the tools could be made aware of this `meta.tests`
attribute, and for instance a `--with-tests` could be added to
`nix-build` so that it also builds all the tests. Or a `--without-tests`
to build without all the tests. @Profpatsch described in his NixCon talk
such systems.

Another thing that would help in the future would be the possibility to
reasonably easily have cross-derivation nix tests without the whole
NixOS VM stack. @7c6f434c already proposed such a system.

This RFC currently handles none of these concerns. Only the addition of
`meta.tests` as metadata to be used by maintainers to remember to run
relevant tests.
2018-10-30 21:31:39 +09:00
Théo Zimmermann
2f9fc897eb Add mention of nix-prefetch-github. (#49336) 2018-10-30 01:24:07 +01:00
Frederik Rietdijk
1cca105769 Merge staging-next into staging 2018-10-27 09:05:30 +02:00
Frederik Rietdijk
a64058e205 Merge master into staging-next 2018-10-27 09:04:53 +02:00
Jörg Thalheim
764d165f43
doc: apply make format 2018-10-26 11:13:54 +01:00
Jörg Thalheim
7f80fb2db4
doc: extend breakpointHook documentation 2018-10-26 11:13:24 +01:00