3
0
Fork 0
forked from mirrors/nixpkgs
Commit graph

31 commits

Author SHA1 Message Date
Graham Christensen 77161de454
nixpkgs docs: format =) 2018-05-01 19:54:21 -04:00
Graham Christensen 92d53362d4
Move all nixpkgs doc files in to the doc directory
This makes a makefile-driven developer workflow nicer.
2018-03-25 19:52:00 -04:00
Daiderd Jordan 633b03c57f
docs: add section on common darwin issues 2017-11-01 18:08:19 +01:00
John Ericson 39fb46f538 nixpkgs docs: Cross compilation docs 2017-01-24 11:37:56 -05:00
Nicolas B. Pierron f5dfe78a1e Add overlays mechanism to Nixpkgs.
This patch add a new argument to Nixpkgs default expression named "overlays".

By default, the value of the argument is either taken from the environment variable `NIXPKGS_OVERLAYS`,
or from the directory `~/.nixpkgs/overlays/`.  If the environment variable does not name a valid directory
then this mechanism would fallback on the home directory.  If the home directory does not exists it will
fallback on an empty list of overlays.

The overlays directory should contain the list of extra Nixpkgs stages which would be used to extend the
content of Nixpkgs, with additional set of packages.  The overlays, i-e directory, files, symbolic links
are used in alphabetical order.

The simplest overlay which extends Nixpkgs with nothing looks like:

```nix
self: super: {
}
```

More refined overlays can use `super` as the basis for building new packages, and `self` as a way to query
the final result of the fix-point.

An example of overlay which extends Nixpkgs with a small set of packages can be found at:
  https://github.com/nbp/nixpkgs-mozilla/blob/nixpkgs-overlay/moz-overlay.nix

To use this file, checkout the repository and add a symbolic link to
the `moz-overlay.nix` file in `~/.nixpkgs/overlays` directory.
2017-01-16 01:17:33 +01:00
Eric Sagnes 2b1d67a275 manual: reviewing contributions nixos -> nixpkgs (#20626) 2016-11-22 15:15:02 +01:00
Eric Sagnes 96a4e1f80d nixpkgs manual: cleanup (#15611) 2016-05-22 10:05:37 +01:00
Eric Merritt be5da0449e beam-support: update registry to latest '59b836d' 2016-04-23 19:03:28 -07:00
Vladimír Čunát c73191f11e nixpkgs manual: add multiple-output chapter 2016-04-07 16:00:41 +02:00
Eric Merritt 6a493a2b43 erlang support: Add minimal documentation to nix
This commit adds some very minimial documentation to the Nix
manual. Hopefully, its enough to get someone started and serve as a
first footstep for future documentation writers
2016-01-15 08:17:33 -08:00
Vladimír Čunát ef21e5ee60 nixpkgs manual: split languages into separate files
There's no change in content except for amending the title of the
section to mention "frameworks", as e.g. I don't consider Qt a language,
and it's likely there will be more of similar cases in future.

To be certain, I checked diff of the generated HTMLs.
2015-12-19 16:08:00 +01:00
Avery Glitch b72bcd1e32 Fixed a syntax error in the buildFHSChrootEnv example. Also, fixed the manual.xml so it actually builds. 2015-12-18 00:22:51 +11: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
Luca Bruno e7d81a371b doc: make it clear the Contributing section is for the docs 2015-06-30 12:25:55 +02:00
Luca Bruno 7f5f9072ad all-packages.nix: Add pkgs.overridePackages 2015-06-26 15:08:11 +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
Matthias Beyer 9bb80ffa2c Add documentation for nixpkgs.config settings (allowUnfree, allowUnfreePredicate, whitelistedLicenses, blacklistedLicenses) 2015-01-25 21:19:07 +01: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
Domen Kožar 9471af0f8a doc: add section how to build the manual 2014-07-27 15:21:17 +02:00
Eelco Dolstra 041da5a6f9 Unify the Nixpkgs and NixOS version numbers 2013-10-10 13:28:22 +02:00
Eelco Dolstra 09ab016c6c * Sync CSS with the Nix manual.
svn path=/nixpkgs/trunk/; revision=34062
2012-05-11 21:42:00 +00:00
Eelco Dolstra bfb4a0ccc8 * Moved the coding conventions from maintainers/docs to the Nixpkgs
manual.
* Removed some out-dated files from maintainers/docs.

svn path=/nixpkgs/trunk/; revision=17419
2009-09-25 14:27:26 +00:00
Eelco Dolstra 24da0cbad8 svn path=/nixpkgs/trunk/; revision=17416 2009-09-25 11:15:50 +00:00
Eelco Dolstra 034248f57a * Document the generic Perl builder.
svn path=/nixpkgs/trunk/; revision=15124
2009-04-18 11:09:24 +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
Eelco Dolstra 649ccdd2db * Moved the Linux kernel maintenance notes to the manual, expanded
them.

svn path=/nixpkgs/trunk/; revision=12739
2008-08-27 12:59:55 +00:00
Eelco Dolstra 418d5e3081 * More stdenv documentation. Some of it has been moved from the Nix
manual.

svn path=/nixpkgs/trunk/; revision=12164
2008-06-19 16:00:37 +00:00
Eelco Dolstra d97069da1a * Quick start section.
* Updated some packages that are referenced in that section.

svn path=/nixpkgs/trunk/; revision=12139
2008-06-17 14:19:59 +00:00
Eelco Dolstra 85a9971e96 * Manual outline.
svn path=/nixpkgs/trunk/; revision=12057
2008-06-12 13:10:11 +00:00