Commit Graph

2217 Commits

Author SHA1 Message Date
Robert Hensing
c1311d1223 doc/stdenv: Move Other hooks after all hooks 2022-10-13 21:15:19 +02:00
Robert Hensing
53088569de doc/stdenv: Clarify that the wrappers come with hooks 2022-10-13 21:14:21 +02:00
Robert Hensing
f4c6286284 doc/stdenv: Improve language a bit 2022-10-13 21:14:04 +02:00
Robert Hensing
2db8de920e doc: Move non-stdenv hooks out of stdenv chapter 2022-10-13 15:40:27 +02:00
Robert Hensing
5b055190e3 doc/stdenv: Clarify status of the hooks 2022-10-13 13:36:47 +02:00
Adam Joseph
0d0c03fb0b
coding-conventions.chapter.md: update to account for #89885 (#191378)
https://github.com/NixOS/nixpkgs/pull/89885 ensures that fetches are
done securely (i.e. without `--insecure`) when the `hash` parameter is one of
the four special "fake" hashes.  However the manual was not updated in that PR.
This commit updates the manual to account for the already-merged changes from
that PR.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-10-12 11:08:50 +02:00
Silvan Mosberger
8ec0837a72 Introduce dockerTools.buildNixShellImage 2022-10-07 22:04:22 +02:00
Дамјан Георгиевски
4e385bec15
add documentation for the pkgs.portableService tool (#193081)
* add documentation for the pkgs.portableService tool

as introduced in 499aebcf34

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-10-07 10:37:56 +02:00
Théo Zimmermann
2dc3552aa1 coqPackages.mkCoqDerivation: upgrade to Dune 3
And remove the version number from the corresponding attributes.
2022-10-02 14:42:28 +02:00
Robert Hensing
7f0d934f9a
Merge pull request #191540 from hercules-ci/nixosTest-modular
nixosTest: make modular
2022-09-28 10:27:45 +01:00
José Romildo
1f239257c5 maintainers/scripts/update.nix: make package name, pname and old version available to the update script 2022-09-26 22:16:19 -03:00
Ivv
2650d450a7
Merge pull request #190403 from IvarWithoutBones/dotnetmodule-fixes
buildDotnetModule: several usability improvements
2022-09-26 15:04:31 +02:00
Robert Hensing
6205d37747 nixos/testing: Improve option docs 2022-09-24 17:38:10 +01:00
Frederik Rietdijk
9e02095f4e Python docs: document attribute to use for non-PyPI projects 2022-09-22 13:31:58 +02:00
Robert Hensing
b2def3c2ce doc/postgresql-test-hook: Add example 2022-09-19 18:14:31 +01:00
Ivar Scholten
8e00d6ac26
buildDotnetModule: move nugetDeps throw to when its actually needed
Previously we had an assert that would complain when nugetDeps wasnt set,
which also didnt allow any passthru attributes (like fetch-deps) to be
build. That causes a cycle where you need nugetDeps to fetch the nuget
deps, but arent able to build the script to do so.
2022-09-18 18:00:37 +02:00
Ivar Scholten
03a1b62cb3
buildDotnetModule: dont require specifing a projectFile
In a lot of cases dotnet can figure this out by itself, so we can just
invoke it without the project argument.
2022-09-18 18:00:37 +02:00
Dennis Gosnell
533e1f0468
Merge pull request #190795 from cdepillabout/coq-add-docs
doc/language-frameworks/coq: add explanation of how to override packages
2022-09-16 09:09:09 -04:00
davidak
63f7b8c945
Merge pull request #190818 from IvarWithoutBones/testversion-doc
doc/testers: testVersion -> testers.testVersion, add example
2022-09-15 23:48:56 +02:00
Ivar Scholten
6c40872147
doc/testers: testVersion -> testers.testVersion, add example 2022-09-15 22:46:37 +02:00
Dennis Gosnell
6cc6850fe2
doc/language-frameworks/coq: add explanation of how to override packages 2022-09-15 09:18:20 -04:00
Matthieu Coudron
800323c0c0 doc(vim): take into account plug non-support
Apply suggestions from code review

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-09-11 20:33:01 +02:00
Matthieu Coudron
3944240476 doc(neovim): remove the mention of plug for neovim
This was removed to simplify configuration. One could create a function that converts the plug format to vim native package format (only plugin system supported for neovim)  and upstream it to nixpkgs if that's an issue
2022-09-11 18:11:16 +02:00
Matthieu Coudron
584bc20aa0 doc: present how to create a vim-plugin overlay
it is possible to maintain an out of tree list of neovim plugins with this method

Update doc/languages-frameworks/vim.section.md

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
2022-09-11 18:11:16 +02:00
Sandro
1bb33d6dbe
doc/contributing: fix whitespace 2022-09-07 01:01:48 +02:00
Anderson Torres
6be0f0e057
Merge pull request #189241 from SuperSandro2000/git-full-hash
doc/contributing: enforce full commit hashes on github
2022-09-05 21:26:05 -03:00
Sandro Jäckel
be09c1638d
doc/contributing: enforce full commit hashes on github 2022-09-04 00:50:35 +02:00
Ian Macalinao
30a5965216
doc/languages-frameworks/rust: fix typo 2022-09-03 15:45:21 -05:00
Marc Scholten
41de927b70 doc: Clarify default value of sourceRoot 2022-09-03 11:13:58 +02:00
pennae
3bddcf5f90
Merge branch 'master' into option-docs-md 2022-09-01 16:10:09 +02:00
pennae
9c3c13b50d nixos/make-options-doc: add inline roles for varname/envar
both of these render distinctly from plain literals in the manpage, and
manpages even semantically distinguish between the two.
2022-08-31 16:21:10 +02:00
Robert Hensing
62b25a28fe
Merge pull request #170906 from Sohalt/dockerTools.ca-certificates.crt
dockerTools ca-certificates.crt helper
2022-08-31 14:08:02 +02:00
Robert Hensing
507d35c207
Merge pull request #188805 from ncfavier/longDescription-format
doc: specify that `longDescription` should be Markdown
2022-08-30 00:13:02 +02:00
Naïm Favier
2f88279ab9
doc: specify that longDescription should be Markdown
In the spirit of RFC 72, document that longDescription is in CommonMark.
2022-08-29 20:19:34 +02:00
Martin Weinelt
986c31401e
doc/python: Properly sort pythonRelaxDepsHook in hook list 2022-08-24 23:03:31 +02:00
Martin Weinelt
8a26deba06
doc/python: integrate sphinxHook docs
Improve the documentation by moving it from the hook script into the
Python section in the manual and adding code examples.
2022-08-24 23:02:24 +02:00
Adam Joseph
aad7f1d6b3 doc/../rust.section.md: prominently mention buildRustXX names
This was a source of massive confusion for me when I first learned my way around nixpkgs' rust machinery.  I seek to save others from that confusion.

* `buildRustPackage` should have been named `buildRustPackageUsingCargo`

* `buildRustCrate` should have been named `buildRustPackageUsingNix`

It is, unfortunately, too late to fix this.  Let's do the next best thing and make the names `buildRustPackage` and `buildRustCrate` very prominent in the documentation, so readers see immediately that they need to learn the following jargon:

* `buildRustPackage` means "build this Rust crate by calling `cargo` in one (or two) monolithic derivations"

* `buildRustCrate` means "build this Rust crate by calling `rustc` in one derivation for each crate"
2022-08-22 14:37:41 -07:00
github-actions[bot]
318717f2e3
Merge master into staging-next 2022-08-20 00:02:22 +00:00
Valentin Gagarin
16eb45c655 doc: add note about makeWrapper and PATH modification 2022-08-19 13:11:27 -05:00
github-actions[bot]
954d3734e9
Merge master into staging-next 2022-08-17 12:01:28 +00:00
Alex James
c9af898255
dockerTools.buildImage: make VM memSize configurable
Fixes #186752. This adds buildVMMemorySize (defaults to 512 MiB) to
buildImage, which is passed to vm.runInLinuxVM. This is needed for
larger base images, which may otherwise cause container build failures
due to OOM in the VM.
2022-08-16 21:47:29 -05:00
github-actions[bot]
842c52c5ba
Merge staging-next into staging 2022-08-15 00:03:15 +00:00
Winter
dbd18a63a7 fetchgit: allow disabling cone mode for sparse checkouts, fix test 2022-08-14 23:03:07 +02:00
Winter
e8fbb38a51 pythonPackages.unittestCheckHook: init 2022-08-13 14:09:43 -04:00
Frederik Rietdijk
2270b66d75 pythonPackagesExtensions: override all Python package sets at once
Python package sets can be overridden by overriding an interpreter
and passing in `packageOverrides = self: super: {...};`. This is fine
in case you need a single interpreter, however, it does not help you
when you want to override all sets.

With this change it is possible to override all sets at once by
appending a list of "extensions" to `pythonPackagesExtensions`.

From reading the implementation you might wonder why a list is used, and
not
`lib.composeExtensions`? The reason is the latter requires knowledge of
the library function. This approach should be easier for most users
as it is similar to how we append to lists of e.g. inputs or patches
when overriding a derivation.
2022-08-06 09:39:39 +02:00
Florian Klink
00ff154265
Merge pull request #174093 from NixOS/doc-fakenss
nixos/doc: document fakeNss, binSh
2022-08-04 21:06:19 +07:00
Matthias Bartelmeß
0ff5e21ea2
Correct instructions to obtain a hash for git repos 2022-08-04 00:31:31 +02:00
Valentin Gagarin
671ce969a9
Merge pull request #179489 from Thornycrackers-Forks/fetcher-docs-update
doc/builders/fetchers: Add examples, reduce sentence complexity
2022-08-03 11:50:56 +02:00
Valentin Gagarin
163e81aac0
Merge pull request #184848 from jtojnar/mkder-rec-anchor
doc: Add anchor to Recursive attributes in `mkDerivation`
2022-08-03 11:18:36 +02:00
Cody Hiar
3c2cd351d4 Add example error message. 2022-08-02 11:07:36 -06:00
Cody Hiar
9c292dd02e Updating sha256 to more realistic example 2022-08-02 10:55:15 -06:00
Cody Hiar
0e91d53cc5
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:52:08 -06:00
Cody Hiar
0685e4a929
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:51:38 -06:00
Cody Hiar
6d0bf6ae05
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:51:09 -06:00
Cody Hiar
0444078dab
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:50:22 -06:00
Cody Hiar
53ffebbe1f
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:50:05 -06:00
Jan Tojnar
4cb8aa1324 doc: Add anchor to Recursive attributes in mkDerivation
So that we can link to it stably.
2022-08-02 18:01:03 +02:00
github-actions[bot]
ad090ff867
Merge master into staging-next 2022-08-02 00:02:24 +00:00
ajs124
0d5c464ad6 buildGoModule: add vendorHash
the _unset hack is kind of ugly, but it needs to default to something
and it can't be null, because that already has special meaning
2022-08-02 07:28:13 +10:00
github-actions[bot]
c8b4067ae8
Merge master into staging-next 2022-08-01 12:01:37 +00:00
Valentin Gagarin
c9c9d9a1b3
Merge pull request #182702 from SuperSandro2000/yarn2nix-doc
docs/javascript: advise to create less yarn.nix files
2022-08-01 08:46:06 +02:00
Florian Klink
6e254a6c35 nixos/doc: update contents to copyToRoot
contents is deprecated now, use the copyToRoot attribute.
2022-08-01 13:41:41 +07:00
Florian Klink
4393ed8679 Update doc/builders/images/dockertools.section.md
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-08-01 13:34:20 +07:00
Florian Klink
d84e7842a5 nixos/doc: document fakeNss, binSh 2022-08-01 13:34:20 +07:00
Sandro Jäckel
d92f25a1f4
docs/javascript: advise to create less yarn.nix files 2022-07-30 19:29:31 +02:00
github-actions[bot]
a37c393ba4
Merge staging-next into staging 2022-07-29 12:02:05 +00:00
Arnout Engelen
e1b3ee51e3
Merge pull request #183422 from raboof/nixpkgs-docs-consistent-ids
nixpkgs/doc: generate consistent docbook ids
2022-07-29 11:17:19 +02:00
Arnout Engelen
10670b0b96
nixpkgs/doc: generate consistent docbook ids
to make diff'ing different versions of the generated docs less noisy
2022-07-28 20:08:25 +02:00
github-actions[bot]
6a1cd17d72
Merge staging-next into staging 2022-07-28 18:01:55 +00:00
Arnout Engelen
ca95a7a25c
Merge pull request #183353 from raboof/nixpkgs-manual-unused-unfree
nixpkgs/doc: remove unused `unfree.xml`
2022-07-28 17:22:50 +02:00
Arnout Engelen
0dd7792b4c
nixpkgs/doc: remove unused unfree.xml
This section was broken out into its own file in efb55d2a42 but
apparently never actually got included anywhere.

Since then a more detailed section on using unfree packages has been
introduced.

Copied the introduction and removed the rest of the file.
2022-07-28 16:54:32 +02:00
github-actions[bot]
437247fc43
Merge staging-next into staging 2022-07-28 12:02:23 +00:00
Sandro
f358b0d40d
Merge pull request #182273 from mdarocha/dotnet-self-contained-build
buildDotnetModule: add option to make a self-contained build
2022-07-28 11:59:09 +02:00
Bernardo Meurer
88c63ca65a
Merge pull request #182513 from trofi/strip-for-host-and-target
gcc: enable stripping for cross-compilers
2022-07-28 00:30:49 -07:00
mdarocha
124fa63a88 buildDotnetModule: add documentation about selfContained flag 2022-07-26 18:03:03 +02:00
Sergei Trofimovich
0f45ce6e77 setup-hooks/strip.sh: add strip{All,Debug}ListTarget variables
This change mimics existing strip{All,Debug}List variables to
allow special stripping directories just for Target.

The primary use case in mind is gcc where package has to install
both host and target ELFs. They have to be stripped by their own
strip tools accordingly.

Co-authored-by: Rick van Schijndel <Mindavi@users.noreply.github.com>
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
2022-07-25 11:06:45 +01:00
Artturi
79e8669003
Merge pull request #179603 from Artturin/subplacemultiple 2022-07-24 04:14:09 +03:00
github-actions[bot]
a92f7ed60a
Merge staging-next into staging 2022-07-21 18:02:00 +00:00
Jan Tojnar
c80ea7da04
Merge pull request #177219 from kenranunderscore/correct-nixpkgs-review-invocations-in-docs
doc/contributing: replace outdated 'nix run' syntax for nixpkgs-review
2022-07-21 14:40:39 +02:00
Cody Hiar
f25dd50085
Update doc/builders/fetchers.chapter.md
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-07-18 11:26:51 -06:00
github-actions[bot]
97f117148f
Merge staging-next into staging 2022-07-17 00:02:54 +00:00
Valentin Gagarin
5a8c55c1e0
Merge pull request #181709 from aiotter/doc 2022-07-16 15:00:02 +01:00
aiotter
dbd75e3229 doc: update cmake doc for better readability 2022-07-16 19:10:31 +09:00
Artturi
192e3d44ac
Merge pull request #181302 from Artturin/fixcross4
lua-packages: fix eval failure when cross-compiling
2022-07-15 19:51:16 +03:00
github-actions[bot]
9303bacb57
Merge staging-next into staging 2022-07-15 12:01:52 +00:00
Valentin Gagarin
15edb27dd5
Merge pull request #177732 from tljuniper/python-doc-typos
doc/languages-frameworks: Fix typos
2022-07-15 11:50:54 +01:00
Artturin
c87635d917 doc: move makeWrapper to nativeBuildInputs from buildInputs
makeWrapper in buildInputs breaks cross-compilation with error: attribute 'runtimeShell' missing
2022-07-14 22:08:56 +03:00
github-actions[bot]
60c97a605c
Merge staging-next into staging 2022-07-13 18:02:06 +00:00
Luc Chabassier
65f330a83d
Update doc/languages-frameworks/coq.section.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-07-13 17:42:46 +02:00
github-actions[bot]
eb2dfaed06
Merge staging-next into staging 2022-07-13 12:01:56 +00:00
DwarfMaster
3d1205de91 doc: clarify coq override 2022-07-13 12:29:55 +02:00
Robert Hensing
3c1447f807
Merge pull request #121015 from fricklerhandwerk/docs-patch-shebangs
docs: expand explanation of patchShebangs hook
2022-07-13 12:17:11 +02:00
Valentin Gagarin
b7b86c4f54
add stable anchor
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2022-07-13 10:19:23 +01:00
Artturi
4427b7dfab
Merge pull request #177538 from Artturin/fixcross3 2022-07-12 16:14:46 +03:00
Matthieu Coudron
341b9564bb vimUtils: remove vam support
having this many (complex) options not only is hard to maintain but I cant see the benefit of these options now that vim supports packages
2022-07-10 20:38:09 +02:00
Jayson Henkel
cb7bea1312 Update grammar in vim section
Fixed a few grammatical issues. Was uncertain how to address Treesitter, as the homepage itself is inconsistent, using all combinations of Treesitter, Tree-sitter, treesitter and tree-sitter.
2022-07-08 15:09:32 +02:00
toonn
80ffac4097
Merge pull request #176661 from reckenrode/apple-sdk-11-x86_64
apple_sdk_11_0: make available for use on x86_64-darwin
2022-07-08 12:28:51 +02:00
Artturin
2cbce6b012 mesonEmulatorHook: check if the target binaries can be executed
this prevents having to bring in the emulator when compiling e.g. pkgsStatic
2022-07-07 21:29:53 +03:00
sohalt
c9d8e34fc4 dockerTools: document environment helpers 2022-07-07 14:50:23 +02:00
github-actions[bot]
312ad6d25c
Merge master into staging-next 2022-07-07 12:01:23 +00:00