Commit graph

138 commits

Author SHA1 Message Date
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
Herwig Hochleitner 47824cdf4d stdenv: document dontFixup 2019-08-12 02:52:31 +02:00
Frederik Rietdijk c40307b8c9 doc: fix phases to include installCheckPhase 2019-07-28 12:08:39 +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
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
Jan Tojnar 3c14bda7f5
doc: fix spurious whitespace 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
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
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
Patrick Hilhorst c2f7153700
doc/stdenv.xml: fix typo 2019-05-13 23:38:43 +02: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
Dmitry Kalinkin 59c81160e7
Merge pull request #58504 from symphorien/static-proot
Static proot, wafHook cross compilation
2019-04-13 12:04:32 -04: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
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
deliciouslytyped 01e34d6b60
Add word debug(ging) to breakpointHook description for discoverability 2019-03-15 19:33:21 +01:00
Wael Nasreddine a7f4fd0014
doc: format the documentation (#57102) 2019-03-08 21:07:11 -08: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
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 adb717a153 nixpkgs/manual: document default setup hooks
Fixes #34857.
2019-01-26 22:48:47 -05: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
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
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
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
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
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
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
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 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 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
Andrei Lapshin e198f9e42f
Fix typo in nixpkgs manual 2018-11-19 09:09:02 +03:00
Benjamin Hipple 286e7a57c4 docs: fix minor grammar issues in the manual 2018-11-14 21:40:47 -05: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
Jörg Thalheim 764d165f43
doc: apply make format 2018-10-26 11:13:54 +01:00