Commit graph

658 commits

Author SHA1 Message Date
Eric Bailey 505508a813 Update BEAM docs
Improve beam docs:
 * correct spelling
 * update per pandoc changes
 * capitalize titles
 * capitalize BEAM throughout and use "the BEAM" when referring to the virtual machine.
 * tweak grammar and phrasing
 * reformat build-tools-rebar3 section
 * add more links
 * re-wrap <para>s

Also update <programlisting>s
* normalize whitespace
* don't double quote homepage
* use $ in all shell snippets
2017-06-22 11:32:46 +02:00
Gleb Peregud 0fccd5bba4 erlang: update documentation.
The documentation got a bit stale compared to actual contents of
nixpkgs. This commit focuses on updating existing docs, not on making
sure all details of beam packages are covered.
2017-06-19 19:58:57 +02:00
Frederik Rietdijk 75933da882 Merge pull request #26345 from vcunat/p/doc-override-phases
nixpkgs manual: advise against overriding whole phases
2017-06-19 09:48:01 +02:00
Thomas Tuegel ce28d8947d
nixpkgs: remark about running Qt applications 2017-06-18 08:44:47 -05:00
Thomas Tuegel f3ce852355
nixpkgs: remove comments from manual about wrapping Qt packages
It is no longer necessary to wrap Qt packages
2017-06-18 08:44:47 -05:00
Joachim F 055be3f684 Merge pull request #25954 from matthewbauer/nixpkgs-emacs-manual
manual: add "Emacs" section to manual
2017-06-15 14:24:37 +01:00
Jan Tojnar e35f3c0679
doc: Fix some typos 2017-06-11 22:13:42 +02:00
Josef Kemetmueller 7116da8018 Python docs: Add example for overlays 2017-06-10 12:18:10 +02:00
Vladimír Čunát 8c6fada372
nixpkgs manual: advise against overriding whole phases
I've seen that mistake at least a few times already, e.g.
https://github.com/NixOS/nixpkgs/pull/26209#issuecomment-305925562
It might perhaps seem counter-intuitive if one doesn't know nixpkgs well.
2017-06-03 11:24:18 +02:00
John Ericson 4e376cce7e Merge pull request #26269 from obsidiansystems/libSystem
lib and doc: Use "libSystem" as identifier for that libc in platforms
2017-05-31 00:49:58 -04:00
John Ericson 9f680d30f4 lib and doc: Use "libSystem" as identifier for that libc in platforms 2017-05-31 00:47:25 -04:00
John Ericson a908ad6fd3 Merge pull request #26037 from obsidiansystems/platform-examples
lib: Consolidate platform configurations (used for crossSystem)
2017-05-29 22:29:15 -04:00
John Ericson 20e756a093 lib: Consolidate platform configurations (used for crossSystem)
This is good for maintenance and education.
2017-05-29 18:56:03 -04:00
Dmitry Vyal 0f86046db5 user-local config.nix path fixed in docs 2017-05-27 13:38:15 +03:00
Matthew Bauer e9e9af4b5c
doc/cross-compilation: change cross to target
thanks to @bjornfor for catching this
2017-05-24 02:02:14 -05:00
Matthew Bauer 11f5136005
doc/cross-compilation: cleanup some grammar
These all should be uncontroversial changes. Just some awkward wording and
double words, etc.
2017-05-23 23:40:37 -05:00
Matthew Bauer 0bbbdfbc52
manual: add "declarative package management" section
This section gives some details on how to setup an "environment"
without having to go through NixOS (although it could be used there
too). I’ve tried to make it straightforward and have a kind of
"tutorial" feel. Not sure if that’s appropriate for the manual, so any
recommended changes would be helpful.
2017-05-20 22:25:05 -05:00
Matthew Bauer 64bddb3f1e
manual: add "Emacs" section to manual
This gives some basics on configuring Emacs within Nix. The
configuration is fairly long just to give a good idea of what’s going
on. I can trim out some of it if it’s not necessary. Note that there
is already a section for Emacs in the NixOS manual. However, this is
aimed at avoiding using modules altogether to make things easier for
non-NixOS users. This configuration should work on NixOS anyway,
however.

Fixes #24243
Fixes #19956
2017-05-20 21:05:16 -05:00
Willi Butz f5e03f3530
manual: fix typo 2017-05-12 13:49:06 +02:00
Frederik Rietdijk ef4442e827 Python: replace requests2 with requests tree-wide
See f63eb58573

The `requests2` attribute now throws an error informing that `requests`
should be used instead.
2017-05-07 12:56:09 +02:00
Alexey Muranov 35c324ee14 doc: enable code syntax highlighting
Use "fenced" code blocks to enable syntax highlighting.  Other markup
and formatting.
2017-04-26 16:59:12 +02:00
Linus Heckemann 5c7f4669a7 nixpkgs manual: Remove obsolete warning (#21117)
PR #815 has already been cherry-picked into the default nix version 1.11.8.
2017-04-23 22:40:35 +02:00
John Ericson b59fdc4289 Merge pull request #25099 from obsidiansystems/cross-lib-foundation
Changes to nixpkgs infra to prepare to better package some pesky cross-compilers

No hashes (native or cross) should be changed
2017-04-23 14:12:42 -04:00
John Ericson 863d79b364 top-level: Introduce targetPackages and a "double link fold"
Each bootstrapping stage ought to just depend on the previous stage, but
poorly-written compilers break this elegence. This provides an easy-enough
way to depend on the next stage: targetPackages. PLEASE DO NOT USE IT
UNLESS YOU MUST!

I'm hoping someday in a pleasant future I can revert this commit :)
2017-04-23 14:01:12 -04:00
Nick Novitski 37b0be688d bundix: 2.0.8 -> 2.1.0 (#25129) 2017-04-23 13:13:50 +01:00
John Ericson 1eabc23961 Merge pull request #24980 from Ericson2314/platform-normalization
Doc for Platform Normalization
2017-04-18 13:34:56 -04:00
John Ericson c13457fe58 doc: Document the structure of {build,host,target}Platforms
Worthwhile to do now that #24610 makes it less abysmal.
2017-04-18 12:48:16 -04:00
Frederik Rietdijk 8d491ec6c6 Python docs: Python 2.x namespace packages may collide when using .withPackages 2017-04-18 09:05:00 +02:00
Jörg Thalheim 10eef8c196
rustup: init at 1.2.0 2017-04-17 15:53:36 +02:00
Carles Pagès cc779bc421 doc: fix overlays paths
It was not updated with 9d6a55aefd.
2017-04-02 10:11:01 +02:00
Jörg Thalheim 36fca93290
rename iana_etc to iana-etc
fixes #23621
2017-03-28 22:35:15 +02:00
Frederik Rietdijk ce6cd33c65 Python docs: small fixes 2017-03-22 12:55:11 +01:00
Joachim Schiele 91debcb482 Update python.md (#23669)
* Update python.md

this makes it clear how to alter `attributes` by using `packageOverrides`

* Update python.md

* Update python.md

* Update python.md

* Update python.md

* Update python.md

* Update python.md
2017-03-21 00:06:51 +01:00
Robin Gloster 72a5cf11cc
doc: remove double space 2017-03-20 20:59:43 +01:00
Robin Gloster 88341c4d2b
Revert "doc: remove double space"
This reverts commit 6393d43380.

Commit added too much changes.
2017-03-20 20:58:18 +01:00
Robin Gloster 6393d43380
doc: remove double space 2017-03-20 20:47:13 +01:00
Matthias Beyer 315e1a23c0 doc: Add rust documentation (#23510) 2017-03-20 20:41:37 +01:00
Bas van Dijk 47b14e0a99 doc/language-frameworks/haskell.md: integer-simple improvements
* Strip the unnecessary 'pkgs' attribute.

* Remove ghc-7.6.3 as a GHC supporting integer-simple.
2017-03-12 23:35:28 +01:00
Alexey Muranov 34afc31c49
doc: fix code highlighting, use valid Nix syntax
Fix code syntax highlighting by specifying language in every code block
and adding some context to Nix code blocks to make them valid
expressions.  Use the same markup style for all code blocks.  Reformat
some code blocks.

fixes #23535
2017-03-06 17:49:07 +01:00
Alexey Muranov 97c9ed0ba1
doc: cleanup whitespace in python.md 2017-03-06 17:48:55 +01:00
Vladimír Čunát a1919db7cd
Merge branch 'master' into staging 2017-02-27 20:15:27 +01:00
Thomas Tuegel c1fc4af9ae
Update Qt and KDE documentation
- Describe the new `libsForQt5.callPackage` interface
- Emphasize that Qt dependencies must be imported unqualified
- Describe the new `kdeWrapper` wrapper generator
2017-02-27 11:49:07 -06:00
Frederik Rietdijk 37704e90e2 Python: explain deterministic build in docs 2017-02-26 14:51:26 +01:00
Vladimír Čunát a50222b1a3
doc/configuration: tidy up text around #23130 changes 2017-02-26 10:32:59 +01:00
Graham Christensen a9c875fc2e
nixpkgs: allow packages to be marked insecure
If a package's meta has `knownVulnerabilities`, like so:

    stdenv.mkDerivation {
      name = "foobar-1.2.3";

      ...

      meta.knownVulnerabilities = [
        "CVE-0000-00000: remote code execution"
        "CVE-0000-00001: local privilege escalation"
      ];
    }

and a user attempts to install the package, they will be greeted with
a warning indicating that maybe they don't want to install it:

    error: Package ‘foobar-1.2.3’ in ‘...default.nix:20’ is marked as insecure, refusing to evaluate.

    Known issues:

     - CVE-0000-00000: remote code execution
     - CVE-0000-00001: local privilege escalation

    You can install it anyway by whitelisting this package, using the
    following methods:

    a) for `nixos-rebuild` you can add ‘foobar-1.2.3’ to
       `nixpkgs.config.permittedInsecurePackages` in the configuration.nix,
       like so:

         {
           nixpkgs.config.permittedInsecurePackages = [
             "foobar-1.2.3"
           ];
         }

    b) For `nix-env`, `nix-build`, `nix-shell` or any other Nix command you can add
    ‘foobar-1.2.3’ to `permittedInsecurePackages` in
    ~/.config/nixpkgs/config.nix, like so:

         {
           permittedInsecurePackages = [
             "foobar-1.2.3"
           ];
         }

Adding either of these configurations will permit this specific
version to be installed. A third option also exists:

  NIXPKGS_ALLOW_INSECURE=1 nix-build ...

though I specifically avoided having a global file-based toggle to
disable this check. This way, users don't disable it once in order to
get a single package, and then don't realize future packages are
insecure.
2017-02-24 07:41:05 -05:00
Frederik Rietdijk 026cfee6b0 Docs: update Python contributing guidelines 2017-02-22 13:38:29 +01:00
Paul Kinsky b14dd0e6c3
wrap added notes in <note> 2017-02-20 22:25:32 -05:00
Paul Kinsky 2d78767973
Add tips for resolving https issues in containers
I ran into some issues making HTTPS requests from a container built with buildImage. I've added notes with tips for resolving similar issues.
2017-02-20 22:24:54 -05:00
Vladimír Čunát 6bea415b5e
Merge branch 'master' into staging 2017-02-09 08:42:04 +01:00
John Ericson 8cd4c31d6b top-level: Allow nixpkgs to take localSystem directly
This is instead of both system and platform, which is kind of ugly.
2017-02-08 22:06:57 -05:00
John Ericson f6ef6b56fe Merge pull request #22387 from Ericson2314/cross-3-platforms
cross stdenv: let build package's build deps resolve to native packages
2017-02-05 17:41:31 -05:00
John Ericson 5eaea6cee0 cross stdenv: let build package's build deps resolve to native packages
This fixes the "sliding window" principle:
  0. Run packages:       build = native;  host = foreign; target = foreign;
  1. Build packages:     build = native;  host = native;  target = foreign;
  2. Vanilla packages:   build = native;  host = native;  target = native;
  3. Vanilla packages:   build = native;  host = native;  target = native;
  n+3. ...

Each stage's build dependencies are resolved against the previous stage,
and the "foreigns" are shifted accordingly. Vanilla packages alone are
built against themsevles, since there are no more "foreign"s to shift away.

Before, build packages' build dependencies were resolved against
themselves:
  0. Run packages:       build = native;  host = foreign; target = foreign;
  1. Build packages:     build = native;  host = native;  target = foreign;
  2. Build packages:     build = native;  host = native;  target = foreign;
  n+2. ...

This is wrong because that principle is violated by the target
platform staying foreign.

This will change the hashes of many build packages and run packages, but
that is OK. This is an unavoidable cost of fixing cross compiling.

The cross compilation docs have been updated to reflect this fix.
2017-02-05 12:01:53 -05:00
Vladimír Čunát 3b583d943e
Merge #19328: mkWrapper fix and docs 2017-02-05 14:09:22 +01:00
Vladimír Čunát adab4cd58b
Merge branch 'master' into staging 2017-02-03 11:47:38 +01:00
Bas van Dijk dfcc9e2994 ghc: support building with integer-simple and provide package sets for it
If the flag enableIntegerSimple is true GHC will be build with the GPL-free but
slower integer-simple library instead of the faster but GPLed integer-gmp
library.

The attribute `pkgs.haskell.compiler.integer-simple."${ghcVersion}"` provides a
GHC compiler build with `integer-simple`.

Similarly, the attribute `pkgs.haskell.packages.integer-simple."${ghcVersion}"`
provides a package set supporting `integer-simple`.

Closes https://github.com/NixOS/nixpkgs/pull/22121.
Closes https://github.com/NixOS/nixpkgs/issues/5493.
2017-02-02 10:57:00 +01:00
Domen Kožar 220adbb039
docs: fix link for python 2017-02-01 21:32:06 +01:00
Eelco Dolstra 9d6a55aefd
~/.nixpkgs -> ~/.config/nixpkgs
The former is still respected as a fallback for config.nix for
backwards compatibility (but not for overlays because they're a new
feature).
2017-02-01 16:07:55 +01:00
Eelco Dolstra 7dacca324d
$NIXPKGS_OVERLAYS -> <nixpkgs-overlays>
The Nix search path is the established mechanism for specifying the
location of Nix expressions, so let's use it instead of adding another
environment variable.
2017-02-01 16:07:54 +01:00
Vladimír Čunát 49b136377a
Merge #16501: add a guide about vim plugins 2017-01-30 18:28:20 +01:00
Vladimír Čunát 69348badb8
doc vim: nitpicks 2017-01-30 18:27:44 +01:00
Lorenzo Manacorda 4e0bb261d0 Make more visible which fetch approach is best
Prepend "bad/better/best" to each paragraph, to make more visible which approach is best
2017-01-30 11:28:52 +01:00
Domen Kožar f87deb0b3a Merge pull request #22101 from zimbatm/no-md5
Bye bye MD5
2017-01-25 09:07:48 +01:00
John Ericson 39fb46f538 nixpkgs docs: Cross compilation docs 2017-01-24 11:37:56 -05:00
John Ericson 76ea89aa78 nixpkgs doc: Talk about nativeBuildInputs and propgatedNativeBuildInputs
Do so in the stdenv section where the other two are discussed. This can be
done without brining up cross-compilation by talking about build-time vs
run-time.
2017-01-24 11:37:56 -05:00
zimbatm 6f21a99bdd doc/old/cross.txt: md5 -> sha256 2017-01-24 16:26:05 +00:00
Franz Pletz 00ab8e84c6
doc: improve hardening docs
Fixes #18887.
2017-01-20 17:46:44 +01:00
Jörg Thalheim 3fdde25b4c Merge pull request #21962 from Mic92/gemdir
bundleEnv: Used gemdir for most applications now
2017-01-19 09:34:14 +01:00
Jörg Thalheim a9495b3066 Merge pull request #21837 from Azulinho/python-docs_add_virtualenv_and_nixshell_example
python docs: add an example for a virtualenv and pip through nix-shell
2017-01-18 08:37:13 +01:00
Jörg Thalheim c9ff7e49a8
docs: gemdir is now preferred attribute for bundlerEnv 2017-01-18 00:52:57 +01:00
Nicolas B. Pierron 88ba960a6d Fix nixpkgs manual generation, missing para closing tag. 2017-01-16 01:17:33 +01:00
Nicolas B. Pierron 2ad710e70e Fix extra nits from aneeshusa 2017-01-16 01:17:33 +01:00
Nicolas B. Pierron 2d6532b330 Update overlay documentation by following nits from aneeshusa. 2017-01-16 01:17:33 +01:00
Nicolas B. Pierron 51d3c931e1 Replace 'phases' by 'layers' in overlays documentation. 2017-01-16 01:17:33 +01:00
Nicolas B. Pierron f9da1fa957 Throw an error if NIXPKGS_OVERLAYS is invalid and improve documentation. 2017-01-16 01:17:33 +01: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
Kier Davis cb4ebb6749
docs: fix a couple of unmatched parentheses 2017-01-12 21:04:20 +00:00
Azul 58613a7eed python docs: update block according to code review 2017-01-12 16:59:27 +00:00
Azul aa9a9dd1b4 python docs: add an example for a virtualenv and pip through nix-shell 2017-01-12 16:00:50 +00:00
Frederik Rietdijk e0d1691ba3 Docs Python: fix examples and links 2016-12-21 15:45:39 +01:00
Matthew Pickering d8d36de635 Fix typo in beam.xml 2016-12-19 14:56:55 +00:00
Marti Serra b8984954ff steam: removed unuseful section from documentation 2016-12-11 16:57:28 +01:00
Marti Serra 21449c23cb steam: added java and steam-run to documentation, removed patchelf info 2016-12-11 12:47:48 +01:00
Jaka Hudoklin f1d93906f8 Merge pull request #21047 from xvapx/fix/steam-doc
steam: added documentation to nixpkgs manual
2016-12-10 23:36:12 +01:00
Marti Serra 2698757095 steam: added documentation to nixpkgs manual 2016-12-10 17:57:33 +01:00
Frederik Rietdijk 42bad32e13 buildPythonPackage: refactor 2016-12-05 10:29:22 +01:00
Frederik Rietdijk 3d59b82925 DOCS: update Python docs to reflect fixed-point combinator 2016-12-05 09:45:11 +01:00
Frederik Rietdijk 374ac13a6e Docs: fix Python docs 2016-12-04 10:17:33 +01:00
Eric Sagnes 2b1d67a275 manual: reviewing contributions nixos -> nixpkgs (#20626) 2016-11-22 15:15:02 +01:00
Profpatsch 53fc7b8272 lib/generators: add manual documentation
Restructures the functions reference a bit.
2016-11-17 23:19:28 +01:00
Peter Simons 0a685cf8ea Merge pull request #20257 from expipiplus1/haskell-doc-typo
fix documentation typo in doc/languages-frameworks/haskell.md
2016-11-09 08:47:07 +01:00
Joe Hermaszewski 05f31e5c8a fix documentation typo in doc/languages-frameworks/haskell.md 2016-11-08 17:42:27 +00:00
Frederik Rietdijk 9cdfb33401 Docs: improve Python expressions
as it contained several mistakes and was just messy.
2016-11-08 12:44:49 +01:00
Domen Kožar 62edf873aa Merge pull request #18660 from aneeshusa/add-override-attrs
mkDerivation: add overrideAttrs function
2016-10-30 11:32:15 +01:00
Joachim Fasting a1ecc5648a
nixpkgs doc: fix build
Ref e4cd45a30c
2016-10-28 16:28:31 +02:00
Charles Strahan ca2b03439f Merge pull request #19496 from Ericson2314/overridePackages
Make `overridePackages` extend rather than replace existing overrides
2016-10-26 14:01:13 -04:00
Frederik Rietdijk e56832d730 Merge remote-tracking branch 'upstream/master' into HEAD 2016-10-22 17:23:24 +02:00
Richard Zetterberg 2206d7afe2 texlive manual: adds import of nixpkgs in nix-repl
I wanted to list the different texlive collections using the nix-repl, as per the [manual](https://nixos.org/nixpkgs/manual/#idm140737316065984). 

It didn't work, since the nixpkgs were not loaded. Doing `:l <nixpkgs>` first resolved the problem.

This change adds the nixpkgs loading step to the manual so that the next inexperienced person don't have to figure out why it didn't work.

I tested this on NixOS unstable (16.09pre90254.6b20d5b) with nix-repl 1.11.3.
2016-10-20 08:50:54 +02:00
Frederik Rietdijk 8fa308126f Python: update docs with change in default interpreter version 2016-10-18 23:16:05 +02:00
Frederik Rietdijk 107c035bf0 Python: remove pythonSmall
In #19309 a separate output for tkinter was added.

Several dependencies of Python depend indirectly on Python. We have the
following two paths:
```
‘python-2.7.12’ - ‘tk-8.6.6’ - ‘libXft-2.3.2’ - ‘libXrender-0.9.10’ -
‘libX11-1.6.4’ - ‘libxcb-1.12’ - ‘libxslt-1.1.29’- ‘libxml2-2.9.4’ -
‘python-2.7.12’

‘python-2.7.12’ - ‘tk-8.6.6’ - ‘libXft-2.3.2’ - ‘fontconfig-2.12.1’ -
‘dejavu-fonts-2.37’ - ‘fontforge-20160404’ - ‘python-2.7.12’
```
Because only `tkinter` needs this, I added
```
pythonSmall = python.override {x11Support = false;};
```
to break the infinite recursion. We also still have the output
`tkinter`.

However, we might as well build without x11Support by default. Then we build with x11Support as well so we get the tkinter module and put that in a separate package.
2016-10-16 14:31:26 +02:00
John Ericson e4cd45a30c top-level: Make overridePackages extend rather than replace existing overrides 2016-10-13 11:14:11 -04:00
Frederik Rietdijk cffdffe1f6 Merge pull request #19309 from FRidh/outputs
Python: use separate output for tkinter
2016-10-13 10:40:14 +02:00
Frederik Rietdijk 1e544b2993 pythonPackages.tkinter: use this instead of the output python.tkinter 2016-10-13 10:38:21 +02:00
Profpatsch bef6bef0d2
stdenv/stripHash: print to stdout, not to variable
`stripHash` documentation states that it prints out the stripped name to
the stdout, but the function stored the value in `strippedName`
instead.

Basically all usages did something like
`$(stripHash $foo | echo $strippedName)` which is just braindamaged.
Fixed the implementation and all invocations.
2016-10-11 18:34:36 +02:00
Frederik Rietdijk d3766b2601 Python: update docs separate output tkinter 2016-10-10 10:33:24 +02:00
Profpatsch dd58d24fa6 stdenv: document makeWrapper
Add function documentation to `makeWrapper`.
Also add user documentation to the nixpkgs manual.
2016-10-08 23:36:40 +02:00
Michael Raskin d233366856 manual: switch an example from md5 to sha256. 2016-10-07 10:08:22 +02:00
Thomas Tuegel d067b7bd35
Merge branch 'kde-5' into staging 2016-10-04 21:50:17 -05:00
Eelco Dolstra ebdd896017 Nixpkgs manual: Fix epub generation
See 0804f67024.
2016-10-03 20:33:01 +02:00
Aneesh Agrawal 39b64b52ed mkDerivation: add overrideAttrs function
This is similar to `overrideDerivation`, but overrides the arguments to
`mkDerivation` instead of the underlying `derivation` call.

Also update `makeOverridable` so that uses of `overrideAttrs` can be
followed by `override` and `overrideDerivation`, i.e. they can be
mix-and-matched.
2016-10-02 11:08:34 -04:00
Vladimír Čunát 77604964b6 Merge branch 'master' into staging 2016-09-28 17:13:59 +02:00
Eric Sagnes 41d62fdea8 nixpkgs doc: add installCheck phase 2016-09-28 16:31:46 +09:00
Vladimír Čunát fffc7638cd Merge branch 'master' into staging 2016-09-24 18:54:31 +02:00
Luca Bruno da514a2cf9 Merge pull request #18798 from siddharthist/doc/node-readme
manual: add node.js to languages & frameworks
2016-09-22 22:12:37 +01:00
Langston Barrett a3bbb45e5c manual: add node to languages & frameworks
fixes #18609
2016-09-20 20:38:24 +00:00
Eelco Dolstra 5f8a330d40 outputDocdev -> outputDevdoc
For consistency with the devdoc output.
2016-09-20 17:44:48 +02:00
Eelco Dolstra 594c47e5eb Don't nuke section 3 manpages by default
They now go to devman, devdoc, or $outputMan, in that order. This is
to prevent cases such as the man-pages package quietly losing its
section 3 pages.
2016-09-20 17:42:43 +02:00
Kamil Chmielewski 914e0e594c buildGoPackage: deps.json -> deps.nix in NIXON
https://github.com/NixOS/nixpkgs/pull/17254#issuecomment-245295541

* update docs to describe `deps.nix`
* include goDeps in nix-shell GOPATH
* NixOS 16.09 rel notes about replacing goPackages
2016-09-16 00:04:55 +01:00
Mathieu Boespflug db481dca31 doc/language-frameworks/haskell.md: typo in code example. (#18313) 2016-09-05 13:27:00 +02:00
Robert Helgesson 86af88d7c4
perl docs: update generated expression
This provides an up-to-date illustration of how `nix-generate-from-cpan`
generates packages.
2016-09-03 18:14:06 +02:00
Tuomas Tynkkynen e2c6740c37 Merge commit 'adaee73' from staging into master
This one was already merged into release-16.09, so let's not have the
stable branch is ahead of master and confuse things. In addition to
that, currently we have an odd situation that master has less things
actually finished building than in staging.

Conflicts:
	pkgs/data/documentation/man-pages/default.nix
2016-09-03 01:02:51 +03:00
Frederik Rietdijk 4f6b6f1472 pythonPackages: use mkPythonDerivation 2016-09-01 16:16:31 +02:00
Frederik Rietdijk 3e05cce97c Python: separate buildPythonPackage into two functions
1. mkDerivation which is used when the source is without setup.py and
not a wheel
2. buildPythonPackage which is used as before and calls mkDerivation
2016-09-01 16:16:31 +02:00
Frederik Rietdijk b080748d42 Python: move python-modules/generic to interpreter folder 2016-09-01 16:16:31 +02:00
Tuomas Tynkkynen 8c4aeb1780 Merge staging into master
Brings in:
    - changed output order for multiple outputs:
      https://github.com/NixOS/nixpkgs/pull/14766
    - audit disabled by default
      https://github.com/NixOS/nixpkgs/pull/17916

 Conflicts:
	pkgs/development/libraries/openldap/default.nix
2016-09-01 13:27:27 +03:00
Eelco Dolstra 8172cd734c docdev -> devdoc
It's "developer documentation", not "documentation developer" after
all.
2016-09-01 11:07:23 +02:00
Domen Kožar da421bc75f Fix #4210: Remove builderDefs
This was one of the ways to build packages, we are trying
hard to minimize different ways so it's easier for newcomers
to learn only one way.

This also:

- removes texLive (old), fixes #14807
- removed upstream-updater, if that code is still used it should be in
  separate repo
- changes a few packages like gitit/mit-scheme to use new texlive
2016-08-31 11:34:46 +02:00
Domen Kožar 7b3a36132a Merge pull request #9607 from nckx/update-doc
doc: specify that *Flags are string lists
2016-08-31 10:02:16 +02:00
Frederik Rietdijk 850e6287c5 Doc: improve python bdist_wheel fix 2016-08-30 17:16:49 +02:00
Frederik Rietdijk 95021f061a Doc: fix python override examples 2016-08-30 17:06:44 +02:00
Tuomas Tynkkynen 03fb2c1f32 doc: Document changes to multiple-output conventions 2016-08-30 04:46:59 +03:00
obadz 0e8d2725dc Merge branch 'master' into staging 2016-08-23 18:50:06 +01:00
Tuomas Tynkkynen 4bd0a16148 haskell docs: Fix output reference in example 2016-08-23 04:32:21 +03:00
Tuomas Tynkkynen 9551d400b2 python manual: Fix 'fftw*' output references in example 2016-08-23 03:20:21 +03:00
obadz 24a9183f90 Merge branch 'hardened-stdenv' into staging
Closes #12895

Amazing work by @globin & @fpletz getting hardened compiler flags by
enabled default on the whole package set
2016-08-22 01:19:35 +01:00
Nikolay Amiantov 01624e1ac2 wrapPythonProgram: use site.addsitedir instead of PYTHONPATH 2016-08-20 00:42:49 +03:00
Peter Simons 36f2dc5649 Merge pull request #17549 from ericsagnes/nixpkgs-doc/patches
nixpkgs-doc: add patches to coding conventions
2016-08-19 11:08:53 +02:00
Robin Gloster 33e1c78ae3 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-08-16 07:54:01 +00:00
Frederik Rietdijk 888efed972 Doc: fix python examples 2016-08-16 09:47:13 +02:00
Franz Pletz bd4490e277 Merge branch 'master' into hardened-stdenv 2016-08-13 16:59:55 +02:00
Frederik Rietdijk 6f1551d597 Doc: how to create a Python wheel 2016-08-13 14:19:33 +02:00
Robin Gloster af04b6d5a5 hardening docs: fix typo 2016-08-13 10:06:24 +00:00
Franz Pletz 55966c2189 doc: complete the hardening documentation 2016-08-12 18:14:02 +02:00
Kamil Chmielewski da3ddd48e4 buildGoPackage: remove Go deps file libs.json
After #16017 there were a lot
of comments saying that `nix` would be better than `JSON`
for Go packages dependency sets.
As said in https://github.com/NixOS/nixpkgs/pull/16017#issuecomment-229624046

    > Because of the content-addressable store, if two programs have the
    > same dependency it will already result in the same derivation in
    > the
    > store. Git also has compression in the pack files so it won't make
    > much difference to duplicate the dependencies on disk. And finally
    > most users will just use the binary builds so it won't make any
    > differences to them.

This PR removes `libs.json` file and puts all package dependencies in
theirs `deps.json`.
2016-08-11 23:07:09 +02:00
Eric Sagnes b1abc2c8d6 nixpkgs-doc: add patches to coding conventions 2016-08-06 09:05:23 +09:00
Robin Gloster 63c7b4f9a7 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-07-31 20:51:34 +00:00
Frederik Rietdijk 25980ed01e DOC: unstable packages names should append -unstable, not -git or -svn 2016-07-29 08:53:24 +02:00
Robin Gloster f222d98746 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-07-25 12:47:13 +00:00
Joachim Fasting c6ccc96397
nixpkgs manual: document the paxctl setup-hook 2016-07-23 19:09:48 +02:00
Robin Gloster 1f04b4a566 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-07-21 00:56:43 +00:00
Christine Koppelt 27e72d14af add epub for nixpkgs manual ( #15575 ) (#17053)
* add epub for nixpkgs manual ( #15575 )

* change epub filename (interpreted as title & author by some epub readers)
2016-07-20 17:57:31 +02:00
Robin Gloster 5185bc1773 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-07-15 14:41:01 +00:00
Alex Berg b5a95b1812 Improve overrideDerivation docs. (#16867)
* Improve overrideDerivation docs.

Explain how antiquotation in a package's attribute behaves when overriding the package.

* Edit antiquotation note. Fix closing-element.
2016-07-12 09:57:26 +02:00
Frederik Rietdijk 1c0af40757 Doc: how to install a Python environment
See https://github.com/NixOS/nixpkgs/issues/10597.
2016-07-01 14:30:18 +02:00
Marc Weber c3f56e912a Add nixpkgs documentation about how to create a derivation with Vim + plugins 2016-06-25 21:39:00 +02:00
zimbatm 4f5918cd2e Revert "stdenv: introduce baseHash() to replace stripHash()"
Introduced by mistake

This reverts commit e71a5cb878.
2016-06-25 14:25:58 +01:00
zimbatm e71a5cb878 stdenv: introduce baseHash() to replace stripHash()
stripHash uses a global variable to communicate it's computation
results, but it's not necessary. You can just pipe to stdout in a
subshell. A function mostly behaves like just another command.

baseHash() also introduces a suffix-stripping capability since it's
something the users of the function tend to use.
2016-06-25 14:20:56 +01:00
zimbatm 7473e4f2b4 Merge pull request #16398 from tboettch/master
doc: Update stripHash documentation
2016-06-23 11:30:07 +01:00
John Ericson f073df60d6 Replace ./../* with ../* in Nix expressions (#16414) 2016-06-22 10:39:50 +02:00
Tom Boettcher a1083a5d27 doc: Update stripHash documentation
The documentation now matches the behavior of the function.
2016-06-21 09:38:11 -05:00
michael bishop 410aad942f
haskell docs: now that hydra pushes directly to S3, it cant function as a binary cache 2016-06-18 21:14:33 -03:00
Domen Kožar 3ea8068181 buildPythonPackage: be able to disable package conflict check 2016-06-16 11:49:19 +01:00
Mathieu Boespflug 3adf86eed6 doc(haskell): Remove pesky tabs in code snippets. 2016-06-13 11:42:50 +02:00
Mathieu Boespflug e6aa4e0ccb doc: Document how to set custom GHC version in haskell.lib.buildStackProject. 2016-06-13 00:55:33 +02:00
Rushmore Mushambi 1965bd56e6 Merge pull request #16146 from kamilchm/rework-go
all-packages references to Go packages includes all outputs
2016-06-11 19:24:35 +02:00
Nikolay Amiantov b341de88e9 Merge pull request #16030 from abbradar/fhs-refactor
Improvements for FHS user chrootenv
2016-06-11 21:04:20 +04:00
Kamil Chmielewski 7d02cc1dd5 all-packages references to Go packages includes all outputs 2016-06-11 18:57:29 +02:00
Kamil Chmielewski 14d49ddc40 buildGoPackage: updated docs for goPackages after rework in https://github.com/NixOS/nixpkgs/pull/16017 2016-06-10 20:31:20 +02:00
Nikolay Amiantov 75ea0523c4 doc: update buildFHSUserEnv documentation 2016-06-09 18:20:56 +03:00
Robin Gloster 2d382f3d98 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-05-30 19:39:34 +00:00
Ryan Mulligan 6b2b2e5b1c fix link formatting 2016-05-30 09:25:32 -07:00
Domen Kožar dee13c7fd4 doc: mention overrideDerivation causes evaluation of Derivation 2016-05-30 12:34:03 +01:00
Frederik Rietdijk fa4701e4e8 Merge pull request #15804 from NixOS/python-with-packages
python: add python.withPackages function
2016-05-30 11:39:14 +02:00
Benno Fünfstück 5e0acb90d6 doc/python: fix conversion errors in example code 2016-05-29 16:44:54 +02:00
Benno Fünfstück bad156a0d5 doc/python: replace buildEnv usage by withPackages 2016-05-29 16:30:29 +02:00
Benno Fünfstück 3bdf167619 doc/python: document python.withPackages 2016-05-29 16:08:27 +02:00
Vladimír Čunát 88a6ce17ef nixpkgs manual: fix #15735: correct dash rendering 2016-05-27 10:40:49 +02:00
Théo Zimmermann 24b715d16d nixpkgs manual: more extensible example (#15557)
By checking if the package name appears in a list, this new example allows for easy user-customization.
2016-05-23 11:02:46 +01:00
Domen Kožar 7d8a7be241 manual: revert title change to keep the link working 2016-05-22 11:31:08 +01:00
Eric Sagnes 96a4e1f80d nixpkgs manual: cleanup (#15611) 2016-05-22 10:05:37 +01:00
Franz Pletz f8d481754c
Merge remote-tracking branch 'origin/master' into hardened-stdenv 2016-05-18 17:10:02 +02:00
zimbatm 428db7857e Merge pull request #15010 from FRidh/format
Python: support installing wheels
2016-05-09 14:39:41 +01:00
Frederik Rietdijk 303e976245 Python: allow installing wheels
By passing `format="wheel"` it is now possible to install a wheel.
It's not recommended, but it can be useful.
2016-05-09 13:17:42 +02:00
Profpatsch c6cfa7a412 manual/substituteAll: document filtered variables
Some variables are filtered out as of #14907.
2016-05-07 13:10:09 +02:00
zimbatm fc0831500f autojump: add package note 2016-05-04 20:31:38 +01:00
Robin Gloster c92bca56f8 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-05-02 22:58:02 +00:00
Frederik Rietdijk d5e6a4494a Python: use PyPI mirror (#15001)
* mirrors: add pypi

* Python: Use pypi mirror for all PyPI packages
2016-04-26 13:38:03 +01:00
Joachim Fasting 2dbfe512db Merge pull request #14858 from ericbmerritt/elixir-support
Elixir support
2016-04-25 23:04:14 +02:00
Eric Merritt be5da0449e beam-support: update registry to latest '59b836d' 2016-04-23 19:03:28 -07:00
Chris Martin d24523cc13 nixpkgs manual: fix link to go2nix 2016-04-22 14:51:49 -07:00
Robin Gloster d020caa5b2 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-04-18 13:49:22 +00:00
Vladimír Čunát 39ebb01d6e Merge branch 'staging', containing closure-size #7701 2016-04-13 09:25:28 +02:00
obadz 7f2163fc97 haskellPackages.haste-compiler: fix so that it now builds and runs
Required adding:
haskellPackages.haste-Cabal, and
haskellPackages.haste-cabal-install
2016-04-11 15:24:56 +01:00
Vladimír Čunát 30f14243c3 Merge branch 'master' into closure-size
Comparison to master evaluations on Hydra:
  - 1255515 for nixos
  - 1255502 for nixpkgs
2016-04-10 11:17:52 +02:00
Vladimír Čunát 60fa61c830 manual multiple-output: clarify a note 2016-04-09 23:29:23 +02:00
Robin Gloster 3e68106afd Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-04-07 21:52:26 +00:00
Vladimír Čunát c73191f11e nixpkgs manual: add multiple-output chapter 2016-04-07 16:00:41 +02:00
Robin Gloster a73a28de7b fix grammar errors 2016-04-06 16:16:23 +00:00
Vladimír Čunát 2bbae9696a nixpkgs manual introduction: improve
- make line wrapping more consistent (overlong lines)
- don't stress the manual is *only* for contributors,
  as it does contain some user-guide parts, including the intro itself
- since March our Hydra publishes binaries immediately,
  not waiting for channel update
2016-04-05 10:06:10 +02:00
Franz Pletz 2e08d8234e Merge remote-tracking branch 'origin/master' 2016-03-31 10:06:30 +02:00
Domen Kožar ccdda96c2f manual: use a better relaxng validation tool #4966 2016-03-30 18:07:34 +01:00
Robin Gloster a4e65c3639 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-03-30 09:01:20 +00:00
Frederik Rietdijk df79303703 Merge pull request #13700 from FRidh/python-docs
Documentation: rewrite Python
2016-03-30 08:35:23 +02:00
Vladimír Čunát b44b0ab27c nixpkgs manual: remove cruft from a merge conflict
It was clearly added unintentionally during #14243 merge.
2016-03-29 10:02:57 +02:00
Robin Gloster f60c9df0ba Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-03-28 15:16:29 +00:00
Rodney Lorrimar 123da5c1c1 nixpkgs manual: Add documentation for bower2nix
Fixes #9459
Fixes #13214
2016-03-28 08:25:45 +01:00
Vladimír Čunát e3da83297f texlive: document in nixpkgs manual
Fixes #13240. It's not really better than source-code comments it replaced,
but it's in a better accessible place.
2016-03-27 14:29:18 +02:00
Vladimír Čunát c86a8fc19f doc: remove comments that are no longer relevant 2016-03-27 14:29:18 +02:00
Vladimír Čunát b405e82edb ruby docs: improve the example
- missing cd command
- invoke bundler through nix-shell, so it doesn't need to be on $PATH
  Note: running bundix through nix-shell won't work ATM, as the shell sets
  SSL_CERT_FILE=/no-cert-file.crt which prevents fetching throug https.
- use version from gemset to simplify updating
- don't break line in meta.description
2016-03-20 13:33:20 +01:00
Joachim Fasting 49dc7e2d61 manual: fix meta.description in ruby example expression
Noted by @namore on github
2016-03-18 17:27:15 +01:00
Frederik Rietdijk 0ed331cf09 Documentation: fix usage of useChapters 2016-03-12 15:44:02 -05:00
Frederik Rietdijk 4c1525c1f8 Documentation: rewrite Python
- Rewrite current documentation
- Add introduction/tutorial
- Convert to markdown
2016-03-12 15:44:02 -05:00
Frederik Rietdijk 9310bd15de Revert "Documentation: rewrite Python docs" 2016-03-05 18:01:23 -05:00
Frederik Rietdijk 6af076730e Documentation: rewrite Python
- Rewrite current documentation
- Add introduction/tutorial
- Convert to markdown
2016-03-05 17:57:38 -05:00
Franz Pletz cb3d27df93 Merge remote-tracking branch 'origin/master' into hardened-stdenv 2016-03-05 18:55:30 +01:00
Mathieu Boespflug 7fedb7c992 Move buildStackProject to haskell.lib. 2016-03-04 21:24:42 +01:00
Mathieu Boespflug 6f09628c32 haskell: tell users to use Stack's nix support when missing system library. 2016-03-04 21:18:14 +01:00
Mathieu Boespflug 01f384b8b4 haskell: Add documentation for haskell.buildStackProject to user guide.
This section documents introduces Stack's primitive Nix support as well.
2016-03-04 21:18:14 +01:00
Robin Gloster 3477e662e6 Merge remote-tracking branch 'upstream/master' into hardened-stdenv 2016-02-27 00:08:08 +00:00
Franz Pletz 7f7ebe5bf6 nixpkgs manual: Fix license strings docs
The wrong usage of unfree-redistributable fixed in
ea242619fb 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
Michel Kuhlmann 312494180d nixpkgs manual: add basic R documentation, fixes #13362
also fixes #13243
2016-02-22 10:16:06 +01:00
Robin Gloster bb2639aafc Merge branch 'curl-7.15-fixup' of https://github.com/zimbatm/nixpkgs into hardened-stdenv 2016-02-22 01:14:22 +00:00
Robin Gloster fda63b8b57 nixpkgs docs: stackprotector hardening 2016-02-22 00:33:01 +00:00
Robin Gloster 911d22f88d nixpkgs docs: format hardening 2016-02-22 00:23:15 +00:00
Frederik Rietdijk 92179785b6 DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263)
What I missed when I began using Nix and NixOS was a clear overview of
how packages, channels, Hydra, the master branch and updates to channels
relate to each other.

I've noticed I am not the only one, given the amount of times these
questions pop up.

For now I propose to include this in the Nixpkgs manual, since this
seems to be the best fit. However, I think it would be good to include
this in either a new manual, i.e., a user manual, or an 'official'
tutorial.
2016-02-21 11:32:22 +01:00
Vladimír Čunát b8c489e781 Merge branch 'staging'
It seemed very fine on Hydra before it was cancelled due to glibc rebuild,
in particular the nixpkgs unstable job succeeded except for
bootstrap-tarball tests which should be fine after ee994dfae6.

Therefore, let's avoid another mass rebuild by merging now when we don't
have binaries for master anyway.
2016-02-17 10:54:26 +01:00
Vladimír Čunát 4ca2332bac nixpkgs manual: fix typo in filename 2016-02-17 10:52:42 +01:00
Vladimír Čunát e9520e81b3 Merge branch 'master' into staging 2016-02-17 10:06:31 +01:00
John Ericson e756536392 doc: Fix URL to ghc-paths patch 2016-02-13 17:13:33 -08:00
Vladimír Čunát de0af30716 Merge branch 'master' into staging 2016-01-29 10:19:48 +01:00
Arthur Noel 903129f770 dockerTools: private registry support
* authorization token is optional
* registry url is taken from X-Docker-Endpoints header
* pull.sh correctly resumes partial layer downloads
* detjson.py does not fail on missing keys
2016-01-27 21:13:07 +00:00
Vladimír Čunát 2af19df364 Merge branch 'master' into staging 2016-01-25 10:02:25 +01:00
Benjamin Staffin 420bb27a7b docs: Mention autoreconfHook in Package Setup Hooks 2016-01-23 18:19:23 -05:00
Nikolay Amiantov dc162f648c Merge pull request #12284 from abbradar/bundlerenv-wrapper
bundlerEnv: add wrapper
2016-01-23 12:02:09 +03:00
Nikolay Amiantov 9c1d8037c0 nixpkgs manual: add a section about passthru 2016-01-21 19:47:53 +03:00
Nikolay Amiantov f727f815cb nixpkgs manual: mention preferLocalBuild and enableParallelBuilding 2016-01-21 18:44:27 +03:00
Nikolay Amiantov a98dfaa6b9 nix manual: add bundlerEnv.env and .wrapper items descriptions 2016-01-21 13:10:09 +03:00
Eric Merritt 8021b5241c rebar3: refactor to make hermetic
This adds changes to the rebar3 expression that patch rebar3 to force it
to be hermetic. Now, by default, rebar3 literally can't download
anything. A 'rebar3-open' expression was added for those folks whe want
the normal rebar3.
2016-01-18 08:19:15 -08: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
Luca Bruno 4a4561ce24 dockerTools: nix functions for manipulating docker images 2016-01-13 10:27:37 +01:00
Kranium Gikos Mendoza 762d55211a docs: kernelPackagesFor -> linuxPackagesFor 2016-01-09 06:02:00 +08: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 e39b1f4ec8.
2016-01-05 12:36:33 +01:00
Vladimír Čunát 3e4035695c nixpkgs manual: add idris docs generated from *.md
I also modified the nesting approach in haskell docs
to allow more uniform handling of markdown -> docbook conversions.
/cc #11308.
2015-12-21 13:01:59 +01: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
aszlig 4ba31045e4 nixpkgs manual: more strict commit policy (close #11609) 2015-12-18 15:00:33 +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
Eelco Dolstra 6bd0519918 Manual: Fix indent of config section 2015-12-10 16:06:12 +01:00
Eelco Dolstra e115e3fd76 Manual: Rename file 2015-12-10 16:06:12 +01:00
Matthias C. M. Troffaes e6046739cd doc/submitting-changes: mention master -> staging merge (see issue #11460) 2015-12-07 08:49:04 +00:00
Eelco Dolstra f7c25bf9c2 Manual: Add a warning that overrideDerivation should not be used 2015-12-02 13:54:24 +01:00
Pascal Wittmann 56d3457c2f doc: --meta is not needed in the presence of --json 2015-11-29 21:51:22 +01:00