Commit graph

1312 commits

Author SHA1 Message Date
Katharina Fey e72ec381b2
ociTools: fixing outdated documentation 2019-09-09 08:05:33 +01:00
Frederik Rietdijk f7e28bf5d8 Split buildPythonPackage into setup hooks
This commit splits the `buildPythonPackage` into multiple setup hooks.

Generally, Python packages are built from source to wheels using `setuptools`.
The wheels are then installed with `pip`. Tests were often called with
`python setup.py test` but this is less common nowadays. Most projects
now use a different entry point for running tests, typically `pytest`
or `nosetests`.

Since the wheel format was introduced more tools were built to generate these,
e.g. `flit`. Since PEP 517 is provisionally accepted, defining a build-system
independent format (`pyproject.toml`), `pip` can now use that format to
execute the correct build-system.

In the past I've added support for PEP 517 (`pyproject`) to the Python
builder, resulting in a now rather large builder. Furthermore, it was not possible
to reuse components elsewhere. Therefore, the builder is now split into multiple
setup hooks.

The `setuptoolsCheckHook` is included now by default but in time it should
be removed from `buildPythonPackage` to make it easier to use another hook
(curently one has to pass in `dontUseSetuptoolsCheck`).
2019-09-06 15:18:45 +02:00
worldofpeace 463377597b
doc/gnome: explain glib passthru functions
Examples are updated to commits that use them as well.
2019-09-06 06:29:35 +02:00
worldofpeace 69e0d95462
doc/gnome: explain double wrapped binaries 2019-09-06 06:27:56 +02:00
Jan Tojnar 075b528a6d
doc: add GNOME
Closes: #16285
2019-09-06 06:27:55 +02:00
Jan Tojnar cdf426488b
Merge branch 'master' into staging-next
Fixed trivial conflicts caused by removing rec.
2019-09-06 03:20:09 +02:00
Katharina Fey 18f7f19ce2 ociTools: init 2019-09-04 22:46:42 +00:00
Lily Ballard 43dade238f
installShellFiles: init (#65211)
This is a new package that provides a shell hook to make it easy to
declare manpages and shell completions in a manner that doesn't require
remembering where to actually install them. Basic usage looks like

  { stdenv, installShellFiles, ... }:
  stdenv.mkDerivation {
    # ...
    nativeBuildInputs = [ installShellFiles ];
    postInstall = ''
      installManPage doc/foobar.1
      installShellCompletion --bash share/completions/foobar.bash
      installShellCompletion --fish share/completions/foobar.fish
      installShellCompletion --zsh share/completions/_foobar
    '';
    # ...
  }

See source comments for more details on the functions.
2019-09-04 23:19:17 +02:00
Vladimír Čunát 4aad2947f8
Merge branch 'master' into staging-next 2019-09-04 11:00:56 +02:00
Michael Fellinger 1f49035aca ruby.withPackages: init
Co-authored-by: Alyssa Ross <hi@alyssa.is>
2019-09-03 19:44:49 +00:00
Frederik Rietdijk ad1d58c622 Merge staging-next into staging 2019-08-31 10:04:20 +02:00
adisbladis 41d1b8fa88
emacsPackages: Drop old emacsPackages (non-NG) sets
These have been deprecated for a long time now and has not seen much maintenance.
2019-08-30 16:43:16 +01:00
Frederik Rietdijk 5061fe0c2c Merge staging-next into staging 2019-08-28 08:26:42 +02:00
volth 35d68ef143 treewide: remove redundant quotes 2019-08-26 21:40:19 +00:00
Silvan Mosberger 1d0749139d
docs: Add Crystal language framework section 2019-08-26 20:12:15 +02:00
Matthew Bauer 5be571eea1
Merge pull request #66747 from erikarvstedt/androidenv-fixes
Androidenv fixes
2019-08-20 13:38:01 -04:00
Benjamin Esham 3a9b0bd634 add shortenPerlShebang function
This setup hook modifies a Perl script so that any "-I" flags in its shebang
line are rewritten into a "use lib ..." statement on the next line. This gets
around a limitation in Darwin, which will not properly handle a script whose
shebang line exceeds 511 characters.
2019-08-18 16:22:23 -07:00
Silvan Mosberger 0cc8dfca43 doc: Replace google groups reference with Discourse Patch category 2019-08-17 12:43:30 +02:00
Erik Arvstedt 4daca65fe3
manual/android: add Play Store to emulator example
This system type was previously broken but is now fixed.
Add it here to showcase the common task of launching a fully-fledged Android
system with an included app store.
2019-08-17 11:19:05 +02:00
Graham Christensen ee30e62e34
Merge pull request #66543 from grahamc/dt
dockerTools: document extraCommands, increase layers
2019-08-15 09:47:32 -04:00
Graham Christensen abf82a18fb
doc/functions/dockertools.xml: clarify that "Commands" means shell commands
Co-Authored-By: Jon <jonringer@users.noreply.github.com>
2019-08-15 09:47:05 -04:00
Graham Christensen 8adaae2df2
dockertools.buildLayeredImage: default layer count up to 100 2019-08-12 19:59:40 -04:00
Graham Christensen 2e6a16f2bd
dockerTools: document extraCommands 2019-08-12 19:56:57 -04:00
Herwig Hochleitner 47824cdf4d stdenv: document dontFixup 2019-08-12 02:52:31 +02:00
worldofpeace d106395171 doc/qt: add note about wrapQtAppsHook ignoring scripts 2019-08-09 10:11:48 -04:00
Silvan Mosberger dd7de2d096
add options for build idris package (#65666)
add options for build idris package
2019-08-07 13:37:36 +02:00
Marco Perone 349a843ef4 build-idris-package: add documentation on idris commands options 2019-08-06 09:11:37 +02:00
Michael Raskin 66644848cb
Merge pull request #64753 from malob/update-add-vim-plugin-docs
Updating documentation about adding new Vim plugins
2019-08-02 21:25:16 +00:00
Frederik Rietdijk c40307b8c9 doc: fix phases to include installCheckPhase 2019-07-28 12:08:39 +02:00
Frederik Rietdijk 34eebf6844 Merge master into staging-next 2019-07-25 11:52:18 +02:00
Maximilian Bosch 0a571ae256 citrix_workspace: add 1906 (citrix_workspace_19_6_0)
New release available:
https://www.citrix.com/downloads/workspace-app/linux/workspace-app-for-linux-latest.html

Apart from the new version the following things changed:

* Updated the docs as all notes about `citrix_receiver` also apply for
  `citrix_workspace`. Also added a deprecation warning about the
  upcoming removal.

* Removed the `libidn_134` override as neither `citrix_workspace_19_3_0`
  nor `citrix_workspace_19_6_0` require this library anymore according
  to `readelf -d ./result/opt/citrix-icaclient/wfica` (in contrast to
  `citrix_receiver_13_10_0`).

* Added myself as maintainer as well.
2019-07-24 13:06:19 +02:00
Frederik Rietdijk db6c38a075 Merge master into staging-next 2019-07-22 14:15:32 +02:00
Raphael Borun Das Gupta b6a25f2de4 doc: put Java software's build-time dependencies into nativeBuildInputs
instead of into buildInputs
2019-07-20 11:37:49 +02:00
Frederik Rietdijk 7da15d9b36 buildPythonPackage: add support for setupPyGlobalFlags (2) 2019-07-15 17:47:57 +02:00
Malo Bourgon 2b6012ac39 Cleanup formatting in Vim plugin docs 2019-07-14 17:13:34 -07:00
Malo Bourgon 5d69e5f84b Update documentation about adding new Vim plugins to nixpkgs 2019-07-14 17:13:29 -07:00
Frederik Rietdijk 271b57c219 Revert "buildPythonPackage: add support for setupPyDistFlags"
I merged this a bit too quick. We need to have a closer look at it.
See the points brought up in https://github.com/NixOS/nixpkgs/pull/64682.

This reverts commit 1e0ebdb8a4.
2019-07-13 13:25:32 +02:00
Kirill Boltaev 1e0ebdb8a4 buildPythonPackage: add support for setupPyDistFlags
Flags passed to the "python setup.py" command.
2019-07-13 09:47:00 +02:00
Frederik Rietdijk 54065ae20d Merge master into staging-next 2019-07-13 09:45:40 +02:00
Georges Dubus ab3e932325 doc: fix stdenv.xml
A duplicated opening tag caused the linter to fail, blocking the whole
nixpkgs-unstable channel.
2019-07-11 13:46:53 +02:00
Frederik Rietdijk 22cb7f25f2 Merge master into staging-next 2019-07-11 09:40:10 +02:00
Graham Christensen dc336293a1
doc: fix after snaptools merge 2019-07-10 08:02:14 -07:00
Frederik Rietdijk 79a03641d5 Merge staging-next into staging 2019-07-09 15:46:26 +02:00
Frederik Rietdijk 74c24385cb Merge master into staging-next 2019-07-09 15:46:00 +02:00
Frederik Rietdijk 7cf5909fad Merge staging-next into staging 2019-07-09 15:44:08 +02:00
Graham Christensen 39a5867b3f
Merge pull request #63457 from grahamc/snap
snapTools.makeSnap: init
2019-07-07 08:15:08 -04:00
Vladimír Čunát 0746c4dbb4
Merge branch 'master' into staging-next
There are several thousand rebuilds from master already.
Hydra nixpkgs: ?compare=1528940
2019-07-06 13:44:40 +02:00
Thomas Tuegel 56d5963382
Merge pull request #54525 from ttuegel/feature/qt-5/wrap-qt-apps
Wrap Qt applications
2019-07-05 14:38:10 -05:00
Graham Christensen e9451ebc9b
Merge pull request #64301 from grahamc/docs/clean-build
Docs/clean build
2019-07-05 14:32:43 -04:00
Thomas Tuegel 3adc9d0487
doc/languages-frameworks/qt.xml: Update for wrapQtAppsHook 2019-07-05 10:42:24 -05:00
Frederik Rietdijk f1ff85e61d Docs Python: fix example on how to override the package set
Not passing in the newly created interpreter as `self` results in an
incorrect `passthru`. Solves #64334.
2019-07-05 13:56:03 +02:00
Graham Christensen fa47df6174
doc: move parameters to an XML file 2019-07-04 09:16:06 -04:00
Graham Christensen 5a0696f6d0
xmlformat.conf: move to doc-support build 2019-07-04 09:10:14 -04:00
Graham Christensen de58e706f9
docs: Get highlightjs from build symlink 2019-07-04 09:10:14 -04:00
Graham Christensen 35262ba6a7
docs: get XSL from build / symlink 2019-07-04 09:10:13 -04:00
Graham Christensen e65c2c6672
docs: find docbook rng from doc-support 2019-07-04 09:10:13 -04:00
Graham Christensen d11f5a9d15
docs: get version from doc-support build 2019-07-04 09:10:13 -04:00
Graham Christensen cd6bf8aa00
docs: use a single nix-build for all the generate function docs 2019-07-04 09:07:47 -04:00
Frederik Rietdijk 25a77b7210 Merge staging-next into staging 2019-07-03 08:59:42 +02:00
worldofpeace b10e462404 doc/stdenv: describe dontUnpack 2019-07-01 04:23:51 -04:00
worldofpeace c79ec3323e doc/stdenv: describe dontConfigure 2019-07-01 01:52:54 -04:00
Alyssa Ross c9bd5b8516
Merge pull request #61385 from eraserhd/kakoune-plugins
kakoune: support for adding plugins
2019-06-26 20:36:17 +00:00
Jason Felice 2a911454d3 kakoune: support for adding plugins
Motivation: There is a thriving plugin ecosystem for Kakoune now,
and it is nice to add these in our Nix configurations. This was modeled
on neovim's plugins.

parinfer-rust is useable both standalone and as a Kakoune plugin,
so the plugin file inherits the same definition as pkgs.

I'll make PRs for other plugins if this gets accepted.
[Here](https://github.com/eraserhd/nixpkgs/tree/kak-ansi)'s a tested
branch for the `kak-ansi` plugin.
2019-06-25 17:17:08 -04:00
Silvan Mosberger ba3a834b75
doc/idris: Fix install instructions (#63163)
doc/idris: Fix install instructions
2019-06-19 17:10:21 +02:00
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
Graham Christensen a82901fb5e
snapTools.makeSnap: init 2019-06-18 18:51:58 +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
Jan Tojnar 3c14bda7f5
doc: fix spurious whitespace 2019-06-17 12:28:26 +02:00
Jan Tojnar 11cb382a4c
nixos/doc: Fix spurious indentation 2019-06-17 12:28:26 +02:00
Jan Tojnar d1f8e60371
doc/stdenv: fix typo 2019-06-16 20:48:44 +02:00
Jan Tojnar 902952d3a3 doc: describe pname
This was forgotten when RFC 0035 was implemented.
2019-06-16 19:49:47 +02:00
Silvan Mosberger eda8c36795
doc/idris: Fix install instructions
Because of nix-env weirdness, I introduced a mistake in the docs in
https://github.com/NixOS/nixpkgs/pull/50182, this fixes it.
2019-06-15 18:25:41 +02:00
Lorenzo Manacorda 4356b98d85 doc: update nixpkgs-mozilla rev
The previous one didn't work, returning a TOML parse error.
2019-06-08 16:15:32 +02:00
Jan Tojnar 431dc973a5
doc: document PWD for passthru.updateScript
Make it clear that PWD is not fixed
2019-06-03 00:15:29 +02:00
Jan Tojnar ea3ed0c3ae
doc: fix passthru.updateScript help command 2019-06-02 08:19:19 +02:00
Frederik Rietdijk b2ab860db3 Merge master into staging-next 2019-05-25 12:38:00 +02:00
Frederik Rietdijk 6e4e7c5dc6 Merge master into staging-next 2019-05-24 12:39:37 +02:00
Maximilian Bosch 77d8f5c040
ibus-engines.typing-booster: support french by default
This has been postponed[1] because of an unclear state of the french
dictionary provided by hunspell[2].

[1] https://github.com/NixOS/nixpkgs/pull/46779#issuecomment-422764601
[2] https://github.com/NixOS/nixpkgs/issues/46940#issuecomment-423288963
2019-05-23 15:53:50 +02:00
Michael Raskin 4e750fa92c
[RFC] manual: rename to users and contributors manual, add some user notes … (#60682)
* manual: rename to users and contributors manual, add some user notes that should be there but don't fit in any chapter
* manual: move the package notes that are completely usage-related to the upper user notes section
* manual: link to package-specific development notes from user notes
2019-05-22 13:55:00 +00:00
0xflotus ec49cf3a41 Update haskell.section.md (#61685) 2019-05-18 16:01:49 -05:00
Robin Gloster 784562980c
Merge pull request #60578 from chris-martin/doc-nginx
doc: Explain the nginx ETag patch
2019-05-18 09:29:17 +00:00
Frederik Rietdijk 840e530934 Merge staging into staging-next 2019-05-18 08:17:48 +02:00
Silvan Mosberger 3223534f89
Merge pull request #61473 from Synthetica9/dontstrip-typo
doc/stdenv.xml: fix typo
2019-05-16 20:56:59 +02:00
tbenst de5638080b doc/stdenv: document default build scripts filename 2019-05-15 21:22:01 -07:00
Tom McLaughlin 7f3d805e1c Add documentation for recent permitUserSite change (#61502) 2019-05-15 08:27:59 +02:00
Patrick Hilhorst c2f7153700
doc/stdenv.xml: fix typo 2019-05-13 23:38:43 +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
Maximilian Bosch 0f9653f7ed
doc/stdenv: put note about remote builds with breakpointHook into a <note>
With remote builds, the sandbox can't be accessed by `cntr` as it is on
a different machine. I decided to put this into an extra `note` block as it took
me admittedly too much time to figure this out.
2019-05-07 22:08:04 +02:00
Chris Martin 1478feb7aa doc: Explain the nginx ETag patch
https://github.com/NixOS/nixpkgs/issues/25485
2019-04-30 22:11:17 -06:00
Lassulus 45f8b50ac4
Merge pull request #56420 from p-alik/master
add missed internal links into haskell.section.md
2019-04-27 16:29:44 +09:00
Linus Heckemann b3d9da5f0a doc: fix syntax error in python documentation 2019-04-25 22:37:53 +02:00
cdyson37 6ea4aa481d
python-docs: typo 2019-04-23 10:37:10 +01:00
Daniel Schaefer bac4d95aa2 treewide: Change URLs to HTTPS
Lots of URLs were HTTP redirect to HTTPS. Changed those and checked them
if there's actual content. Inspired by
https://github.com/NixOS/nixpkgs/issues/60004
2019-04-22 10:19:54 +02:00
Dmitry Kalinkin 59c81160e7
Merge pull request #58504 from symphorien/static-proot
Static proot, wafHook cross compilation
2019-04-13 12:04:32 -04:00
Domen Kožar 0eba2105f8
doc: note how to quickly get started with elm 2019-04-09 09:19:34 +07:00
worldofpeace 82688a1525
Merge pull request #58160 from worldofpeace/python-doc/cleanup
doc/python: cleanup examples, references
2019-04-08 12:43:22 -04:00
Jaka Hudoklin c087b608e8
Merge pull request #58360 from xtruder/pkgs/dockerTools/nix-prefetch-docker
dockerTools: add nix-prefetch-docker script
2019-04-06 14:44:19 +02:00
Jaka Hudoklin c1f0d19785
dockerTools: add nix-prefetch-docker script 2019-04-06 14:16:40 +02:00
Dmitry Kalinkin c6a8b56e0f
Merge pull request #36886 from veprbl/symlinkJoin_doc
doc: mention symlinkJoin in multiple-outputs section
2019-03-30 22:01:01 -04:00
Dmitry Kalinkin ed14571181
manual: mention symlinkJoin in multiple-outputs section 2019-03-30 21:39:06 -04:00
Maximilian Bosch 4cd107f6b3
Merge pull request #56786 from Ma27/dlib-avx-fixes
dlib: improve AVX configuration
2019-03-30 19:20:02 +01:00
Symphorien Gibol f075de5c25 wafHook: let derivations use an existing waf in a non-standard location
this is necessary for talloc
2019-03-28 18:32:29 +01:00
Jaka Hudoklin 468df177c4
dockerTools: add finalImageName parameter for pullImage 2019-03-26 19:35:14 +01:00
John Ericson 8ba4db0f11
manual: Fix typos
Thanks @matthewbauer!

Co-Authored-By: Ericson2314 <git@JohnEricson.me>
2019-03-25 17:50:13 -04:00
John Ericson 5e5266f83f manual: Document pkgsFooBar and more
There was a bunch of stuff in the cross section that haddn't had any
attention in a while. I might need to slim it down later, but this is
good for now.
2019-03-24 22:12:21 -04:00
John Ericson ceb27efde0 manual: Auto reformat 2019-03-24 22:12:15 -04:00
John Ericson 3b27113a7c manual: Make sure building doesn't need recursive nix
$(shell ...) looks a little sketch like it will be run no matter what.
And there are problems building the manual on darwin so hopefully this
fixes them.
2019-03-24 22:11:09 -04:00
worldofpeace 0ccfebf9f2 fix Including a derivation using callPackage
The example didn't use pkgs.
2019-03-24 05:33:07 -04:00
worldofpeace 94a409450a fixup! doc/python: cleanup examples, references 2019-03-24 05:29:53 -04:00
worldofpeace 63f244193b doc/python: cleanup examples, references 2019-03-22 22:50:30 -04:00
Felix Biggs 1e86c0a7df doc/python: remove unnecessary let statement 2019-03-22 22:20:55 -04:00
Jörg Thalheim 6a81a60294
Merge pull request #57076 from Mic92/nix-review
doc/reviewing-contributions: nix-review instead of nox-review
2019-03-22 07:05:06 +00:00
Jörg Thalheim 22d083e659
doc/reviewing-contributions: nix-review instead of nox-review
It is faster, handles more edge cases and allows to test/review the built
packages interactively.
2019-03-20 11:28:00 +00:00
deliciouslytyped 01e34d6b60
Add word debug(ging) to breakpointHook description for discoverability 2019-03-15 19:33:21 +01:00
Alexei Pastuchov 1f339d754e haskell docs: add missed internal links into haskell.section.md 2019-03-15 16:12:12 +01:00
Wael M. Nasreddine 28435e47b1
buildGoModule: function for packaging Go modules
The function buildGoModule builds Go programs managed with Go modules. It builds
a Go module through a two phase build:

- An intermediate fetcher derivation. This derivation will be used to
  fetch all of the dependencies of the Go module.
- A final derivation will use the output of the intermediate derivation
  to build the binaries and produce the final output.
2019-03-14 10:31:02 -07:00
Wael Nasreddine a7f4fd0014
doc: format the documentation (#57102) 2019-03-08 21:07:11 -08:00
Maximilian Bosch 9732c44225
dlib: add flag to disable AVX support
Especially older hardware doesn't support AVX instructions. DLib is
still functional there, but significantly slower[1].

By setting `avxInstructions` to false, DLib will be compiled without
this feature.

[1] http://dlib.net/compile.html
2019-03-03 15:35:58 +01:00
Frederik Rietdijk 2fcb11a244 Merge staging-next into master 2019-03-01 09:06:20 +01:00
John Ericson 8293ab8461
Merge pull request #56408 from Mic92/runtime-shell
treewide: use runtimeShell instead of stdenv.shell whenever possible
2019-02-26 18:04:27 -05:00
Lorenzo cdf80ff19a
doc/cross-compilation: fix typo
Add missing verb.
2019-02-26 22:56:56 +01:00
Jörg Thalheim dadc7eb329
treewide: use runtimeShell instead of stdenv.shell whenever possible
Whenever we create scripts that are installed to $out, we must use runtimeShell
in order to get the shell that can be executed on the machine we create the
package for. This is relevant for cross-compiling. The only use case for
stdenv.shell are scripts that are executed as part of the build system.
Usages in checkPhase are borderline however to decrease the likelyhood
of people copying the wrong examples, I decided to use runtimeShell as well.
2019-02-26 14:10:49 +00:00
Frederik Rietdijk c2eac6741b Merge master into staging-next 2019-02-24 09:19:12 +01:00
Graham Christensen 695fb802f1
Merge pull request #54693 from tilpner/appimage-tools
appimageTools: init
2019-02-23 18:06:31 -05:00
tilpner 58443d8a50
appimageTools: init
The appimageTools attrset contains utilities to prevent
the usage of appimage-run to package AppImages, like done/attempted
in #49370 and #53156.

This has the advantage of allowing for per-package environment changes,
and extracts into the store instead of the users home directory.

The package list was extracted into appimageTools to prevent
duplication.
2019-02-23 21:04:21 +01:00
Frederik Rietdijk 1fccd25595 buildPythonPackage: always export LANG=C.UTF-8 2019-02-23 20:08:26 +01:00
Frederik Rietdijk e7b4608d02 buildPythonPackage: initial support for PEP 517 2019-02-23 20:05:19 +01:00
Frederik Rietdijk 5871da418f Merge staging into python-unstable 2019-02-21 08:02:10 +01:00
Raitis Veinbahs d8a7a01fec nix-gitignore: init at v3.0.0 (#46112)
closes siers/nix-gitignore#6
2019-02-18 09:57:30 +00:00
Frederik Rietdijk b4acd97729 buildPython*: enable strictDeps 2019-02-17 14:40:48 +01:00
Michael Raskin f539a6a70e
Merge pull request #55138 from oxij/tree/random-fixes
random cleanups and a tiny fix
2019-02-13 20:16:07 +00:00
Samuel Dionne-Riel 3172cc61f2
Merge pull request #55040 from tazjin/docs/fix-manual-makefile
Fix manual Makefile by including function doc generation
2019-02-10 15:21:08 -05:00
Jan Malakhovski 65f24643a8 doc: fix some indent 2019-02-03 20:10:10 +00:00
Vincent Ambo 29c320f9a6 doc: Include function doc generation in Makefile
Since #53055 was merged the Makefile for the manual could not be run
correctly as the generated function documentation was included, but
not actually generated.

This adds the necessary generation step by first building the XML file
containing function locations and preserving its store path in a
variable, which is then used both for linking of the locations file
and as a build input for the function docs generator.

This fixes #55014
2019-02-01 11:45:30 +01:00
Vladimír Čunát 5effa4e0f9
Merge branch 'master' into staging-next
Comments on conflicts:
- llvm: d6f401e1 vs. 469ecc70 - docs for 6 and 7 say the default is
  to build all targets, so we should be fine
- some pypi hashes: they were equivalent, just base16 vs. base32
2019-02-01 09:22:29 +01:00
Alexandre Esteves 9e7625983b
Fix typos in docker tools docs 2019-01-30 16:37:43 +00:00
Matthew Bauer a376d62441 nixpkgs/manual: add one more fix for a missed review 2019-01-27 12:01:23 -05:00
Matthew Bauer d7b62cb601 nixpkgs/manual: address review comments
Mostly taken from requested changes exactly as recommended.
2019-01-27 11:57:36 -05:00
Matthew Bauer 498a242bf4 nixpkgs/manual: add trivial builders section
Fixes #25507.
2019-01-26 22:48:47 -05:00
Matthew Bauer adb717a153 nixpkgs/manual: document default setup hooks
Fixes #34857.
2019-01-26 22:48:47 -05:00
Matthew Bauer 17ec7f3a16 nixpkgs/manual: document fetcher functions
Fixes #32439.
2019-01-26 22:48:47 -05:00
Danylo Hlynskyi 506d8ea72f
Merge pull request #53501 from LnL7/manual-makeflagsarray
doc: don't overwrite makeFlagsArray in the example
2019-01-23 20:05:16 +02:00
Jörg Thalheim 86ef9a7766
Merge pull request #53934 from Mic92/prefer-fetch-remote
prefer-fetch-remote: an overlay to fetch on remote builders
2019-01-21 10:47:59 +00:00
Frederik Rietdijk f8b45e2d84 Merge staging-next into staging 2019-01-19 09:24:01 +01:00
Jörg Thalheim eac6797380
prefer-fetch-remote: an overlay to fetch on remote builders
This is useful when running tools like NixOps or nix-review
on workstations where the upload to the builder is significantly
slower then downloading the source on the builder itself.
2019-01-18 14:41:10 +00:00
Jörg Thalheim 14474a449b
Merge pull request #53634 from Mic92/text-width
manual: limit text width
2019-01-18 14:34:15 +00:00
worldofpeace 3e41a75c4e doc/reviewing-contributions: use they pronoun
This appears to much more widely used in the nixpkgs documentation.
Also not all contributors are he's.
2019-01-18 05:29:55 -05:00
Jan Tojnar af3758e0b5
Merge branch 'master' into staging 2019-01-17 21:49:16 +01:00
Jörg Thalheim c3364fbff4
Merge pull request #53785 from danbst/get-hash-doc
manual: document ways of obtaining source hashes
2019-01-17 11:05:53 +00:00
danbst 2898377cd9 rephrase and apply suggestions 2019-01-17 12:32:08 +02:00
Frederik Rietdijk a1a5ea5943 stdenv: make checkInputs native
We can't run the checkPhase when build != host, so we may as well make
the checkInputs native.

This signicantly improves the situation of Python packages when enabling
strictDeps.
2019-01-13 14:43:18 +01:00
Orivej Desh (NixOS) 9a21967f0a
stdenv: prune libtool files by default (#51767)
See the motivation in fd97db43bc (#41819).
2019-01-11 13:20:46 +00:00
danbst 663b8cc929 manual: document ways of obtaining source hashes
... and security nuances
2019-01-11 02:06:52 +02:00
Jörg Thalheim 06bcc2dee3
manual: limit text width
Currently the manual scales to the view port of the browser.
This leads to an unreadable layout and I found myself
reading the xml source instead.
The optimal width would be around 50 characters per line.
Since we have code listings also in the manual I relaxed
this limit a bit towards 70 characters per line.
2019-01-08 15:08:42 +00:00
Peter Hoeg 15c8362c14
Merge pull request #53447 from timokau/neovim-qt-wrapper
neovim-qt: wrap in separate derivation
2019-01-08 20:24:03 +08:00
Daiderd Jordan e279767d69
doc: don't overwrite makeFlagsArray in the example
Arrays like these should be appended to instead of overwritten in almost
every case to avoid loosing the existing flags.
2019-01-06 15:40:11 +01:00
Timo Kaufmann c52c4a00a2 doc: add neovim-qt configuration 2019-01-06 10:56:28 +01:00
Frederik Rietdijk e5381cdece Merge master into staging-next 2019-01-06 09:36:23 +01:00
Domen Kožar 5ec91bac2f
Merge pull request #53326 from domenkozar/elm-packaging-rehaul
Elm: automate packaging with elm2nix
2019-01-05 13:20:16 +00:00
Frederik Rietdijk 9618abe87c Merge master into staging-next 2019-01-04 21:13:19 +01:00
Vincent Ambo 0c99dac497 doc: Add automatic generation of library function documentation
Modifies the build process of the manual to invoke nixdoc
automatically to generate XML files with function documentation.

Currently documentation is present for five of the files in `lib/`.

To add another file to the generated docs, both
`doc/functions/library.xml` and `doc/lib-function-docs.nix` must be
updated.
2019-01-04 11:28:27 +01:00
Domen Kožar 6da4584acf
Elm: automate packaging with elm2nix
- rewrite documentation
- automate whole process into update.sh
- remove all legacy snippets
2019-01-03 16:37:09 +00:00
Frederik Rietdijk 070290bda7 Merge master into staging-next 2018-12-31 12:00:36 +01:00
Timo Kaufmann 22d0f320e8
Merge pull request #52767 from timokau/vim-plugin-updates
Fix vim-plugin dependencies
2018-12-28 13:48:21 +01:00
Jan Tojnar c45e9d0fac
Merge branch 'master' into staging 2018-12-25 17:03:57 +01:00
Timo Kaufmann 8e8a09bfc9 vimUtils: add dependency logic to nativeImpl
nativeImpl previously simply ignored dependency information.
2018-12-24 23:41:44 +01:00
Sander van der Burg a27aa247c0
Merge pull request #50596 from svanderburg/mobile-updates
Mobile updates
2018-12-24 15:52:33 +01:00
Jan Tojnar ef935fa101
Merge branch 'master' into staging 2018-12-24 15:02:29 +01:00
Jörg Thalheim 1b146a8c6f
treewide: remove paxutils from stdenv
More then one year ago we removed grsecurity kernels from nixpkgs:
https://github.com/NixOS/nixpkgs/pull/25277

This removes now also paxutils from stdenv.
2018-12-22 12:55:05 +01:00
Benjamin Hipple 6206a342e0 mkl: include Intel's libiomp.so in the MKL RPM unpack
Since Intel's default openmp implementation is available in the same src
tarball, we can just include it in the package. This means that `mkl` now "just
works" without any environment variables, fragile setup-hooks, or forced
propagation.

Since the openmp implementation is only needed at runtime (and for test cases),
users can substitute a different one if they prefer by exporting it with
`LD_PRELOAD`, which is how Intel recommends handling this. If they do not do so,
`libiomp.so` lives next to `libmkl_rt.so` and thus will be in the RPATH as a
sane default.

Since this still comes from the same src tarball, we can ship it without losing
the fixed-output derivation; likewise, since Hydra is not building or caching
these, shipping these proprietary packages costs no bandwidth for the nix
community.
2018-12-19 22:05:22 +01:00
Anders Kaseorg 85379a29ec pypy3: init at 6.0.0
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2018-12-19 09:53:31 +01:00
Sander van der Burg c68974117b Add Titanium documentation section 2018-12-18 21:16:07 +01:00
Sander van der Burg 56e112e874 Add documentation for building iOS apps 2018-12-18 21:16:06 +01:00
Sander van der Burg 676d07af3f Add documentation section for Android 2018-12-18 21:16:06 +01:00
Frederik Rietdijk 826ab7026e Merge master into staging-next 2018-12-18 09:22:17 +01:00
John Ericson fcce28f1af
docs: Small change to Rust guide to be more cross friendly 2018-12-18 06:09:34 +01:00
Jan Tojnar aead6e12f9
Merge remote-tracking branch 'upstream/master' into staging 2018-12-16 22:55:06 +01:00
worldofpeace 2417859932
doc/breakpointHook: correct typos 2018-12-13 21:36:29 +00:00
Dmitry Kalinkin 694d32f47d
Update doc/stdenv.xml
Co-Authored-By: guibou <guillaum.bouchard@gmail.com>
2018-12-13 18:11:52 +01:00
Guillaume Bouchard d5c931992d
Fix english in stdenv.xml 2018-12-13 17:23:51 +01:00
Piotr Bogdan 743d03bafc doc/stdenv: document dontPruneLibtoolFiles 2018-12-09 23:17:16 +00:00
Frederik Rietdijk 747aa4cc93 Merge staging-next into staging 2018-12-07 15:31:52 +01:00
Matthew Bauer 7a00e80329 ghc: don’t add libiconv automatically
ghc needs it to fail to correctly detect it for later.
2018-12-05 13:17:40 -06:00
Mario Rodas f1dd6faaaa
docs: Remove nix-repl references
nix-repl has been deprecated
2018-12-03 21:37:54 -05:00
markuskowa 506d4c7e44
Merge pull request #51329 from c0bw3b/cleanup/gnu-https
Favor HTTPS URLs - the GNU edition
2018-12-02 16:52:33 +01: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
Jan Tojnar 4920f0c0ad
Merge pull request #50977 from jtojnar/parallel-update.nix
update.nix: Run update scripts in parallel
2018-12-02 01:23:39 +01:00
Jan Tojnar 59a94b57f0
update.nix: Run update scripts in parallel
To make updating large attribute sets faster, the update scripts
are now run in parallel.

Please note the following changes in semantics:

- The string passed to updateScript needs to be a path to an executable file.
- The updateScript can also be a list: the tail elements will then be passed
  to the head as command line arguments.
2018-12-01 19:17:13 +01:00
Matthew Bauer 54737e329b
doc: fix incorrect example
For whatever reason, nix-build ... --argstr a.b "c" doesn't work. It fails quitely so it's best to use an example here that works.
2018-11-28 16:00:43 -06:00
Léo Gaspard 22d8291c17
Merge branch 'pr-51111'
* pr-51111:
  doc: document upgrading Ruby packages
2018-11-29 00:37:06 +09:00
Alyssa Ross 6bda83a64d
doc: document upgrading Ruby packages
As requested[1] by @Ekleog.

[1]: https://github.com/NixOS/nixpkgs/pull/51040#issuecomment-441642763
2018-11-28 13:19:22 +00:00
zimbatm 064bd03b8c
doc: tweak the coding conventions (#51113)
Encouraging to put container elements on their own lines to minimize
diffs, merge conflicts and making re-ordering easier.

Nix doesn't suffer the restrictions of other languages where commas are
used to separate list items.
2018-11-27 22:14:41 +01:00
Jörg Thalheim afbdeb7b9b
Merge pull request #50802 from aszlig/autopatchelf-improvements
autoPatchelfHook: Fixes/improvements for Android SDK emulator
2018-11-27 10:25:26 +00:00
Jörg Thalheim 3324503824
doc: add example usage for breakpointHook (#51005) 2018-11-26 11:54:23 +00:00
Frederik Rietdijk fd26e7be2a Merge master into staging-next 2018-11-20 11:47:26 +01:00
Pierre Bourdon 6b1d3dc590 doc/reviewing-contributions: fix build error
Regression from #50674. Section IDs cannot contain spaces.
2018-11-20 03:46:34 +01:00
aszlig 503b41b9b2
doc/stdenv: Document autoPatchelfHook changes
First of all, this makes the existing documentation a bit more clear on
what autoPatchelfHook is all about, because after discussing with
@svanderburg - who wrote a similar implementation - the rationale about
autoPatchelfHook wasn't very clear in the documentation.

I also added the recent changes around being able to use autoPatchelf
manually and the new --no-recurse flag.

Signed-off-by: aszlig <aszlig@nix.build>
2018-11-20 00:11:31 +01:00
Matthew Bauer c2e6a4362a doc/cross-compilation: remove reference to old wiki
The link doesn’t work and it’s not very important to the documentation anyway.
2018-11-19 13:03:24 -06:00
Matthew Bauer 5e9f452385 doc/reviewing-contributions: pull-requests -> pull requests
This makes things more consistent. It’s also how GitHub refers to pull
requests.
2018-11-19 13:03:23 -06:00
Matthew Bauer 9d3108c3ae doc/cross-compilation: fixup
More cleanups and stuff. May need to be split up.
2018-11-19 13:03:23 -06:00
Matthew Bauer ee58ab3cb9 doc/platform-notes: reword xcode warning
xcbuild doesn’t work exactly like xcode in some ways.
2018-11-19 13:03:23 -06:00
Matthew Bauer 4a49921a69 doc/stdenv: more changes
Lots of reworking here. May need to be split up.
2018-11-19 13:03:22 -06:00
Matthew Bauer 49e5bd0dbe doc/stdenv: document more setup hook
Here I document setup hooks provided by:

- cmake
- xcbuildHook
- meson
- ninja
- unzip
- wafHook
- scons
2018-11-19 13:03:09 -06:00
Matthew Bauer 4621d14b4a doc/stdenv: document prefixKey
This seems like a useful thing to document
2018-11-19 13:02:31 -06:00
Matthew Bauer b01613c9ce doc: move checkInputs to check phase section
This makes more sense in context.
2018-11-19 13:02:31 -06:00
Matthew Bauer 32ddbe3da9 doc: typo fixes 2018-11-19 13:02:17 -06:00
Frederik Rietdijk e343a85cfb Merge master into staging-next 2018-11-19 09:55:32 +01:00
Andrei Lapshin e198f9e42f
Fix typo in nixpkgs manual 2018-11-19 09:09:02 +03:00
Vladimír Čunát a995fc2dd7
Merge #26513: docs: use RFC 2119 in a section 2018-11-18 15:34:15 +01:00
Frederik Rietdijk 63c6875f26 Merge master into staging-next 2018-11-18 10:32:12 +01:00
Jörg Thalheim 552b2955d3
doc/node: document the new preferred node version 2018-11-16 21:24:25 +00:00
Benjamin Hipple 286e7a57c4 docs: fix minor grammar issues in the manual 2018-11-14 21:40:47 -05:00
Silvan Mosberger 513c659d56
Merge pull request #50182 from Infinisil/idris/doc-update
nixpkgs idris docs: Update and improve
2018-11-14 18:47:40 +01:00
Frederik Rietdijk daf3297cb4 Merge master into staging-next 2018-11-12 18:59:08 +01:00
Théo Zimmermann 208aedb971 ocamlPackages.*: remove unnecessary unpackCmd 2018-11-12 17:25:18 +00:00
Silvan Mosberger f8a1333c8e
nixpkgs idris docs: Update and improve 2018-11-12 13:23:31 +01:00
rht febadf8ddb
Use RFC 2119 convention to describe package naming convention 2018-11-11 15:51:16 +00: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
Frederik Rietdijk 7863aae5b2 Merge master into staging-next 2018-11-11 08:59:44 +01:00
Benjamin Hipple a649f1c0cd doc: fix default python interpreter
The default for `python3` is currently `python36`.
2018-11-10 13:00:10 -05:00
Frederik Rietdijk 53d00c3351 Merge master into staging-next 2018-11-10 11:08:54 +01:00
Jörg Thalheim 7e2e6e1131
Merge pull request #49684 from Zimmi48/dune-package
buildDunePackage: add support function and use it in a few packages
2018-11-07 13:01:09 +00:00
Eelco Dolstra 78090f4f09
Remove preferLocalBuild documentation
It's incorrect (preferLocalBuild does not prevent uploading to binary
caches) and is not a stdenv attribute (it's already documented in the
Nix manual).
2018-11-07 11:45:40 +01:00
Théo Zimmermann 5cd08118d9
duneBuildPackage: document 2018-11-07 10:08:08 +01:00
Timo Kaufmann 6141939d6e
Merge pull request #44439 from Ekleog/meta-tests
[RFC] Use `meta.tests` to link from packages to the tests that test them
2018-11-07 00:05:22 +01:00
Jan Path 1b111df290
docs: Remove redundancy 2018-11-05 20:16:51 +01:00
Frederik Rietdijk b1bdce0793 python34: remove
Python 3.4 will receive it's final patch release in March 2019 and there won't
be any releases anymore after that, so also not during NixOS 2019.03.

Python 3.4 is not used anymore in Nixpkgs. In any case, migrating code from
3.4 to 3.4+ is trivial.
2018-11-04 18:48:24 +01:00
Vladimír Čunát a92a2c8e15
Merge branch 'master' into staging
Conflict: rename of pythondaemon -> python-daemon.
2018-11-02 14:40:14 +01:00
Benjamin Hipple baf0703010 pythonPackages.pythondaemon: rename to pythonPackages.python-daemon
This commit renames the pythondaemon module to match its module name, github
name, and pypi name, which makes it easier to find and reference. In order to
avoid breaking any external users, I've left an alias with a deprecated warning.
2018-10-30 21:09:34 +01:00
Frederik Rietdijk 1d196d99be Merge staging-next into staging 2018-10-30 20:35:15 +01:00
Frederik Rietdijk 0e0d20fb5f Merge master into staging-next 2018-10-30 19:55:48 +01: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
Théo Zimmermann 2f9fc897eb Add mention of nix-prefetch-github. (#49336) 2018-10-30 01:24:07 +01:00
Frederik Rietdijk 1cca105769 Merge staging-next into staging 2018-10-27 09:05:30 +02:00
Frederik Rietdijk a64058e205 Merge master into staging-next 2018-10-27 09:04:53 +02:00
Jörg Thalheim 764d165f43
doc: apply make format 2018-10-26 11:13:54 +01:00
Jörg Thalheim 7f80fb2db4
doc: extend breakpointHook documentation 2018-10-26 11:13:24 +01:00
Jörg Thalheim a8df9ff9d9
Merge pull request #49126 from das-g/stdenv-docs
minor fixes in Nixpkgs stdenv docs
2018-10-26 09:12:45 +01:00
Raphael Borun Das Gupta aa77e3aa4f nixpkgs docs: add missing spaces between words 2018-10-26 00:35:21 +02:00
Raphael Borun Das Gupta bea0b3021c nixpkgs docs: remove spurious ">" 2018-10-26 00:29:27 +02:00
Jörg Thalheim 9c8bf9e471
Merge pull request #49026 from schmittlauch/doc-vim
clarifying `name` arg determines vim command name
2018-10-25 17:51:06 +01:00
Jörg Thalheim 926d6c0bad
Merge pull request #42371 from Mic92/nix-breakpoints
breakpointHook: add for debugging failing builds
2018-10-25 10:38:29 +01:00
Jörg Thalheim 325a5699cb
doc/breakpointHook: add documentation 2018-10-25 10:19:42 +01:00
Frederik Rietdijk 0f38d9669f python3 is now python37 instead of python36
With Python 3.7 now at 3.7.1, and Python 3.6 at it's final maintenance
mode release, it is time to move on to 3.7 as the default interpreter.
2018-10-24 20:05:44 +02:00
volth 716cfab34e Merge master into staging-next 2018-10-24 17:37:47 +00:00
Trolli Schmittlauch c90051c53d clarifying name arg determines vim command name
The `name` arg of `vim_configurable.customize` does not only determine
the package name, but also the name of the command/ executable to be
called.
In my opinion this is not documented properly and finding that out took
me several hours.
2018-10-24 17:02:54 +02:00
John Ericson b71389aefb
Merge pull request #47430 from roberth/nixpkgs-extend
pkgs.extend for adding overlays
2018-10-23 20:21:48 -04:00
Ingo Blechschmidt 00b555ef88 nixpkgs docs: Fix tiny typo (#48477) 2018-10-23 14:41:15 +00:00
Alyssa Ross e20e1e5c2c weechat: add perl.withPackages (#48815)
Allows for adding Perl libraries in the same way as for Python. Doesn't
really need to be a function, since there's only one perlPackages in
nixpkgs, but I went for consistency with the python plugin.
2018-10-23 12:23:47 +02:00
Chris Ostrouchov 277b73ab6f pythonPackages.{numpy,scipy,numexpr}: support MKL as BLAS
This adds support building with MKL.
2018-10-20 11:50:37 +02:00
Robert Hensing a5c4642ddf doc: Add link from overrides to overlays 2018-10-19 12:25:17 +02:00
Théo Zimmermann 668c19a9ac
coqPackages: update documentation to mention coq.ocamlPackages attribute 2018-10-19 10:29:49 +02:00
Robert Hensing 3c2ae189c2 doc: Improve overrides and overlays documentation 2018-10-18 14:01:06 +02:00
Robert Hensing 9b7654f6ff nixpkgs docs: Point to pkgs.extend, pkgs.appendOverlays and improve override section 2018-10-18 10:48:43 +02:00
Graham Christensen 94c6f1ba0e
Merge pull request #48463 from Ekleog/release-notes-license
release-notes/18-09: add licenses marked as unfree
2018-10-15 10:33:31 -04:00
Léo Gaspard 02e8e56500
package-notes: line wrap by auto-cleanup 2018-10-15 23:10:54 +09:00
Graham Christensen 0eb3b93e1a
nixpkgs docs: document recursivelyUpdate 2018-10-12 16:54:34 -04:00
Graham Christensen c100a456b1
nixpkgs docs: document recursivelyUpdateUntil 2018-10-12 16:54:34 -04:00
Graham Christensen 77140a9075
nixpkgs docs: document zipAttrs 2018-10-12 16:54:34 -04:00
Graham Christensen 655a5fa8bf
nixpkgs docs: document zipAttrsWith 2018-10-12 16:54:34 -04:00
Graham Christensen 4edb31882c
nixpkgs docs: Clarify zipAttrsWithNames's docs 2018-10-12 16:54:33 -04:00
Graham Christensen 3b3bde463b
nixpkgs docs: document zipAttrsWithNames 2018-10-12 16:06:12 -04:00
Graham Christensen e0c6981d19
nixpkgs docs: document optionalAttrs 2018-10-12 16:06:12 -04:00
Graham Christensen c547c3fe82
nixpkgs docs: document toDerivation 2018-10-12 16:06:12 -04:00
Graham Christensen f85a4ba9c3
nixpkgs docs: document isDerivation 2018-10-12 16:06:11 -04:00
Graham Christensen ef05e1057b
nixpkgs docs: document genAttrs 2018-10-12 16:06:11 -04:00
Graham Christensen d664b8f5e3
nixpkgs docs: document mapAttrsRecursiveCond 2018-10-12 16:06:11 -04:00
Graham Christensen e7549b96ad
nixpkgs docs: finish up mapAttrsRecursive 2018-10-12 16:06:11 -04:00
Benjamin Hipple 1bcdf27c48 Update with code review feedback; add example python application 2018-10-12 10:06:25 +02:00
Benjamin Hipple c0af13f1c8 python: update documentation
This touches up a handful of places in the python documentation to try to make
the current best-practices more obvious. In particular, I often find the
function signatures (what to pass, what not to pass) confusing and have added
them to the docs.

Also updated the metas to be more consistent with the most frequently used
modern style.
2018-10-12 10:06:25 +02:00
Graham Christensen 5daee73ce4
Generate links to function definitions
Hydra passes the full revision in to the input, which we pass through.

If we don't get this ,we try to get it from other sources, or default to
master which should have the definition in a close-ish location.

All published docs should have theURL resolve properly, only local
hackers will have the link break.
2018-10-05 11:20:46 -04:00
Graham Christensen f835f77e02
nixpkgs: Start documenting library functions in XML
Covers assert functions and about half of the attrsets functions.

Some internal consistency around IDs could be improved.
2018-10-05 10:06:08 -04:00
Graham Christensen f2b3bbe44e
Merge pull request #47688 from grahamc/doc-breakout-functions
nixpkgs docs: breakout functions
2018-10-03 21:52:48 -04:00
Graham Christensen c07ba7c856
nixpkgs docs: Reformat 2018-10-02 15:59:59 -04:00
Graham Christensen 444e04b985
nixpkgs docs: Rebuild manual-full if nested XML docs change 2018-10-02 15:59:00 -04:00
Graham Christensen c3125498fd
shell functions: rewrite as xml 2018-10-02 14:16:27 -04:00
Graham Christensen 507a63c885
nixpkgs docs: move shell section to its own file 2018-10-02 14:13:42 -04:00
Graham Christensen 8bf342ffb8
nixpkgs docs: move dockertool to its own file 2018-10-02 14:13:12 -04:00
Graham Christensen 0856d5c4ad
nixpkgs docs: move fhs-environments to its own file 2018-10-02 14:08:36 -04:00
Graham Christensen 3ac79c89b7
nixpkgs docs: move debug to its own file 2018-10-02 14:07:06 -04:00
Graham Christensen 9ae39b3553
nixpkgs docs: move generators to its own file 2018-10-02 14:03:59 -04:00
Graham Christensen f200a322c4
nixpkgs docs: move overrides to its own file 2018-10-02 13:52:21 -04:00
Jörg Thalheim bc0d87a4f1
Merge pull request #47455 from nyanloutre/steamPackages.steam-udev
steamPackages.steam: add udev rules and update to 1.0.0.56
2018-10-02 00:55:41 +01:00
lewo 56b4db9710
Merge pull request #47411 from graham-at-target/multi-layered-images-crafted
Multi-Layered Docker Images
2018-10-01 09:48:24 +02:00
nyanloutre d859a66351
nixos/steam-hardware: update documentation 2018-09-30 11:27:47 +02:00
Graham Christensen d1e46df24b fixup: drop comment about config behaving differently from buildImage 2018-09-27 08:14:04 -04:00
Graham Christensen 4fe9006190 dockerTools.buildLayeredImage: init
Create a many-layered Docker Image.

Implements much less than buildImage:

 - Doesn't support specific uids/gids
 - Doesn't support runninng commands after building
 - Doesn't require qemu
 - Doesn't create mutable copies of the files in the path
 - Doesn't support parent images

If you want those feature, I recommend using buildLayeredImage as an
input to buildImage.

Notably, it does support:

 - Caching low level, common paths based on a graph traversial
   algorithm, see referencesByPopularity in
   0a80233487993256e811f566b1c80a40394c03d6
 - Configurable number of layers. If you're not using AUFS or not
   extending the image, you can specify a larger number of layers at
   build time:

       pkgs.dockerTools.buildLayeredImage {
         name = "hello";
         maxLayers = 128;
         config.Cmd = [ "${pkgs.gitFull}/bin/git" ];
       };

 - Parallelized creation of the layers, improving build speed.
 - The contents of the image includes the closure of the configuration,
   so you don't have to specify paths in contents and config.

   With buildImage, paths referred to by the config were not included
   automatically in the image. Thus, if you wanted to call Git, you
   had to specify it twice:

       pkgs.dockerTools.buildImage {
         name = "hello";
         contents = [ pkgs.gitFull ];
         config.Cmd = [ "${pkgs.gitFull}/bin/git" ];
       };

   buildLayeredImage on the other hand includes the runtime closure of
   the config when calculating the contents of the image:

       pkgs.dockerTools.buildImage {
         name = "hello";
         config.Cmd = [ "${pkgs.gitFull}/bin/git" ];
       };

Minor Problems

 - If any of the store paths change, every layer will be rebuilt in
   the nix-build. However, beacuse the layers are bit-for-bit
   reproducable, when these images are loaded in to Docker they will
   match existing layers and not be imported or uploaded twice.

Common Questions

 - Aren't Docker layers ordered?

   No. People who have used a Dockerfile before assume Docker's
   Layers are inherently ordered. However, this is not true -- Docker
   layers are content-addressable and are not explicitly layered until
   they are composed in to an Image.

 - What happens if I have more than maxLayers of store paths?

   The first (maxLayers-2) most "popular" paths will have their own
   individual layers, then layer #(maxLayers-1) will contain all the
   remaining "unpopular" paths, and finally layer #(maxLayers) will
   contain the Image configuration.
2018-09-26 17:54:14 -04:00
John Ericson 22ce614112
Merge pull request #47238 from obsidiansystems/overrideScope-order
lib: Deprecate `overrideScope` in lieu of `overrideScope'` taking arguments in the conventional order
2018-09-24 18:04:18 -04:00
John Ericson b9dce11712 lib: Make overrideScope' which takes arguments in the conventional order
The `overrideScope` bound by `makeScope` (via special `callPackage`)
took an override in the form `super: self { … }`. But this is
dangerously close to the `self: super { … }` form used by *everything*
else, even other definitions of `overrideScope`! Since that
implementation did not even share any code either until I changed it
recently in 3cf43547f4, this inconsistency
is almost certainly an oversight and not intentional.

Unfortunately, just as the inconstency is hard to debug if one just
assumes the conventional order, any sudden fix would break existing
overrides in the same hard-to-debug way. So instead of changing the
definition a new `overrideScope'` with the conventional order is added,
and old `overrideScope` deprecated with a warning saying to use
`overrideScope'` instead. That will hopefully get people to stop using
`overrideScope`, freeing our hand to change or remove it in the future.
2018-09-24 17:50:11 -04:00
John Ericson e39a73cc55 doc: Don't mention top-level {build, host, target}Platform
For technical reasons, we cannot easily add a warning to top-level
definitions, so 2a6e4ae49a and
e51f736076 reverted the deprecation. But
we can still remove mention of the would-be deprecated definitions to
steer people towards using the preferred alternatives.
2018-09-23 13:25:44 -04:00
Graham Christensen 7736337916
Clarfy the binary reproducibility problems of created=now with dockerTools.buildImage. 2018-09-20 20:23:04 -04:00
John Children aec67d299c doc/stdenv: libaries -> libraries (#47011)
This commit corrects a minor typo in the stdenv portion of the
documentation for the nix language.
2018-09-20 18:45:54 +01:00
Graham Christensen a32d7e0c74 dockerTools.buildImage: support impure dates
Because dates are an impurity, by default buildImage will use a static
date of one second past the UNIX Epoch. This can be a bit frustrating
when listing docker images in the CLI:

    $ docker image list
    REPOSITORY   TAG      IMAGE ID       CREATED        SIZE
    hello        latest   08c791c7846e   48 years ago   25.2MB

If you want to trade the purity for a better user experience, you can
set created to now.

    pkgs.dockerTools.buildImage {
      name = "hello";
      tag = "latest";
      created = "now";
      contents = pkgs.hello;

      config.Cmd = [ "/bin/hello" ];
    }

and now the Docker CLI will display a reasonable date and sort the
images as expected:

    $ docker image list
    REPOSITORY   TAG      IMAGE ID       CREATED              SIZE
    hello        latest   de2bf4786de6   About a minute ago   25.2MB
2018-09-20 18:26:02 +02:00
Jörg Thalheim 1552f2ef68 doc/vim: remove some vim-plug redundancy 2018-09-20 08:20:11 +01:00
Roman Volosatovs c1d8b1e266
doc: Add section about vim-plug 2018-09-20 09:05:33 +02:00
Maximilian Bosch dee2dab7c6
ibus-engines.typing-booster: init at 2.1.1
This package providesa completion input method for faster typing.
See https://mike-fabian.github.io/ibus-typing-booster

Detailed instructions how to activate this IBus engine on your desktop
can be found in the upstream docs: https://mike-fabian.github.io/ibus-typing-booster/documentation.html

A simple VM with the Gnome3 desktop and activated `ibus' looks like
this:

```nix
{
  emojipicker = { pkgs, ... }: {
    services.xserver = {
      enable = true;
      desktopManager.gnome3.enable = true;
      desktopManager.xterm.enable = false;
    };
    users.extraUsers.vm = {
      password = "vm";
      isNormalUser = true;
    };
    i18n.inputMethod.ibus.engines = [
      pkgs.ibus-engines.typing-booster
    ];
    i18n.inputMethod.enabled = "ibus";
    virtualisation.memorySize = 2048;
  };
}
```

Fixes #38721
2018-09-19 21:27:10 +02:00
worldofpeace 6dae5de436
rust.section.md: remove nixcrate reference
nixcrate is deprecated
2018-09-15 18:38:26 +00:00
Sarah Brofeldt 2a6e4ae49a Revert "top-level: Deprecate top-level {build,host,target}Platform"
This reverts commit e51f736076.
2018-09-11 13:25:50 +02:00
Jörg Thalheim 953199fd82 vim-plugins: rewrite updater
A new python script has been added to replace the aged viml-based
updater. The new updater has the following advantages:

- use rss feeds to check for updates quicker
- parallel downloads & better caching
- uses proper override mechanism instead of text substitution
- update generated files in-place instead of having to insert updated plugins manually

Automatically reading `dependencies` from the plugins directory has been
not re-implemented.
This has been mostly been used by Mark Weber's plugins, which seem to
no longer receive regular updates.
This could be implemented in future as required.
2018-09-09 11:22:43 +01:00
Jörg Thalheim 97acac9a81 doc/vim: improve plugin documentation 2018-09-09 09:45:45 +01:00
Timo Kaufmann e326c0156d
Merge pull request #45728 from Ma27/nixos/weechat-module
nixos/weechat: add module
2018-09-07 17:19:46 +02:00
Maximilian Bosch a8efe61412
weechat: 2.1 -> 2.2; improve package configuration
This aims to make the `weechat` package even more configurable. It
allows to specify scripts and commands using the `configure` function
inside a `weechat.override` expression.

The package can be configured like this:

```
with import <nixpkgs> { };
weechat.override {
  plugins = { availablePlugins, ... }: {
    plugins = builtins.attrValues availablePlugins;

    init = ''
      /set foo bar
      /server add freenode chat.freenode.org
    '';

    scripts = [ "/path/to/script.py" ];
  };
}
```

All commands are passed to `weechat --run-command "/set foo bar;/server ..."`.

The `plugins' attribute is not necessarily required anymore, if it's
sufficient to add `init' commands, the `plugins' will be
`builtins.attrValues availablePlugins' by default.

Additionally the result contains `weechat` and `weechat-headless`
(introduced in WeeChat 2.1) now.
2018-09-07 13:10:43 +02:00
John Ericson 0af9072e74
Merge pull request #46059 from obsidiansystems/deprecate-top-level-platform-aliases
top-level: Deprecate top-level `{build,host,target}Platform`
2018-09-06 07:52:17 -04:00
John Ericson e51f736076 top-level: Deprecate top-level {build,host,target}Platform
I don't know when we can/should remove them, but this at least gets
people to stop using them. The preferred alternatives also date back to
17.09 so writing forward-compatable code without extra conditions is
easy.

Beginning with these as they are the least controversial.
2018-09-05 11:53:51 -04:00
Eelco Dolstra eac06ed070
Manual: Random indentation fixes 2018-09-03 17:13:46 +02:00
Graham Christensen 03b89e3031
Merge pull request #45914 from grahamc/section-ids
Section ids
2018-09-01 15:38:52 -04:00
Graham Christensen 2eea92a1dc
nixpkgs docs: give linked things IDs 2018-09-01 15:20:57 -04:00
Graham Christensen cbdcf81590
Add section IDs 2018-09-01 15:06:38 -04:00
Jörg Thalheim 4a74aca868
Merge pull request #45700 from Mic92/node-packages-v8
nodePackages: 6_x -> 8_x
2018-09-01 09:09:24 +01:00
Daiderd Jordan 477efb9d87
Merge pull request #42464 from LnL7/manual-installcheck
doc: add installCheckTarget and installCheckFlags to manual
2018-08-31 20:08:16 +02:00
John Ericson 2c4a75e9ef
Merge pull request #45820 from obsidiansystems/dont-use-obsolete-platform-aliases
treewide: Dont use obsolete platform aliases
2018-08-31 09:56:10 -04:00
Jörg Thalheim 86bd041196 docs/python: fix attribute naming example
https://github.com/NixOS/nixpkgs/pull/45822#issuecomment-417566642
2018-08-31 08:02:55 +01:00
Jörg Thalheim e5124b0f75 doc/python: convention for attributes names
cc @FRidh, @dotlambda
2018-08-31 06:52:53 +01:00
John Ericson 0828e2d8c3 treewide: Remove usage of remaining redundant platform compatability stuff
Want to get this out of here for 18.09, so it can be deprecated
thereafter.
2018-08-30 17:20:32 -04:00
John Ericson 2c2f1e37d4 reewide: Purge all uses stdenv.system and top-level system
It is deprecated and will be removed after 18.09.
2018-08-30 17:20:32 -04:00
Jörg Thalheim bf56bc7b49 nodePackages: 6_x -> 8_x 2018-08-28 11:15:07 +01:00
Graham Christensen 360f420ac7
nixpkgs docs: normalize 2018-08-27 19:54:41 -04:00
Graham Christensen 53371b15c6
docs: include shell section 2018-08-27 19:53:25 -04:00
Frederik Rietdijk b7e0c40d29 docs python: python.buildEnv does not include buildPythonApplication modules
Clarify the issue encountered at
https://github.com/NixOS/nixpkgs/issues/45503
2018-08-26 09:31:39 +02:00
Ryan Mulligan 5c5baaf17d treewide: remove mailing list references 2018-08-23 09:24:44 -07:00
Vladimír Čunát 209730208a
Merge branch 'staging-next' 2018-08-17 20:51:31 +02:00
Florian Klink e84e2fb434 docs: explain the home passthru present in all JDKs and setting JAVA_HOME where required 2018-08-17 17:06:05 +02:00
Florian Klink 43905b1e0c docs: explain what jdk really points to and why 2018-08-17 16:51:02 +02:00
Vladimír Čunát cbabebcc2e
Merge branch 'master' into staging-next
Hydra: ?compare=1473892
2018-08-17 13:45:21 +02:00
Jörg Thalheim 78777fbd6b
Merge pull request #44981 from Ekleog/rust-patch-bis
buildRustPackage: allow patches to fix Cargo.lock
2018-08-14 14:23:51 +02:00
Léo Gaspard af960e5df9
buildRustPackage: add documentation about cargoPatches 2018-08-14 20:09:45 +09:00
Vladimír Čunát 5b0398dc36
Merge branch 'master' into staging-next
Conflicts: gobby and libinfinity - I took the hand-edited versions
instead of those resuting from the mass-replacement.

Hydra: ?compare=1473190
2018-08-13 20:43:59 +02:00
Carlos D 0e7a34a1aa docs: add some docs for hackage2nix 2018-08-13 14:46:11 +10:00
Frederik Rietdijk d9fa74ba78 Merge master into staging 2018-08-09 18:28:15 +02:00
Frederik Rietdijk 786cbba7be
Merge pull request #44447 from NixOS/staging-next
Staging next
2018-08-09 09:04:03 +02:00
Maximilian Bosch eb0207f132 citrix_receiver: document installation pitfalls and extraCerts (#44635)
Since #44522 it's possible to specify custom certificates for the Citrix
receiver. As it took me some time to create a proper setup Citrix can
behave fairly unexpected.

I mostly covered two aspects:

* Don't install Citrix with `nix run`: when `citrix.desktop` is linked
  to $XDG_CONFIG_DIRS, it's possible to start a session directly from the
  browser when loading `.ica` files which makes the usage *way* easier.

* It's possible to add custom certificates using the Citrix wrapper. A
  new store path with the original derivation and the certificates will be
  created and therefore no rebuild of the package is needed when adding
  new certs.
2018-08-07 23:48:02 +02:00
Vladimír Čunát f504af072b
Merge branch 'master' into staging-next
There's been some large rebuild on master.
I don't really have time ATM to find what it was.
2018-08-06 12:07:37 +02:00
Sarah Brofeldt c6a4f9af60
Merge pull request #44528 from samueldr/fix/mention-bot
doc: Fixes mentions of mention-bot.
2018-08-06 08:59:10 +02:00
Samuel Dionne-Riel e97112bdc3 doc: Fixes mentions of mention-bot.
Its last mention was on 2017-09-25. Close to a year.

The CODEOWNERS feature of github, though, fills in the gap in a more
appropriate manner (IMHO).
2018-08-05 20:22:32 -04:00
Tuomas Tynkkynen 008fd5fcf5 Merge remote-tracking branch 'upstream/master' into staging 2018-08-04 15:17:42 +03:00
Frederik Rietdijk 699e0e50b7 Merge master into staging-next 2018-08-04 11:43:54 +02:00
John Ericson 7a337cde31
Merge pull request #44423 from obsidiansystems/configureFlags-cleanup
treewide: All configureFlags are lists
2018-08-03 17:49:01 -04:00
John Ericson db965063b3 treewide: Make configureFlags lists 2018-08-03 17:06:03 -04:00
Matthew Harm Bekkema a6c7132abc doc: change git:// links to https:// (#44395)
The server is not verified over the git:// transfer protocol. If you
clone a repository over git://, you should check if the latest commit's
hash is correct.

On the other hand, https:// will always verify the server automatically,
using certificate authorities.
2018-08-03 14:01:34 +01:00
John Ericson 89c21fce3f Merge commit 'master' into staging 2018-08-02 16:13:33 -04:00
Daiderd Jordan 61a1b20d23
doc: add darwin installCheckTarget example 2018-08-01 20:58:45 +02:00
James Deikun bd63de114e stdenv/build-support: support .tbz and .txz tarballs 2018-07-30 15:30:16 -04:00
Nick Novitski c58b11d229 dockerTools.pullImage: control OS and architecture 2018-07-27 12:29:31 -07:00
Erik Arvstedt eb60a87887 python-docs: minor typo and grammar fixes 2018-07-26 14:28:23 +02:00
Erik Arvstedt fa01100f40 python-docs: fix override examples
Use example package `zerobin` instead of `bepasty-server` which
is no longer part of python-packages.
This fixes the examples for current nixpkgs versions.
2018-07-25 21:33:48 +02:00
Erik Arvstedt 42e3727aa2 python docs: improve override example
1. Use the same approach like in the overlay example:
   Override `python` instead of `pythonPackages` so that
   `python.pkgs` refers to the new package set like `pythonPackages`.

   This also fixes a bug in the original example where
   `pkgs.fetchgit` was not in scope.

   Add an extra example to illustrate how to override just a
   package set.

2. Fix mix-up between `super` and `self` in the explanation text.
   Also, simplify the explanation.
2018-07-25 21:29:25 +02:00
Erik Arvstedt a8f54972f4 python docs: improve overlay example
The `pythonPackages` definition is redundant
2018-07-25 16:44:56 +02:00
Alyssa Ross 9e1e63ce0e doc: add missing semicolon to weechat example (#44003) 2018-07-23 10:48:11 +01:00