Commit Graph

223 Commits

Author SHA1 Message Date
Matthias Beyer
15be920354 doc: gnu hello is much simpler than cpio
This patch changes the documentation about simple packages. cpio was
listed as simplest possible package, which is not true anymore, gnu
hello is much simpler.
2015-07-17 17:00:20 +02:00
Cillian de Róiste
8a1a97c35c Move the submitting-changes down, after coding conventions 2015-07-12 13:35:56 +02:00
Cillian de Róiste
3a0707f0c7 Move the details from CONTRIBUTING.md to the manual #8734 2015-07-12 13:33:55 +02:00
Profpatsch
b30cab15ea language support python docs wrong statement
Remove wrong line about propagatedBuildInputs.
2015-07-12 13:07:39 +02:00
Pascal Wittmann
cdd999baee doc: document dontMoveSbin variable 2015-07-09 12:43:34 +02:00
Profpatsch
ef5d158e83 language-support python: propagatedBuildInputs
Explain difference between buildInputs and propagatedBuildInputs.
Shamefully steal wording from Perl.
2015-07-08 14:21:51 +02:00
Kosyrev Serge
5fee7af3ba ghc: add haskell.compiler.ghcNokinds, for Richard Eisenberg's 'nokinds' branch 2015-07-06 11:09:28 +03:00
Luca Bruno
e7d81a371b doc: make it clear the Contributing section is for the docs 2015-06-30 12:25:55 +02:00
Luca Bruno
e06f494a81 doc: document lib.makeOverridable 2015-06-30 12:19:49 +02:00
Luca Bruno
01ce5ce050 doc: document .override 2015-06-30 11:26:27 +02:00
Luca Bruno
36cd08e374 nixpkgs-manual: fix callouts 2015-06-30 11:04:46 +02:00
Edward Tjörnhammar
c45b5aba92 Document the different license base cases 2015-06-28 12:42:43 +02:00
Luca Bruno
7f5f9072ad all-packages.nix: Add pkgs.overridePackages 2015-06-26 15:08:11 +02:00
Damien Cassou
8297a9eef9 Change where window managers should be
This patch reflects current practice.

Fixes issue #8364.
2015-06-18 10:44:27 +02:00
Peter Simons
fdc1887a6e doc: add user's guide for the Haskell infrastructure
Resolves https://github.com/NixOS/nixpkgs/issues/4941.
2015-06-05 00:14:58 +02:00
Eelco Dolstra
07b212b09d Strip indentation from programlistings 2015-06-03 17:05:14 +02:00
Eelco Dolstra
35ff30c73f Streamline contributing section 2015-06-03 17:05:10 +02:00
Pascal Wittmann
9c983ade4d doc: fix references 2015-06-02 11:22:19 +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
Allen Nelson
d2cbcc68be added documentation for makeWrapperArgs 2015-05-24 22:22:20 -05:00
Arseniy Seroka
4e838ed303 Merge pull request #6539 from jagajaga/documentation
add information about git-based pkgs
2015-05-21 19:57:53 +03:00
Luca Bruno
d511369fcc go: document disabled flag 2015-05-18 12:55:02 +02:00
Edward Tjörnhammar
2bf516613d Add section on fetching sources 2015-05-15 14:10:01 +02:00
Luca Bruno
58b865cfc6 go: remove renameImports and use goPackageAliases 2015-05-15 11:16:59 +02:00
Linus Arver
62ad22b8ae doc: language-support: fix typo 2015-05-10 15:28:58 -07:00
Vladimír Čunát
75ebc3cf1d doc/stdenv: fix manual build after #7711 2015-05-09 14:58:40 +02:00
Ryan Scheel (Havvy)
0b94774479 Docs: non-empty value -> true 2015-05-05 20:12:37 +00:00
Ryan Scheel
df7b5b4ecb Doc dontDisableStatic variable to configure stage 2015-05-05 20:08:02 +00:00
Sebastian Jordan
018062529a Reduce verbosity of packageOverride docs further 2015-04-23 17:11:38 +02:00
Sebastian Jordan
20dadec264 Reduce verbosity of packageOverrides description. 2015-04-23 17:11:38 +02:00
Sebastian Jordan
8a78dcc00f Document about packageOverrides 2015-04-23 17:11:38 +02:00
Luca Bruno
18a6f52bc9 manual: Document buildFlags of buildGoPackage 2015-04-17 10:13:30 +02:00
Luca Bruno
5b538a6dd1 manual: Document buildGoPackage renameImports 2015-04-16 19:02:50 +02:00
Christian Theune
86d82df72b Update the ruby packaging docs to show how to bundle Ruby Gem-based
applications using bundix.

Fixes #5985
2015-03-31 19:04:42 +02:00
Arseniy Seroka
83434becf0 add information about git-based pkgs 2015-02-23 23:55:15 +03:00
Domen Kožar
934f97281f doc: fix programlistin formatting 2015-02-15 18:29:52 +01:00
Domen Kožar
ef8aaa5571 fixes #5394 2015-02-15 18:22:26 +01:00
Emery Hemingway
faa5dccab8 new Go support function 'buildGoPackage'
add a setupHook to the Go compiler that builds a GOPATH
new buildGoPackage function that overides the phases of stdenv
2015-02-03 14:21:48 +01:00
Domen Kožar
35fa59f9ca garden 2015-01-26 12:12:14 +01:00
Domen Kožar
8408136da7 brevity of nixpkgs configuration documentation 2015-01-25 21:26:05 +01:00
Matthias Beyer
9a6d6155c2 Added paragraph about where to find licenses 2015-01-25 21:19:07 +01:00
Matthias Beyer
266a5128c3 Fixup white-/blacklisting examples to actually use real licenses 2015-01-25 21:19:07 +01:00
Matthias Beyer
f6b1d82836 Add paragraph about Nix vs. NixOS 2015-01-25 21:19:07 +01:00
Matthias Beyer
9bb80ffa2c Add documentation for nixpkgs.config settings (allowUnfree, allowUnfreePredicate, whitelistedLicenses, blacklistedLicenses) 2015-01-25 21:19:07 +01:00
Charles Strahan
dfc225d143 Merge branch 'master' of github.com:nixos/nixpkgs into pleasant-ruby
Conflicts:
	pkgs/applications/version-management/git-and-tools/default.nix
	pkgs/applications/version-management/git-and-tools/hub/default.nix
	pkgs/tools/audio/mpdcron/default.nix
2015-01-20 20:21:03 -05:00
Daniel Peebles
f458b6d05c Fix copy&paste typo 2015-01-18 14:57:04 -05:00
Charles Strahan
145733c479 Merge branch 'master' of github.com:nixos/nixpkgs into pleasant-ruby
Conflicts:
	pkgs/applications/version-management/redmine/default.nix
	pkgs/development/interpreters/ruby/gem.nix
	pkgs/development/interpreters/ruby/generated.nix
	pkgs/development/interpreters/ruby/patches.nix
	pkgs/development/tools/vagrant/default.nix
	pkgs/servers/consul/default.nix
2014-12-28 14:29:52 -05:00
John Wiegley
28b6fb61e6 Change occurrences of gcc to the more general cc
This is done for the sake of Yosemite, which does not have gcc, and yet
this change is also compatible with Linux.
2014-12-26 11:06:21 -06:00
Robert Helgesson
8178fd285f Fix minor typo. 2014-12-19 16:30:45 +01:00
Domen Kožar
860035646d typos 2014-11-15 20:23:32 +01:00
Domen Kožar
e5eb8354d4 remove unused doc/quote-literals.xsl 2014-11-15 20:23:26 +01:00
Domen Kožar
07b6d3d2c6 Initial documentation for Python packaging. Feedback welcome.
cc @chaoflow @offlinehacker @garbas @goodwillcoding @brodul
@cillianderoiste @matejc

Fixes #64
2014-11-13 21:31:27 +01:00
Charles Strahan
6e6ac35024 more rubyLibs renaming 2014-11-12 22:32:32 +00:00
Domen Kožar
cac40ad982 doc/contributing.xml: remove lies 2014-11-08 21:56:23 +01:00
Michael Raskin
eecd29dff6 Document meta.branch 2014-10-07 16:23:27 +04:00
Eelco Dolstra
4b072cfe08 Nixpkgs manual: Mention xz support
Issue #4393.
2014-10-07 00:22:10 +02:00
Vincent Laporte
a65767a0b4 nixpkgs manual: packaging coq libraries 2014-09-28 22:02:36 +01:00
wyvie
164e68c7d3 Added description to languages-support.xml 2014-09-23 13:56:45 +02:00
Domen Kožar
5247c11b4a manual: mention go2nix 2014-09-16 20:40:37 +02:00
Domen Kožar
aa162b388d package gim-nix and document it 2014-09-12 00:26:51 +02:00
Domen Kožar
b420eeba44 remove bittorrent package since it's obsolete 2014-09-05 22:49:31 +02: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
438b9c543d Nixpkgs manual: Add a Nix expression to build 2014-08-24 11:03:55 +02:00
Eelco Dolstra
14f48dd5c2 Nixpkgs manual: Drop author bla bla 2014-08-24 11:03:55 +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
64cd30518d doc: mention nix-prefetch-scripts package 2014-07-27 15:21:38 +02:00
Domen Kožar
380e8ad794 fix manual build 2014-07-27 15:21:27 +02:00
Domen Kožar
9471af0f8a doc: add section how to build the manual 2014-07-27 15:21:17 +02:00
Domen Kožar
6c219636da doc: remove obsolete step on quickstart 2014-07-27 14:58:31 +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
Eelco Dolstra
2737291b5d Manual: html -> xhtml 2014-07-03 12:37:40 +02:00
Anders Claesson
1777724a33 Fix trivial spelling mistake in docs 2014-06-13 11:11:27 +01:00
Ramakrishnan Muthukrishnan
58b58903ba doc: quick-start.xml -- fix a typo in the link.
Chapter 2, gmp 5.1.1.nix url and filename has changed in the repo
to 5.1.x.nix.
2014-04-14 11:42:01 +05:30
Ramakrishnan Muthukrishnan
13137dbb46 doc: meta.xml -- fix a typo 2014-04-14 11:29:36 +05:30
Vladimír Čunát
1f6a15d7de Merge #1901: add preFixupPhases to stdenv; for gsettings
Without this stdenv change it seems difficult to fix some glib's gsettings issues,
as the folders in question may (not) be created in installPhase.
2014-04-02 19:06:41 +02:00
Domen Kožar
5d9040ee6b Merge pull request #1815 from vcunat/p/doc-package-naming
doc: document current conventions on package naming
2014-03-04 23:41:35 +01:00
Domen Kožar
1f822d3b5f fix tarball 2014-02-28 23:22:20 +01:00
Domen Kožar
0e58538fa8 doc: gstreamer setup-hook 2014-02-28 02:02:27 +01:00
Domen Kožar
5726600c04 doc: gdk-pixbuf setup-hook 2014-02-28 01:40:21 +01:00
Vladimír Čunát
1efb6e65d2 doc: document current conventions on package naming
Mostly: encourage using dashes instead of underscores.
2014-02-23 08:00:59 +01:00
William A. Kennington III
bdb842d5eb Move all db4 packages to the default db5 2014-02-15 12:03:02 +01:00
Eelco Dolstra
e060d9a2ff Remove obsolete file 2014-02-05 19:18:33 +01:00
Eelco Dolstra
cf4acab567 manual: Document Java support 2014-01-13 13:15:59 +01:00
Eelco Dolstra
5d6259a973 Add a setup hook that automatically sets up $CLASSPATH
All JARs in $pkg/share/java (for each $pkg in the build inputs) are
added to $CLASSPATH.  Thus, you can say

  buildInputs = [ setJavaClassPath someJavaDependency ];

and the JARs in someJavaDependency will be found automatically by
tools like javac or ant.

Note that the manual used to say that JARs should be installed in
lib/java; this is now share/java, following the Debian policy:

  http://www.debian.org/doc/packaging-manuals/java-policy/x110.html

The directory share/java makes more sense because JARs are
architecture-independent.  (Also, a quick grep shows that we were not
exactly consistent about this in Nixpkgs.)
2014-01-06 14:36:14 +01:00
Rob Vermaas
5aa6c546dc Clarify a step from the quick start section. 2013-12-30 13:45:46 +01:00
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
041da5a6f9 Unify the Nixpkgs and NixOS version numbers 2013-10-10 13:28:22 +02:00
Eelco Dolstra
1ca98d7c09 Move some old docs 2013-10-01 10:53:21 +02:00
Eelco Dolstra
8a182718ca splashutils: Remove 2013-09-26 18:03:43 +02:00
Chris Van Vranken
e5b89fc601 Fix broken links 2013-09-25 19:53:47 -04:00
Ivan Kozik
1866619acc Fix a few typos 2013-08-11 10:55:53 +00:00
Eelco Dolstra
acba9240cd nixos.org/tarballs -> tarballs.nixos.org
It's currently the same machine, but tarballs.nixos.org should become
an S3/CloudFront site eventually.
2013-06-25 14:12:16 +02:00
Eelco Dolstra
629daa2102 Rewrite the CPAN generator to Perl
Also:

- It's now installable by doing "nix-env -i nix-generate-from-cpan".

- It maps dependencies to the correct attribute (e.g. HTML::HeadParser
  is mapped to HTMLParser).

- It automatically selects buildPerlPackage or buildPerlModule.

- It's documented in the manual.
2013-06-13 15:56:23 +02:00
Domen Kozar
9986457331 add dontBuild docs 2013-05-05 10:50:07 +02:00