about summary refs log tree commit diff
path: root/doc
Commit message (Collapse)AuthorAge
* trivial-builders: Deduplicate docsRobert Hensing2024-03-11
| | | | | I didn't have the opportunity to do all work at once, so I've added TODOs to bring attention to the situation.
* Merge pull request #289231 from adisbladis/fetchnpmlockadisbladis2024-03-08
|\ | | | | importNpmLock: init
| * importNpmLock: initadisbladis2024-03-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is an alternative to `fetchNpmDeps` that is notably different in that it uses metadata from `package.json` & `package-lock.json` instead of specifying a fixed-output hash. Notable features: - IFD free. - Only fetches a node dependency once. No massive FODs. - Support for URL, Git and path dependencies. - Uses most of the existing `npmHooks` `importNpmLock` can be used _only_ in the cases where we need to check in a `package-lock.json` in the tree. Currently this means that we have 13 packages that would be candidates to use this function, though I expect most usage to be in private repositories. This is upstreaming the builder portion of https://github.com/adisbladis/buildNodeModules into nixpkgs (different naming but the code is the same). I will archive this repository and consider nixpkgs the new upstream once it's been merged. For more explanations and rationale see https://discourse.nixos.org/t/buildnodemodules-the-dumbest-node-to-nix-packaging-tool-yet/35733 Example usage: ``` nix stdenv.mkDerivation { pname = "my-nodejs-app"; version = "0.1.0"; src = ./.; nativeBuildInputs = [ importNpmLock.hooks.npmConfigHook nodejs nodejs.passthru.python # for node-gyp npmHooks.npmBuildHook npmHooks.npmInstallHook ]; npmDeps = buildNodeModules.fetchNodeModules { npmRoot = ./.; }; } ```
* | doc/lua.section.md: update lua documentationMatthieu Coudron2024-03-06
| |
* | Remove top level `with lib;` in docs (#293829)Philip Taron2024-03-06
| |
* | Nix docs: remove `with lib;` from example codeAnderson Torres2024-03-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Following [Best Practices](https://nix.dev/guides/best-practices#with-scopes), `with` is a problematic language construction and should be avoided. Usually it is employed like a "factorization": `[ X.A X.B X.C X.D ]` is written `with X; [ A B C D ]`. However, as shown in the link above, the syntatical rules of `with` are not so intuitive, and this "distributive rule" is very selective, in the sense that `with X; [ A B C D ]` is not equivalent to `[ X.A X.B X.C X.D ]`. However, this factorization is still useful to "squeeze" some code, especially in lists like `meta.maintainers`. On the other hand, it becomes less justifiable in bigger scopes. This is especially true in cases like `with lib;` in the top of expression and in sets like `meta = with lib; { . . . }`. That being said, this patch removes most of example code in the current documentation. The exceptions are, for now - doc/functions/generators.section.md - doc/languages-frameworks/coq.section.md because, well, they are way more complicated, and I couldn't parse them mentally - yet another reason why `with` should be avoided!
* | python38: removeMartin Weinelt2024-03-05
| | | | | | | | | | | | The end of life for Python 3.8 is scheduled for 2024/10. As such it cannot be a part of NixOS 24.05, because its support cycle goes past that.
* | doc: small fix for nightly in derivation snippet (#292688)Leon2024-03-04
|/
* Merge pull request #293163 from Aleksanaa/doc/qtK9002024-03-04
|\ | | | | doc/qt: minor fixes
| * doc/qt: minor fixesaleksana2024-03-04
| |
* | doc: update docs for portableService, follow doc conventionsDS2024-02-29
| |
* | Merge pull request #290886 from DanielSidhion/update-ocitoolsSilvan Mosberger2024-02-29
|\ \ | | | | | | doc: update docs in ociTools, follow doc conventions
| * | doc: update docs in ociTools, follow doc conventionsDS2024-02-29
| | |
* | | Merge pull request #291715 from DanielSidhion/document-private-keyDaniel Sidhion2024-02-28
|\ \ \ | | | | | | | | doc: document publicly-known private key for darwin.linux-builder
| * | | doc: document publicly-known private key for darwin.linux-builderDS2024-02-26
| | | |
* | | | doc: fix darwin-builder doc (#291518)yihuang2024-02-28
| | | |
* | | | Merge pull request #282886 from WxNzEMof/docker-tools-uidRobert Hensing2024-02-28
|\ \ \ \ | |/ / / |/| | | Allow streaming layered containers with non-root Nix store
| * | | Document the new streamLayeredImage parametersWxNzEMof2024-02-26
| | | |
* | | | doc: Fix typo resulting in broken link in manualMihai Maruseac2024-02-26
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | I was looking at https://nixos.org/manual/nixpkgs/stable/#buildpythonpackage-parameters to import a Python package and noticed that the link for the `hooks` in `pyproject` option is broken due to a typo (used <kbd>0</kbd> instead of <kbd>)</kbd>). Signed-off-by: Mihai Maruseac <mihai.maruseac@gmail.com>
* | | Merge branch 'master' into staging-nextWeijia Wang2024-02-23
|\| |
| * | doc/fetchers: document downloadToTemp for fetchurl (#288762)Matthieu Coudron2024-02-22
| | | | | | | | | | | | | | | * doc/fetchers: document downloadToTemp for fetchurl Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
* | | Merge master into staging-nextgithub-actions[bot]2024-02-20
|\| |
| * | Merge pull request #271597 from adisbladis/python-runtime-build-time-sepMartin Weinelt2024-02-20
| |\ \ | | | | | | | | python3.pkgs.buildPythonPackage: Separate runtime & build time dependencies
| | * | mk-python-derivation: Add build-system argumentadisbladis2024-02-18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Much like the previous commit that adds dependencies & optional-dependencies this aligns PEP-517 build systems with how they are defined in PEP-518/PEP-621. The naming `build-system` (singular) is aligned with upstream Python standards.
| | * | mk-python-derivation: Add dependencies & optional-dependencies argumentsadisbladis2024-02-18
| | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since https://github.com/NixOS/nixpkgs/pull/161835 we've had the concept of `passthru.optional-dependencies` for Python optional deps. Having to explicitly put optional-dependencies in the passthru attrset is a bit strange API-wise, even though it semantically makes sense. This change unifies the handling of non-optional & optional Python dependencies using the names established from PEP-621 (standardized pyproject.toml project metadata).
* | | Merge master into staging-nextgithub-actions[bot]2024-02-19
|\| |
| * | Merge pull request #289584 from athre0z/docker-zstdRobert Hensing2024-02-19
| |\ \ | | |/ | |/| dockerTools: configurable compression schema
| | * dockerTools: configurable compression schemaJoel Höner2024-02-17
| | | | | | | | | | | | | | | | | | This commit adds support for swapping out the compression algorithm used in all major docker-tools commands that generate images. The default algorithm remains unchanged (gzip).
* | | buildLuarocksPackage: accept structured luarocks configMatthieu Coudron2024-02-17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There is an arbitrary mapping being done right now between nixpkgs lua infrastructre and luarocks config schema. This is confusing if you use lua so let's make it possible to use the lua names in the nixpkgs, thanks to the lib.generators.toLua convertor. The only nixpkgs thing to remember should be to put the config into `luarocksConfig` `buildLuarocksPackage.extraVariables` should become `buildLuarocksPackage.luarocksConfig.variables`
* | | Merge staging-next into staginggithub-actions[bot]2024-02-15
|\| |
| * | Merge pull request #288414 from DanielSidhion/last-dockertools-fixesSilvan Mosberger2024-02-15
| |\ \ | | | | | | | | doc: update dockerTools to use long-form docker commands, improve wording
| | * | doc: use long-form docker commands, improve wordingDS2024-02-12
| | | |
| * | | Merge pull request #288681 from thanegill/patch-6Silvan Mosberger2024-02-15
| |\ \ \ | | | | | | | | | | Docs: Fix syntax error in darwin-builder.section.md
| | * | | Fix syntax error in darwin-builder.section.mdThane Gill2024-02-13
| | |/ /
| * | | Merge pull request #287331 from booniepepper/doc/prefer-cargoHash-attributeSilvan Mosberger2024-02-15
| |\ \ \ | | |/ / | |/| | doc: consistently prefer and lead with cargoHash over cargoSha256
| | * | doc: consistently prefer and lead with cargoHash over cargSha256Justin "J.R." Hill2024-02-08
| | |/
* | | Merge pull request #287957 from DavHau/pythonlassulus2024-02-13
|\ \ \ | |/ / |/| | pythonCatchConflictsHook: scan $out, not sys.path (2)
| * | pythonCatchConflictsHook: improve docsDavHau2024-02-13
| |/
* | Merge pull request #287169 from K900/qt-docsK9002024-02-12
|\ \ | |/ |/| doc/qt: refresh
| * doc/qt: refreshK9002024-02-11
| | | | | | | | | | | | Make examples don't require a custom callPackage, remove note on multiversioning, reword a few things. Fixes #287015
* | doc: update buildNixShellImage docs, add streamNixShellImage docsDS2024-02-08
| |
* | Merge pull request #285223 from DanielSidhion/update-dockertools-envhelpersSilvan Mosberger2024-02-08
|\ \ | | | | | | doc: update environment helpers in dockerTools docs, add fakeNss section
| * | doc: update environment helpers in dockerTools docs, add fakeNss sectionDS2024-02-01
| | | | | | | | | | | | Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
* | | Merge pull request #286483 from ysndr/fix/doc/installmanpage/outputSilvan Mosberger2024-02-08
|\ \ \ | | | | | | | | fix: include reference and link to `outputMan` in the doc of `installManPage`
| * | | fix: include reference and link to `outputMan`Yannik Sander2024-02-05
| | |/ | |/|
* | | Merge pull request #285655 from itslychee/revision/dotnet-docsSilvan Mosberger2024-02-08
|\ \ \ | |/ / |/| | doc: clarify usage of nuget-to-nix in dotnet.section.md
| * | doc: clarify usage of nuget-to-nix in dotnet.section.mdlychee2024-02-04
| | | | | | | | | | | | | | | | | | I believe it would be helpful to better explain how to use `nuget-to-nix` for those who aren't familar with the .NET ecosystem as I was personally stumped on how to use it.
* | | Merge pull request #284632 from OPNA2608/fix/dart-docs-unstableVersionWeijia Wang2024-02-04
|\ \ \ | | | | | | | | docs/dart: Update unstable version example
| * | | docs/dart: Update unstable version exampleOPNA26082024-01-29
| |/ /
* | | Merge pull request #283080 from marsam/postgresql-test-hook-settingsMario Rodas2024-02-04
|\ \ \ | | | | | | | | postgresqlTestHook: add postgresqlExtraSettings variable