Commit Graph

41 Commits

Author SHA1 Message Date
Domen Kožar
9587693abb
Merge pull request #63351 from Ekleog/fix-2532
docs: document that nix will not support derivations in meta
2019-06-18 20:09:08 +02:00
Léo Gaspard
e04856a173
docs: document that nix will not support derivations in meta
That's sad, but… https://github.com/NixOS/nix/issues/2532
2019-06-17 19:03:43 +02:00
Jan Tojnar
a3f2131eb6 doc: Use prompt more often 2019-06-17 13:25:50 +02:00
Michael Raskin
76e2a96475
Changelog meta entry (#60371)
meta.changelog: enable, document, add for GNU Hello
2019-05-10 16:55:29 +00:00
c0bw3b
0498ccd076 Treewide: use HTTPS on GNU domains
HTTP -> HTTPS for :
- http://gnu.org/
- http://www.gnu.org/
- http://elpa.gnu.org/
- http://lists.gnu.org/
- http://gcc.gnu.org/
- http://ftp.gnu.org/ (except in fetchurl mirrors)
- http://bugs.gnu.org/
2018-12-02 15:51:59 +01: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
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
Samuel Dionne-Riel
a45edd9024 doc: ran make format
With visual inspection that nothing got worse.
2018-05-31 21:03:37 -04:00
Dmitry Kalinkin
3dd6350420
doc: use "with stdenv.lib" in meta 2018-05-22 13:25:09 -04:00
Graham Christensen
77161de454
nixpkgs docs: format =) 2018-05-01 19:54:21 -04:00
Matthew Bauer
124d47c65a meta: fix fallout from #36275 2018-03-18 00:16:43 -05:00
Daniel Barlow
9c50ae6898 lib, treewide: Add missing MIPS arches, and fix existing usage
Existing "mips64el" should be "mipsel".

This is just the barest minimum so that nixpkgs can recognize them as
systems - although required for building individual derivations onto
MIPS boards, it is not sufficient if you want to actually build nixos on
those targets
2018-02-23 20:43:42 -05:00
Renaud
4e892b9c03 nixpkgs manual : clearer meta.platforms description
Refer to doubles.nix for a list of common platforms types used in packages
2017-11-04 16:08:14 +01:00
Franz Pletz
7f7ebe5bf6 nixpkgs manual: Fix license strings docs
The wrong usage of unfree-redistributable fixed in
ea242619fb0028f830238a0fa1b19277d14508ff can be explaind by unclear
documention, specifically the section in the nixpkgs manual describing
generic licenses it is written to use attributes from `stdenv.lib.licenses`
but in the list the strings form was documented without quotation marks.

This confuses people because the package builds fine locally but failes
the tests on travis-ci.
2016-02-24 01:48:02 +01:00
Peter Simons
5d482336b9 doc/meta.xml: don't encourage users to add a meta.version attribute
That attribute is completely redundant since it just duplicates information
from "name".

Cc: @7c6f434c who added that section in e39b1f4ec8740e7dd34185c38464db5ac814eed5.
2016-01-05 12:36:33 +01:00
Pascal Wittmann
56d3457c2f doc: --meta is not needed in the presence of --json 2015-11-29 21:51:22 +01:00
Eelco Dolstra
645441c207 hello/ex-2 -> hello 2015-09-22 20:23:23 +02:00
Edward Tjörnhammar
c45b5aba92 Document the different license base cases 2015-06-28 12:42:43 +02:00
Pascal Wittmann
53b5d946e1 doc: add section ids
This commit also use enforces consistent use of the prefixes "sec" for
section and "ssec" for subsection.
2015-05-31 18:41:34 +02:00
Michael Raskin
eecd29dff6 Document meta.branch 2014-10-07 16:23:27 +04:00
Michael Raskin
e39b1f4ec8 Add a few meta-attribute descriptions; rewrite the meta-attribure list description to mean that it is expected that all used meta-attributes are described in the manual. 2014-09-03 02:10:00 +04:00
Jaka Kranjc
de258456d8 meta.xml: fixed small omission 2014-08-24 16:36:46 +02:00
Eelco Dolstra
76ac17d36b Nixpkgs manual: Fix validity 2014-08-24 11:03:55 +02:00
Vladimír Čunát
5cc2a142b0 doc/meta.xml: fix github links, clarify licensing section 2014-07-30 20:07:54 +02:00
Domen Kožar
380e8ad794 fix manual build 2014-07-27 15:21:27 +02:00
Domen Kožar
8590e39e01 doc: change one occurance of --xml to --json 2014-07-27 14:22:58 +02:00
Domen Kožar
e51dfc6bf6 doc: explain when hydra builds the package 2014-07-27 14:13:27 +02:00
Domen Kožar
cf5ec2f74b remove documentation on non-unfree licenses, nobody maintains it 2014-07-27 13:54:37 +02:00
Domen Kožar
e3319eb73d doc: modernize meta attributes documentation 2014-07-27 13:54:37 +02:00
Ramakrishnan Muthukrishnan
13137dbb46 doc: meta.xml -- fix a typo 2014-04-14 11:29:36 +05:30
Eelco Dolstra
a2cbc77e4f Only show/build a package on the platforms listed in meta.platforms
The function ‘mkDerivation’ now checks whether the current platform
type is included in a package's meta.platform field.  If not, it
throws an exception:

  $ nix-build -A linux --argstr system x86_64-darwin
  error: user-thrown exception: the package ‘linux-3.10.15’ is not supported on ‘x86_64-darwin’

These packages also no longer show up in ‘nix-env -qa’ output.  This
means, for instance, that the number of packages shown on
x86_64-freebsd has dropped from 9268 to 4764.

Since meta.platforms was also used to prevent Hydra from building some
packages, there now is a new attribute meta.hydraPlatforms listing the
platforms on which Hydra should build the package (which defaults to
meta.platforms).
2013-11-05 00:06:10 +01:00
Eelco Dolstra
754704ea18 Allow packages to be marked as "broken" by setting meta.broken
The effect is that they won't show up in "nix-env -qa" anymore.
2013-11-04 21:11:00 +01:00
Eelco Dolstra
cd5755845f Lots of Perl package updates 2013-01-19 00:02:51 +01:00
Rob Vermaas
b3c63a98f0 Remove all svn references 2012-09-04 16:14:01 +02:00
Eelco Dolstra
3f82d6c069 svn path=/nixpkgs/branches/xorg-7.5/; revision=18032 2009-10-29 15:28:43 +00:00
Eelco Dolstra
1024251d75 svn path=/nixpkgs/branches/xorg-7.5/; revision=18028 2009-10-29 14:20:11 +00:00
Eelco Dolstra
9301524c50 * Fontconfig updated to 2.7.3. Use /etc/fonts as the default
configuration directory so that users on other distributions don't
  need to set $FONTCONFIG_FILE (NIXPKGS-29).  Also use
  /var/cache/fontconfig for the cache to prevent programs run by root
  from writing into the Nix store.

svn path=/nixpkgs/branches/xorg-7.5/; revision=18021
2009-10-29 13:22:43 +00:00
Eelco Dolstra
5615f4d646 svn path=/nixpkgs/trunk/; revision=16257 2009-07-08 16:08:29 +00:00
Eelco Dolstra
94b0227aad svn path=/nixpkgs/trunk/; revision=14311 2009-03-03 13:47:46 +00:00
Eelco Dolstra
79d3e0926d * Started documenting the meta attributes, including a first
(very incomplete) attempt at standardising the license attribute.

svn path=/nixpkgs/trunk/; revision=14028
2009-02-10 23:29:42 +00:00