about summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2023-11-08Merge pull request #265764 from amjoseph-nixpkgs/pr/pythonForBuildArtturi1-2/+2
2023-11-07doc: rename sub-section Recursive attributes in stdenv -> Fixed-point ↵Yueh-Shun Li1-1/+1
arguments in stdenv Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-07doc: add introduction to build helpersYueh-Shun Li1-0/+16
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-07doc: builders -> build helpers to reduce ambigualtyYueh-Shun Li19-17/+17
2023-11-07doc: darwin.linux-builder: replace "builder" with "remote builder"Yueh-Shun Li1-8/+8
2023-11-07doc: move section darwin-builder under chapter packagesYueh-Shun Li3-1/+1
2023-11-07doc: move doc/builders/packages -> doc/packagesYueh-Shun Li23-1/+1
2023-11-07texlive: document new texlive.withPackages interface (#265658)Vincenzo Mantova1-0/+40
2023-11-06Merge pull request #264674 from teutat3s/fix-dockertools-prefetch-exampleRobert Hensing1-1/+1
doc: fix dockerTools nix-prefetch-docker example
2023-11-05treewide: change pythonForBuild to pythonOnBuildForHostAdam Joseph1-2/+2
2023-11-02document differences to built-in fetchers (#263569)Valentin Gagarin1-4/+19
* document differences to built-in fetchers Co-authored-by: Alexander Groleau <source@proof.construction>
2023-11-01Merge pull request #250805 from xworld21/texlive-buildenv-minimalDmitry Kalinkin1-0/+18
texlive: overrideTeXConfig/withPackages
2023-10-31doc: fix dockerTools nix-prefetch-docker exampleteutat3s1-1/+1
2023-10-29luarocks-packages-update: init (#262156)Matthieu Coudron1-3/+3
* luarocks-packages-updater: init Goal is to make it possible to maintain out-of-tree luarocks packages without needing to clone nixpkgs. maintainers/scripts/update-luarocks-packages gets renamed to pkgs/development/lua-modules/updater/updater.py Once merged you can run for instance nix run nixpkgs#luarocks-packages-updater -- -i contrib/luarocks-packages.csv -o contrib/generated-packages.nix I also set the parallelism (--proc) to 1 by default else luarocks fails because of https://github.com/luarocks/luarocks/issues/1540 * Update maintainers/scripts/pluginupdate.py Co-authored-by: Marc Jakobi <mrcjkb89@outlook.com> --------- Co-authored-by: Marc Jakobi <mrcjkb89@outlook.com>
2023-10-28fetchFromBittorrent: Rename to fetchtorrentEirik Wittersø1-5/+5
2023-10-26Merge pull request #258595 from fricklerhandwerk/doc-emscriptenValentin Gagarin1-156/+141
Emscripten docs: reword and remove mention of `nix-env`
2023-10-24doc: use lib.fakeHash with buildGoModule to get vendorHashStel Abrego1-1/+1
lib.fakeSha256 results in `error: hash <fake_hash> does not include a type, nor is the type otherwise known from context`.
2023-10-24Merge pull request #262301 from ShamrockLee/doc-lib-customisationSilvan Mosberger1-0/+1
Generate and refine documentation for `lib.customisation`
2023-10-23doc/stdenv: rewrite manual build procedure to be closer to an auto-build ↵Jade Lovelace1-6/+43
(#262137) * doc/stdenv: rewrite manual build procedure to be closer to an auto-build This is based on <https://jade.fyi/blog/building-nix-derivations-manually/> plus some more original research. The previous version of this section did not work for your choice of simple Haskell package, e.g. haskellPackages.hscolour, due to things like `compileBuildDriverPhase` and other custom phases that it does not address at all. It seems more correct to use genericBuild in development to harmonize it with what is actually done. I feel a little bit like I am committing a sin by suggesting using the experimental CLI in the manual (afaict I am the first to do this), but I have given the old version of the command, and there are justifiable reasons to do it: * The noted limitations with env-vars are fixed. The one with the non-empty temp directory was one I ran into myself and oh boy was that not fun to debug. * Additionally the outputs are set *before* sourcing `setup.sh`: there is an issue with nix-shell where the original version of `$out` winds up in `NIX_LDFLAGS` due to _addRpathPrefix, which means that resulting executables may not run properly. It is sad that `nix develop` propagates a wrong value of `SHELL` to builders, though. It is equally sad that `nix-shell` is essentially abandoned upstream, with undocumented and not insignificant differences from `nix develop`. For the exact script differences: https://github.com/NixOS/nix/blob/17e6b85d05b3d32df244b1d4e89aa41fd8bdcae8/src/nix-build/nix-build.cc#L516-L551 https://github.com/NixOS/nix/blob/db026103b18fb8b5a719594502edd0f89eb9c268/src/nix/get-env.sh Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-10-21Merge pull request #231483 from hacker1024/feature/flutter-on-dartMaciej Krüger1-3/+4
buildFlutterApplication: Wrap buildDartApplication
2023-10-21doc/python: mention python313Martin Weinelt1-0/+1
2023-10-21buildDartApplication: Use package override mechanism from ↵hacker10241-3/+4
buildFlutterApplication This allows Dart applications to benefit from the package override system, which is useful for things like FFI dependencies.
2023-10-20doc: generate documentation for lib.customisationYueh-Shun Li1-0/+1
2023-10-19Merge pull request #260770 from hercules-ci/darwin-builder-observableRobert Hensing1-0/+14
`darwin.linux-builder`: Make more observable
2023-10-18fetchFromBittorrent: initmatthewcroughan1-0/+23
Adds a basic FOD Fetcher for Bittorrent that uses Transmission as a client Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-10-16Merge pull request #251190 from alejandrosame/docs-mention-nrdSilvan Mosberger1-0/+1
doc manuals: add reference to nixos-render-docs
2023-10-12darwin.linux-builder: Expose nixosConfig and nixosOptions attributesRobert Hensing1-0/+14
I chose not to do nixos.{config, options} because that would make it look too much like a configuration object, which it is not. A configuration object I would define as for example the result of calling NixOS, an attrset with `_type = "configuration";`. Recreating a configuration object without evalModules is quite feasible but not guaranteed to be correct, and not maintainable.
2023-10-09link to documentation on IFD in the Nix manualValentin Gagarin1-1/+1
2023-10-08Merge pull request #258384 from doronbehar/buildNpmPackage-makeWrapperArgsDoron Behar1-1/+15
buildNpmPackage: support makeWrapperArgs
2023-10-07texlive: document new texlive.pkgs attributeVincenzo Mantova1-0/+18
2023-10-07buildNpmPackage: support makeWrapperArgsDoron Behar1-0/+1
2023-10-07docs/javascript/buildNpmPackage: Document fetchNpmDepsDoron Behar1-1/+10
Co-authored-by: Lily Foster <lily@lily.flowers>
2023-10-07docs/javascript/buildNpmPackage: Document bin, man and npm pack behaviorDoron Behar1-0/+4
2023-10-04Merge master into haskell-updatesgithub-actions[bot]1-5/+6
2023-10-03Merge pull request #253714 from teto/vim-updater-packageMatthieu Coudron1-5/+6
2023-10-03Merge master into haskell-updatesgithub-actions[bot]2-0/+19
2023-10-03emscripten docs: reformat examples to use admonitionValentin Gagarin1-113/+128
that way the examples will also appear in the appendix Co-authored by: Henrik Karlsson <i97henka@gmail.com>
2023-10-03emscripten docs: reword introductionValentin Gagarin1-40/+10
in particular, remove mention of `nix-env` Co-authored by: Henrik Karlsson <i97henka@gmail.com>
2023-10-02doc: minimal documentation of supported platformsLorenzo Manacorda2-0/+19
This commit adds minimal documentation of the supported platforms. More exhaustive documentation would require producing a list of platforms for each of the 7 tiers. This was attempted in #245368, but it quickly became clear that that would be a long-term effort. In the meantime, this commit adds the most important information to the manual. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-10-01vimPluginsUpdater: initMatthieu Coudron1-5/+6
The nixpkgs documentation mentions how to update out of tree plugins but one problem is that it requires a nixpkgs clone. This makes it more convenient. I've had the need to generate vim plugins and lua overlays for other projects unrelated to nix and this will make updates easier (aka just run `nix run nixpkgs#vimPluginsUpdater -- --proc=1` or with the legacy commands: `nix-shell -p vimPluginsUpdater --run vim-plugins-updater`. I added an optional "nixpkgs" argument to command line parser, which is the path towards a nixpkgs checkout. By default the current folder. update-luarocks-packages: format with black
2023-09-30Merge master into haskell-updatesgithub-actions[bot]1-4/+47
2023-09-29nixpkgs manual: add an alternative example in stdenv-separateDebugInfo (#257861)Alejandro Sánchez Medina1-4/+47
* nixpkgs manual: add an alternative example in stdenv-separateDebugInfo This change gets rid of the indirect reference to `nix-env -i` usage and shows how to achieve the same goal with a shell expression. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-09-29Merge master into haskell-updatesgithub-actions[bot]4-5/+5
2023-09-28treewide: Fix typosPeder Bergebakken Sundt4-5/+5
2023-09-28Merge master into haskell-updatesgithub-actions[bot]2-2/+2
2023-09-27vimUtils: buildVimPluginFrom2Nix renamed to buildVimPluginMatthieu Coudron1-1/+1
the `from2Nix` suffix is a legacy from vim2nix but we dont use that anymore. It makes the name of the function unusual and long.
2023-09-27doc: fix wrong flag in description of `bindnow`Felix Yan1-1/+1
`-z bindnow` doesn't exist. The actual flag added is `-z now`.
2023-09-26Merge master into haskell-updatesgithub-actions[bot]3-45/+11
2023-09-25use `nix-shell -p` for `dhall-to-nixpkgs` exampleValentin Gagarin1-5/+6
2023-09-25remove the misleading warning on using `nix-env` for split outputs (#255947)Valentin Gagarin1-39/+5
The text was originally added [0] following an apparently incomplete research on how everything plays together. In fact, Nix propagates `outputs` to the corresponding nested derivations, and there is some messy behavior in Nixpkgs that only seems to propagate `meta.outputsToInstall` in `buildEnv`[1]. This change moves the hints on how to use NixOS specifics to NixOS module documentation (which is hopefully easier to find through search.nixos.org), describes the default behavior in Nixpkgs (updating a the link to the source), and removes the confusing mention of `nix-env`. the last of them should not be there to begin with. we don't want beginners to use `nix-env`, as this is known to run them into trouble eventually. [0]: https://github.com/NixOS/nixpkgs/pull/76794 [1]: https://github.com/NixOS/nixpkgs/blob/1774d07242995050d2d8a91cb4da0855eac2e472/pkgs/build-support/buildenv/default.nix#L66