nixpkgs-suyu/doc
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
..
functions Merge pull request #47430 from roberth/nixpkgs-extend 2018-10-23 20:21:48 -04:00
languages-frameworks doc: apply make format 2018-10-26 11:13:54 +01:00
old reewide: Purge all uses stdenv.system and top-level system 2018-08-30 17:20:32 -04:00
.gitignore Generate links to function definitions 2018-10-05 11:20:46 -04:00
coding-conventions.xml
configuration.xml Manual: Random indentation fixes 2018-09-03 17:13:46 +02:00
contributing.xml
cross-compilation.xml nixpkgs docs: Reformat 2018-10-02 15:59:59 -04:00
default.nix Generate links to function definitions 2018-10-05 11:20:46 -04:00
functions.xml nixpkgs: Start documenting library functions in XML 2018-10-05 10:06:08 -04:00
introduction.chapter.md Fix invalid sentence in doc (#43228) 2018-07-08 23:46:34 +02:00
lib-function-locations.nix Generate links to function definitions 2018-10-05 11:20:46 -04:00
Makefile Generate links to function definitions 2018-10-05 11:20:46 -04:00
manual.xml
meta.xml dovecot, opensmtpd: add link to test in meta.tests 2018-10-30 21:31:39 +09:00
multiple-output.xml nixpkgs docs: give linked things IDs 2018-09-01 15:20:57 -04:00
overlays.xml doc: Improve overrides and overlays documentation 2018-10-18 14:01:06 +02:00
overrides.css
package-notes.xml weechat: add perl.withPackages (#48815) 2018-10-23 12:23:47 +02:00
platform-notes.xml nixpkgs docs: normalize 2018-08-27 19:54:41 -04:00
quick-start.xml doc: change git:// links to https:// (#44395) 2018-08-03 14:01:34 +01:00
release-notes.xml nixpkgs docs: give linked things IDs 2018-09-01 15:20:57 -04:00
reviewing-contributions.xml nixpkgs docs: give linked things IDs 2018-09-01 15:20:57 -04:00
shell.nix Generate links to function definitions 2018-10-05 11:20:46 -04:00
stdenv.xml doc: apply make format 2018-10-26 11:13:54 +01:00
style.css
submitting-changes.xml Add section IDs 2018-09-01 15:06:38 -04:00