Commit Graph

3176 Commits

Author SHA1 Message Date
K900
9bea2c4d93
Merge pull request #293163 from Aleksanaa/doc/qt
doc/qt: minor fixes
2024-03-04 10:52:45 +03:00
aleksana
cdc9e1d100 doc/qt: minor fixes 2024-03-04 15:50:03 +08:00
github-actions[bot]
a1ed79952d
Merge master into haskell-updates 2024-03-01 00:14:10 +00:00
DS
62552e3683 doc: update docs for portableService, follow doc conventions 2024-02-29 17:10:01 +01:00
Silvan Mosberger
67e55070eb
Merge pull request #290886 from DanielSidhion/update-ocitools
doc: update docs in ociTools, follow doc conventions
2024-02-29 16:32:36 +01:00
DS
c73de6fac3 doc: update docs in ociTools, follow doc conventions 2024-02-29 16:30:04 +01:00
github-actions[bot]
47e7b83fd1
Merge master into haskell-updates 2024-02-29 00:12:06 +00:00
Daniel Sidhion
3ef3dbe6d5
Merge pull request #291715 from DanielSidhion/document-private-key
doc: document publicly-known private key for darwin.linux-builder
2024-02-28 06:37:18 -08:00
yihuang
267735f785
doc: fix darwin-builder doc (#291518) 2024-02-28 06:36:13 -08:00
Robert Hensing
57c1108204
Merge pull request #282886 from WxNzEMof/docker-tools-uid
Allow streaming layered containers with non-root Nix store
2024-02-28 03:43:07 +01:00
DS
fced134442 doc: document publicly-known private key for darwin.linux-builder 2024-02-26 17:37:53 -08:00
github-actions[bot]
7e5ed63169
Merge master into haskell-updates 2024-02-27 00:12:52 +00:00
WxNzEMof
7799f4695b Document the new streamLayeredImage parameters 2024-02-26 18:41:07 +00:00
Mihai Maruseac
c786e63c70
doc: Fix typo resulting in broken link in manual
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>
2024-02-26 05:20:16 -08:00
Wolfgang Walther
72e03b91ea
haskellPackages: add dontCheckIf helper
Using this helper will prevent introducing problematic doCheck = condition overrides,
which accidentally re-enable previously disabled tests.
2024-02-26 12:32:02 +01:00
github-actions[bot]
257171f024
Merge master into haskell-updates 2024-02-25 00:13:49 +00:00
Weijia Wang
5f5062d1ef Merge branch 'master' into staging-next 2024-02-23 05:09:55 +01:00
github-actions[bot]
c1d60ca8ac
Merge master into haskell-updates 2024-02-23 00:12:05 +00:00
Matthieu Coudron
0c3eca2682
doc/fetchers: document downloadToTemp for fetchurl (#288762)
* doc/fetchers: document downloadToTemp for fetchurl

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-02-22 16:10:21 +01:00
github-actions[bot]
f694e31ceb
Merge master into haskell-updates 2024-02-21 00:12:23 +00:00
github-actions[bot]
ba5eeff4f5
Merge master into staging-next 2024-02-20 06:01:15 +00:00
Martin Weinelt
fa83add1b9
Merge pull request #271597 from adisbladis/python-runtime-build-time-sep
python3.pkgs.buildPythonPackage: Separate runtime & build time dependencies
2024-02-20 05:05:20 +01:00
github-actions[bot]
ec769627e0
Merge master into haskell-updates 2024-02-20 00:12:32 +00:00
github-actions[bot]
2d9ce4a9af
Merge master into staging-next 2024-02-19 18:01:11 +00:00
Robert Hensing
d2dfcfcfad
Merge pull request #289584 from athre0z/docker-zstd
dockerTools: configurable compression schema
2024-02-19 18:06:54 +01:00
adisbladis
4d0cca4654 mk-python-derivation: Add build-system argument
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.
2024-02-18 17:40:42 +13:00
adisbladis
b9138b7c07 mk-python-derivation: Add dependencies & optional-dependencies arguments
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).
2024-02-18 17:40:42 +13:00
Joel Höner
4b603ad9cd dockerTools: configurable compression schema
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).
2024-02-17 18:52:42 +01:00
Matthieu Coudron
50e877ed89 buildLuarocksPackage: accept structured luarocks config
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`
2024-02-17 15:58:13 +01:00
github-actions[bot]
02be936be3
Merge master into haskell-updates 2024-02-16 00:12:20 +00:00
github-actions[bot]
2035b66b68
Merge staging-next into staging 2024-02-15 18:01:39 +00:00
Silvan Mosberger
298083e3b4
Merge pull request #288414 from DanielSidhion/last-dockertools-fixes
doc: update dockerTools to use long-form docker commands, improve wording
2024-02-15 16:16:26 +01:00
Silvan Mosberger
882a2fb83f
Merge pull request #288681 from thanegill/patch-6
Docs: Fix syntax error in darwin-builder.section.md
2024-02-15 16:14:39 +01:00
Silvan Mosberger
fc407cfdf9
Merge pull request #287331 from booniepepper/doc/prefer-cargoHash-attribute
doc: consistently prefer and lead with cargoHash over cargoSha256
2024-02-15 16:14:03 +01:00
Thane Gill
9d22da290a
Fix syntax error in darwin-builder.section.md 2024-02-13 14:07:27 -08:00
lassulus
38905fc7ee
Merge pull request #287957 from DavHau/python
pythonCatchConflictsHook: scan $out, not sys.path (2)
2024-02-13 14:22:53 +07:00
DavHau
a299915fff pythonCatchConflictsHook: improve docs 2024-02-13 11:15:41 +07:00
github-actions[bot]
ed9046f8aa
Merge master into haskell-updates 2024-02-13 00:13:09 +00:00
DS
ba79b098ea doc: use long-form docker commands, improve wording 2024-02-12 15:38:00 -08:00
K900
4dd212239e
Merge pull request #287169 from K900/qt-docs
doc/qt: refresh
2024-02-12 14:47:20 +03:00
K900
76081bed3a doc/qt: refresh
Make examples don't require a custom callPackage, remove note on multiversioning, reword a few things.

Fixes #287015
2024-02-11 11:02:39 +03:00
github-actions[bot]
ae051d93c2
Merge master into haskell-updates 2024-02-09 00:12:19 +00:00
Justin "J.R." Hill
0f7d690e48
doc: consistently prefer and lead with cargoHash over cargSha256 2024-02-08 15:41:32 -08:00
DS
5677230de3 doc: update buildNixShellImage docs, add streamNixShellImage docs 2024-02-08 07:49:16 -08:00
Silvan Mosberger
b94e9dd7a5
Merge pull request #285223 from DanielSidhion/update-dockertools-envhelpers
doc: update environment helpers in dockerTools docs, add fakeNss section
2024-02-08 16:31:33 +01:00
Silvan Mosberger
39452ae8af
Merge pull request #286483 from ysndr/fix/doc/installmanpage/output
fix: include reference and link to `outputMan` in the doc of `installManPage`
2024-02-08 16:28:46 +01:00
Silvan Mosberger
50cb21e1dc
Merge pull request #285655 from itslychee/revision/dotnet-docs
doc: clarify usage of nuget-to-nix in dotnet.section.md
2024-02-08 16:27:31 +01:00
Yannik Sander
ae9e8a4b83
fix: include reference and link to outputMan 2024-02-05 13:35:49 +01:00
github-actions[bot]
3a0aae25fa
Merge master into haskell-updates 2024-02-05 00:13:15 +00:00
Weijia Wang
8e45a04cc3
Merge pull request #284632 from OPNA2608/fix/dart-docs-unstableVersion
docs/dart: Update unstable version example
2024-02-04 21:39:13 +01:00
lychee
38048e0fbe
doc: clarify usage of nuget-to-nix in dotnet.section.md
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.
2024-02-04 14:08:11 -06:00
Mario Rodas
1be8478d00
Merge pull request #283080 from marsam/postgresql-test-hook-settings
postgresqlTestHook: add postgresqlExtraSettings variable
2024-02-04 06:36:16 -05:00
github-actions[bot]
f7af6d355f
Merge master into haskell-updates 2024-02-03 00:12:45 +00:00
Shea Levy
43ec00acab
Merge branch 'optionalDrvAttr' 2024-02-02 16:30:17 -05:00
Shea Levy
ca1262a483
lib: Add optionalDrvAttr to conditionally set drv attributes.
This allows for adding new, conditionally set, derivation attributes
to an existing derivation without changing any output paths in the
case where the condition is not met.
2024-02-02 16:27:30 -05:00
github-actions[bot]
34dab68635
Merge master into haskell-updates 2024-02-02 00:12:11 +00:00
Rebecca Turner
41376dd064
writeShellApplication: Update manual 2024-02-01 16:02:34 -08:00
Yt
8530feb642
Merge pull request #233587 from Munksgaard/fix-beam-modules-quotation-marks
beam-modules: Fix missing quotation marks
2024-02-01 18:49:45 +00:00
Daniel Sidhion
2f61aff9ae
doc: update dockerTools.exportImage content and use doc conventions (#283392)
* doc: update dockerTools.exportImage content and use doc conventions

* Apply suggestions from code review

Co-authored-by: Silvan Mosberger <github@infinisil.com>

---------

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-02-01 16:54:26 +01:00
Silvan Mosberger
625f2cefb6
Merge pull request #284097 from cpick/doc-nixpkgs-unstable
doc: consistently use nixpkgs-unstable and "nixpkgs repository"
2024-02-01 16:52:32 +01:00
DS
0445c39047 doc: update environment helpers in dockerTools docs, add fakeNss section
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2024-02-01 01:37:31 -08:00
github-actions[bot]
05ce1c8cd3
Merge master into haskell-updates 2024-02-01 00:13:01 +00:00
sternenseemann
571a07d774 doc/haskell: don't use lib.recursiveUpdate in overlays
`lib.recursiveUpdate` indiscriminately recurses into all attribute sets,
also into derivations. This means that it is possible that evaluating a
derivation in the final haskell package set can cause something in
`prev.haskell` to be forced by `recursiveUpdate`, potentially causing an
evaluation error that should not happen.

It can be fixed using a well-crafted predicate for
`lib.recursiveUpdateUntil`, but most robust is just explicitly writing
out the desired merging manually.
2024-01-31 23:49:32 +01:00
Peder Bergebakken Sundt
aa10fea3ef
Merge pull request #222817 from SuperSandro2000/python-sitePackages
treewide: replace `lib/${python.libPrefix}/site-packages` with its sh…
2024-01-31 16:34:30 +01:00
Sandro
9cf8b8bab3
doc: clarify python.sitePackages
Co-authored-by: Peder Bergebakken Sundt <pbsds@hotmail.com>
2024-01-31 14:34:19 +01:00
Sandro Jäckel
653837881e
treewide: replace lib/${python.libPrefix}/site-packages with its shorthand ${python.sitePackages}
which should be always preferred
2024-01-30 19:56:57 +01:00
Chris Pick
e78516b950 doc: consistently use nixpkgs-unstable and "nixpkgs repository"
Rename channel `nixpkgs` to `nixpkgs-unstable`. Based on the
[repo branches](https://github.com/NixOS/nixpkgs/branches)
and [channel status](https://status.nixos.org) I don't believe there is
a `nixpkgs` channel.  This confused me as a Nixpkgs beginner.
Rename to `nixpkgs-unstable`, which does exist.

Refer to "nixpkgs repository" consitently.  Make the capitalization and
"code quoting" consistent when referring to the repository itself.
2024-01-30 13:19:17 -05:00
github-actions[bot]
b0233d387c
Merge master into haskell-updates 2024-01-30 00:12:10 +00:00
Johannes Kirschbauer
48a2178434 adds block_args for autogenerated ids from trustworthy sources 2024-01-29 22:29:39 +01:00
OPNA2608
8dff0785cc docs/dart: Update unstable version example 2024-01-29 00:06:18 +01:00
github-actions[bot]
11b995fb74
Merge master into haskell-updates 2024-01-27 00:11:54 +00:00
Fabián Heredia Montiel
b975d1413e
Merge pull request #283648 from mattpolzin/idris2-lsp
idris2Packages.idris2Lsp: init at 2024-01-21
2024-01-25 19:21:38 -06:00
github-actions[bot]
acd0181532
Merge master into haskell-updates 2024-01-26 00:12:48 +00:00
Silvan Mosberger
2c2b366c59
Merge pull request #283106 from DanielSidhion/update-dockertools-pullimage
doc: update dockerTools.pullImage content and use doc conventions
2024-01-25 16:54:18 +01:00
DS
e08482a601 doc: update dockerTools.pullImage content and use doc conventions 2024-01-25 16:51:27 +01:00
Alejandro Sanchez Medina
a63b9c15c9 doc: Update manuals bespoke syntax
doc: add figure definition to bespoke syntax reference

doc: add example definition to bespoke syntax reference

doc: add footnote definition to beskpoke syntax reference

The usage of footnotes in the manuals is not the one documented
in markdown-it-py: https://python-markdown.github.io/extensions/footnotes/

doc: add inline comment definition to beskpoke syntax reference

doc: add typographic replacements to beskpoke syntax reference

doc: Fix rendering of bespoke syntax reference

doc: remove references to DocBook in the NixOS manual

doc: add entry on lack of HTML support

doc: Minor improvement

doc: update typographic replacements entry in beskpoke syntax reference

doc: add link reference definitions to beskpoke syntax reference

doc: fix footnote definition in beskpoke syntax reference

doc: Minor improvements from code review

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-01-25 16:33:35 +01:00
Silvan Mosberger
f7609960db
Merge pull request #283394 from DanielSidhion/fix-dockertools-example
doc: add missing attribute to example in dockerTools
2024-01-25 16:19:30 +01:00
DS
a731d0cb71 doc: update conventions with repl examples and function (in|out)puts 2024-01-25 07:17:30 -08:00
Kevin Brubeck Unhammer
ad99ac9356
doc: Note on how to use shadowSetup with buildLayeredImage (#267220)
* Note on how to use shadowSetup with buildLayeredImage

* Update doc/build-helpers/images/dockertools.section.md

---------

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-01-25 16:10:21 +01:00
Sam
1cbd2ac8f8
doc: Fix typo in dotnet.section.md (#282685)
It should be `dotnetCorePackages.sdk_6_0`, not `dotnetCorePackages.sdk_6.0`
2024-01-25 16:06:58 +01:00
Valentin Gagarin
848f518363
doc: add types to template (#281220)
* doc: add types to template

* mention types explicitly

* use separator that allows for more items in the type declaration

Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>

---------

Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>
2024-01-25 16:06:24 +01:00
sternenseemann
65fc44c341 haskell.compiler.ghc8102Binary: remove at 8.10.2
Since 46f14d30aa, it no longer has any
users in nixpkgs.
2024-01-25 15:20:35 +01:00
Vladimír Čunát
3f23d91f84
Merge branch 'master' into haskell-updates 2024-01-25 15:03:20 +01:00
Mathew Polzin
dfe61cf96a doc: update idris2 documentation on buildIdris 2024-01-23 23:35:17 -06:00
DS
ad83240aad doc: add missing attribute to example in dockerTools 2024-01-23 20:58:41 -08:00
github-actions[bot]
e6af56d8dd
Merge master into haskell-updates 2024-01-23 00:13:24 +00:00
github-actions[bot]
3c7375b75c
Merge master into staging-next 2024-01-22 18:00:55 +00:00
sternenseemann
2f8dcca4a9 haskellPackages.ghc: 9.6.3 -> 9.6.4 2024-01-22 15:14:41 +01:00
Julian Stecklina
1b7e43471f doc: remove misleading kernel.features explanation
At this point kernel.features is more of an implementation detail and
normal users should not come into contact with it.
2024-01-22 13:19:32 +01:00
Mario Rodas
70b51d8d17 postgresqlTestHook: add postgresqlExtraSettings variable
Add `postgresqlExtraSettings` to allow to setup the `postgresql.conf`.
This would be useful in cases where we need to set
`shared_preload_libraries`.
2024-01-22 04:20:00 +00:00
github-actions[bot]
fc9b80e7a3
Merge master into haskell-updates 2024-01-20 00:12:49 +00:00
github-actions[bot]
650e10b010
Merge master into staging-next 2024-01-20 00:02:16 +00:00
Maciej Krüger
45308f5528
Merge pull request #281662 from hacker1024/feature/flutter-build-web
Support Web builds in buildFlutterApplication
2024-01-19 23:56:52 +01:00
github-actions[bot]
9a3af09826
Merge master into haskell-updates 2024-01-19 00:13:10 +00:00
hacker1024
64f9fa0d2c buildFlutterApplication: Change flutterHostPlatform to targetFlutterPlatform 2024-01-19 11:07:33 +11:00
github-actions[bot]
dc4a7c97b0
Merge master into staging-next 2024-01-18 18:00:55 +00:00
DS
2004205b7a doc: update content on dockerTools layered images and follow doc conventions 2024-01-18 17:26:24 +01:00
Silvan Mosberger
af358ee11c
Merge pull request #278956 from DanielSidhion/update-dockertools-buildimage
doc: update content on dockerTools.buildImage and follow doc conventions
2024-01-18 16:18:44 +01:00
Silvan Mosberger
c2c56c3d3c
Merge pull request #275935 from mrgalopes/update-rust-docs
doc: update buildRustPackage documentation
2024-01-18 16:13:56 +01:00
Silvan Mosberger
15a34f609f
Merge pull request #273075 from midnightveil/patch-1
doc: mkYarnPackage/mkYarnModules should use offlineCache to prevent IFD
2024-01-18 16:12:54 +01:00
Silvan Mosberger
4541016abd
Merge pull request #255794 from rtpg/patch-1
Mention qt-specific callPackage variants in docs
2024-01-18 16:11:18 +01:00
Silvan Mosberger
dc30cf4f88
Merge pull request #259567 from Eisfunke/document-mkShellNoCC
doc: add section about mkShellNoCC
2024-01-18 16:10:21 +01:00
Silvan Mosberger
0f9311fc48
Merge pull request #278535 from oliviacrain/no-pcre-in-docs
doc: replace pcre with pcre2 in example script
2024-01-18 16:06:39 +01:00
hacker1024
3b33435d02 flutter.buildFlutterApplication: Add multiShell attribute 2024-01-18 14:20:03 +11:00
hacker1024
f51a0b053d flutter.buildFlutterApplication: Allow building for the Web 2024-01-18 10:27:32 +11:00
DS
2c9e2b6569 doc: update content on dockerTools.buildImage and follow doc conventions 2024-01-16 23:56:59 -08:00
github-actions[bot]
a197d50282
Merge master into haskell-updates 2024-01-17 00:13:05 +00:00
github-actions[bot]
4c8ce132ff
Merge staging-next into staging 2024-01-16 06:01:25 +00:00
Mathew Polzin
ce58e0643b doc: idris2 section 2024-01-15 18:19:53 -06:00
github-actions[bot]
e0c9a6db2a
Merge master into haskell-updates 2024-01-16 00:13:07 +00:00
github-actions[bot]
35f426a31b
Merge staging-next into staging 2024-01-16 00:02:37 +00:00
Valentin Gagarin
f159a340ff
Merge pull request #281211 from fricklerhandwerk/documentation-conventions
doc: reword documentation conventions
2024-01-15 22:38:15 +01:00
Valentin Gagarin
2392daed23
Merge pull request #277534 from mcdonc/doc-trivial-builders-writetext
* doc: improve documentation for trivial text writing functions

Co-authored-by: Brian Merchant <bzm3r@proton.me>
Co-authored-by: Robert Hensing <robert@roberthensing.nl>
Co-authored-by: Alexander Groleau <alex@proof.construction>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-01-15 22:34:40 +01:00
Valentin Gagarin
b22ec91243 review pass 2024-01-15 22:34:00 +01:00
Valentin Gagarin
0fe7b4c389 doc: reword documentation conventions 2024-01-15 21:04:12 +01:00
Valentin Gagarin
f1601b35e7 doc: mention new documentation-reviewers subteam 2024-01-15 21:01:21 +01:00
Chris McDonough
2e2aaa1c2e do not nest a note within a warning, break out writeTextFile examples into multiple example sections, test first writeTextFile example (it was broken, heh) and fix, move prose out of code blocks 2024-01-15 11:29:35 -05:00
Chris McDonough
39a1686e56
Add a period
Co-authored-by: Alexander Groleau <alex@proof.construction>
2024-01-15 10:49:51 -05:00
Chris McDonough
cec3e9441c
Move prose
Co-authored-by: Alexander Groleau <alex@proof.construction>
2024-01-15 10:49:36 -05:00
Robert Hensing
559d06bbb2 trivial-builders: Remove redundant docs - link instead 2024-01-15 09:02:45 +01:00
github-actions[bot]
951f8a3024
Merge master into haskell-updates 2024-01-15 00:13:49 +00:00
Peder Bergebakken Sundt
e07a2fab7f stdenv: substituteStream: deprecate --replace in favor of --replace-{fail,warn,quiet} 2024-01-14 22:07:58 +01:00
Jörg Thalheim
90d30207b1
Merge pull request #280816 from katexochen/docs/go
doc: extend Go documentation
2024-01-14 13:27:17 +01:00
Nicolas Lenz
8c65bdc334
doc: add section about mkShellNoCC 2024-01-14 10:54:17 +01:00
Ryan Lahfa
dd5621df6d
Merge pull request #278380 from DeeUnderscore/fix/nginx-etag
nginx: change etags for statically compressed files served from store
2024-01-14 04:55:27 +01:00
Paul Meyer
aaf596a697 doc: extend Go documentation 2024-01-13 22:43:54 +01:00
Dee Anzorge
f124c73686 nginx: change etags for statically compressed files served from store
Per RFC 9110, [section 8.8.1][1], different representations of the same
resource should have different Etags:

> A strong validator is unique across all versions of all
> representations associated with a particular resource over time.
> However, there is no implication of uniqueness across representations
> of different resources (i.e., the same strong validator might be in
> use for representations of multiple resources at the same time and
> does not imply that those representations are equivalent)

When serving statically compressed files (ie, when there is an existing
corresponding .gz/.br/etc. file on disk), Nginx sends the Etag marked
as strong. These tags should be different for each compressed format
(as shown in  an explicit example in section [8.8.3.3][2] of the RFC).
Upstream Etags are composed of the file modification timestamp and
content length, and the latter generally changes between these
representations.

Previous implementation of Nix-specific Etags for things served from
store used the store hash. This is fine to share between different
files, but it becomes a problem for statically compressed versions of
the same file, as it means Nginx was serving different representations
of the same resource with the same Etag, marked as strong.

This patch addresses this by imitating the upstream Nginx behavior, and
appending the value of content length to the store hash.

[1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-validator-fields
[2]:
https://www.rfc-editor.org/rfc/rfc9110.html#name-example-entity-tags-varying
2024-01-13 22:07:50 +01:00
Chris McDonough
b0f542304d add to example 2024-01-12 22:59:49 -05:00
Chris McDonough
39227d5ce3 describing the composiion of the store path elements is not really that useful 2024-01-12 22:53:50 -05:00
Chris McDonough
56108dd5ab not realized; produced 2024-01-12 22:49:04 -05:00
Chris McDonough
7aa84efba2 incorporate the suggestion at https://github.com/NixOS/nixpkgs/pull/277534/files#r1450959283 2024-01-12 22:17:39 -05:00
Chris McDonough
25b2c3a0cc incorporate the spirit of change proposed by @DanielSidhion at https://github.com/NixOS/nixpkgs/pull/277534#discussion_r1450778530 2024-01-12 22:15:43 -05:00
Chris McDonough
32638686d1
Apply @bzm3r suggestions from code review
Co-authored-by: Brian Merchant <bzm3r@proton.me>
2024-01-12 21:58:13 -05:00
Chris McDonough
1e9fc75c6e whitespace cleanup 2024-01-12 12:17:24 -05:00
Chris McDonough
41c3d2d96c update arguments to definition lists as per docs team meeeting / @danielsidhion 2024-01-12 11:24:26 -05:00
Chris McDonough
e9ff890c46 Merge remote-tracking branch 'upstream/master' into doc-trivial-builders-writetext 2024-01-12 11:03:48 -05:00
sternenseemann
245035ea35 Merge remote-tracking branch 'origin/master' into haskell-updates 2024-01-12 16:55:57 +01:00
Benedikt Tissot
b28200aa23
texlive: document LuaLaTeX font cache (#280080)
lualatex assumes a writeable font cache relative to `$HOME`, for nix this has two implications.
First, the cache might diverge from the nix store if users use LuaLaTeX.
Second, `$HOME` needs to be set to a writable path in derivations.
2024-01-12 09:47:35 -06:00
github-actions[bot]
55af1e9407
Merge master into haskell-updates 2024-01-12 00:13:06 +00:00
hacker1024
a2cbeb19b4
docs/dart: Fix example autoPubspecLock syntax 2024-01-11 08:28:42 +11:00
hacker1024
778cefd464 buildDartApplication: Allow reading pubspec.lock with IFD 2024-01-10 20:29:53 +11:00
github-actions[bot]
27a26dea51
Merge master into haskell-updates 2024-01-10 00:13:04 +00:00
Bryan Lai
d7253bea6d doc: polish the docs of checkpointBuildTools
... following suggestions from @phip1611 and @infinisil.
2024-01-09 01:34:21 +08:00
Bryan Lai
df62c3c87f checkpointBuildTools: mkCheckpointedBuild -> mkCheckpointBuild
All other functions are in the form of `*{c,C}heckpointBuild*`, so we
deprecate the `mkCheckpointedBuild` function in favor of `mkCheckpointBuild`.

Also address some inconsistencies in the docs: some `buildOutput` should
actually be `incrementalBuildArtifacts`.
2024-01-08 19:42:16 +08:00
sternenseemann
d9b750c286 haskellPackages.ghc: 9.4.8 -> 9.6.3 2024-01-07 14:14:09 +01:00
Maciej Krüger
349e0c2870
Merge pull request #263345 from hacker1024/feature/pub2nix
dart: Use Nix instead of Pub
2024-01-05 16:34:07 +01:00
DS
016680fcf6 doc: add documentation conventions to keep a consistent style 2024-01-04 15:44:05 -08:00
Olivia Crain
f6e6a6d80e
doc: replace pcre with pcre2 in example script
https://www.pcre.org/

The `pcre` library is "now at end of life, and is no longer being
maintained," according to the upstream maintainers. Accordingly, we
should replace uses of `pcre` with its actively maintained successor,
`pcre2`, wherever possible .
2024-01-03 11:36:03 -06:00
ajs124
12f45e5dc9 docs/ruby: update/drop references to old version 2024-01-02 15:30:07 +01:00
ajs124
02ad3159b0 ruby_2_7: remove 2024-01-02 15:30:06 +01:00
Martin Weinelt
01a2063317
doc/python: update buildPythonApplication example
It is fine to use `with` on the inputs, since that increases the
overall readability of the package.

Removes `wheel` from `nativeBuildInputs`, since it is a result of
cargo culting from an earlier setuptools example, that was wrong, and
it is not required, since it is provided by setuptools itself.
2024-01-01 23:39:38 +01:00
Silvan Mosberger
e5af05cbf3
Merge pull request #276821 from DanielSidhion/update-binarycache-section
doc: update mkBinaryCache section with admonitions and conventions
2023-12-31 23:00:06 +01:00
Chris McDonough
f4cdad8aab doc: improve documentation for trivial text writing functions 2023-12-29 13:12:56 -05:00
netali
fb8c363b6a
doc: fix python-updates branch name
The python-updates branch was formerly called python-unstable, but the
new branch name was never mentioned in the docs. This commit changes the
branch name in the docs to python-updates.
2023-12-28 21:54:36 +01:00
hacker1024
32e3ea18d5 buildDartApplication: Document customSourceBuilders 2023-12-26 18:48:12 +02:00
hacker1024
23952fb641 buildDartApplication: Remove depsListFile
We get a dependency list with pub2nix now. We can no longer easily distinguish between development dependency dependencies and regular dependency dependencies, but we weren't doing this anyway.
2023-12-26 18:48:12 +02:00
hacker1024
65d2cc04a3 dartHooks.dartConfigHook: Simplify packageRun function 2023-12-26 17:08:51 +02:00
hacker1024
d41348a68a dartHooks.dartConfigHook: Add packageRun utility 2023-12-26 17:08:51 +02:00
hacker1024
92809a1cc5 buildDartApplication: Document running build tools 2023-12-26 17:08:50 +02:00
hacker1024
dbc05b2c80 dart: Add headings to nix-shell documentation sections 2023-12-26 17:06:18 +02:00
hacker1024
7c9b754784 buildDartApplication: Document nix-shell usage 2023-12-26 17:06:18 +02:00
hacker1024
7c7cb95085 dart: Update documentation for pub2nix 2023-12-26 17:06:17 +02:00
DS
f0fb6f0a26 doc: update mkBinaryCache section with admonitions and conventions
The mkBinaryCache section now follows the convention of using one
line per sentence, as well as using admonitions for notes and
examples.

The example syntax was updated to define a fully-working nix package.
2023-12-25 17:34:59 -08:00
Daniel Sidhion
e525be5a07
doc: update the appimageTools section content and examples (#276029)
The following changes are made:
- Document how `wrapType2` and `wrapType1` are the same thing.
- Expand on how `wrapType2` works and additional arguments it uses.
- Document `extract` and show how it's used in combination with
  `wrapType2`.
- Provide full working examples using the new admonition syntax.
2023-12-23 11:36:25 +01:00
Wael Nasreddine
1bf9271a09
Merge pull request #274503 from lopter/patch-1
Golang docs: remove "-s" and "-w" from the ldflags example
2023-12-21 21:04:02 -08:00
Gabriel Lopes Rodrigues
d3a7f45716 doc: update buildRustPackage documentation
Fixes some mistakes regarding the references to cargoHash in the codes referenced.
Fixes a typo for cargoSha256.
States that cargoHash should be preferred.
2023-12-21 22:01:17 -03:00
Silvan Mosberger
59a6f908b5
Merge pull request #271797 from bzm3r/master
doc: diagram explaining what it means for a dependency to be propagated
2023-12-21 17:14:30 +01:00
Brian Merchant
b37adfc009 doc: Clarify dependency propagation 2023-12-21 17:11:47 +01:00
Daniel Sidhion
292ea0d917
doc: migrate examples in testers chapter to admonitions (#275791) 2023-12-21 12:54:32 +01:00
Silvan Mosberger
6afebb56f8
Merge pull request #271360 from mattpolzin/patch-1
doc: clarify stdenv phase flag attributes
2023-12-20 20:37:41 +01:00
Silvan Mosberger
f27bb1216c
Merge pull request #273773 from nbraud/scripts/doc/check-manpage-urls
maintainers: Add new script to check URLs in `doc/manpage-urls.json`
2023-12-20 19:33:32 +01:00
DS
b47d073e2d doc: add more details on testers.testVersion 2023-12-20 03:04:32 -08:00
Janne Heß
5eed5416ff
Merge pull request #167670 from messemar/incremental-builds
incremental builds: add derivation override functions
2023-12-19 11:37:15 +01:00
nicoo
38e912eaa3 doc/tests/manpage-urls.py: Add type annotations 2023-12-18 20:38:17 +00:00
nicoo
a687d6ab7e doc/manpage-urls.json: Fix link to gnunet's manual 2023-12-18 20:28:51 +00:00
nicoo
b1a96bbbf2 doc: Add test for broken links in manpage-urls.json 2023-12-18 20:28:51 +00:00
Valentin Gagarin
a0f94525b0 julia docs: one line per sentence
this implements the documentation team's style guide new material
2023-12-18 16:25:16 +01:00
Nick Cao
fc5c9afd4d
Merge pull request #225513 from codedownio/julia-modules
Build arbitrary Julia package environments in Nixpkgs
2023-12-18 09:58:27 -05:00
Danila Danko
ceb8e4efd9
doc: Update stdenv.chapter.md (#274706)
Extended genericBuild description
2023-12-16 13:32:15 +01:00
Louis Opter
2e3c2705b9
Remove "-s" and "-w" from the ldflags example
The go linker `-s` and `-w` flags respectively are for:

- Omit the symbol table and debug information.
- Omit the DWARF symbol table.

Those actions should be delegated to the fixup build phase instead.

See: https://discourse.nixos.org/t/why-do-so-many-go-packages-use-s-w-in-their-ldflags-it-breaks-dontfixup-dontstrip/36843
2023-12-15 09:31:00 -08:00
Tom McLaughlin
c8f0d302c1 julia: add documentation to manual + release note 2023-12-14 23:00:35 -08:00
messemar
5ebb78d952
doc: checkpointBuild: fix wording
Co-authored-by: Philipp Schuster <phip1611@gmail.com>
2023-12-13 11:15:29 +01:00
Valentin Gagarin
6d3f2550fd
Merge pull request #273384 from nbraud/doc/system-state
nixos/doc: Add chapter “necessary system state”
2023-12-13 08:54:09 +01:00
nicoo
6b6b12c27c doc/manpage-urls.json: Add *all* systemd manpages
and add the generating script to `maintainers/scripts/doc`
2023-12-12 23:06:11 +00:00
Martin Messer
15c2c6827b checkpointBuild: doc remove textual description in favor of an integrated example 2023-12-12 14:12:15 +01:00
messemar
0d6d654f36
doc: checkpointBuild: fix wording
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-12-12 13:19:21 +01:00
messemar
f61980dbf9
doc: fix typo in checkpoint build section
Co-authored-by: Markus Partheymueller <markus.partheymueller@cyberus-technology.de>
2023-12-12 10:43:54 +01:00
github-actions[bot]
958e403a78
Merge master into staging-next 2023-12-10 12:01:18 +00:00
Sophie Tauchert
3b40e1bd33 buildNimPackage: allow overriding nim package args
Without this, it's impossible to override the lockFile as the default
overrideAttrs is applied after the composition in buildNimPackage has
read the lock file and generated the nim flags from it.
2023-12-10 09:10:02 +00:00
Robert Hensing
8d20c2011e
Merge pull request #272183 from infinisil/nixpkgs-reference
doc: Rename to Nixpkgs reference manual and restate purpose
2023-12-10 07:07:20 +01:00
Midnight Veil
c1678c2567
doc: mkYarnPackage/mkYarnModules should use offlineCache to prevent IFD
This is not mentioned elsewhere, and can be confusing.
2023-12-09 17:54:22 +11:00
Silvan Mosberger
f5dafbfa83 doc: Rename to Nixpkgs reference manual and state purpose
For the time being, we're moving towards https://nix.dev/ containing
all tutorials and guides. The Nixpkgs manual is reinforced to be a
_reference_ manual. While it's not just reference for now, that's what
the docs team is working towards.

This commits rewrites the Nixpkgs manual introduction to reflect that
and point to some more useful links. The contribution docs are updated
similarly so it's not missed.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-12-08 01:26:31 +01:00
github-actions[bot]
728281e1ea
Merge master into staging-next 2023-12-08 00:02:27 +00:00
Connor Baker
bfaefd0873 cudaPackages: add docs 2023-12-07 16:45:56 +00:00
Martin Messer
0ab2262bdd checkpointBuild: fix whitespaces in documentation 2023-12-07 17:15:17 +01:00
Martin Messer
6db9612204 rename: incremental -> checkpointed builds 2023-12-07 16:56:16 +01:00
Martin Messer
fc2e3fac61 doc: add section about checkpointed build 2023-12-07 16:55:36 +01:00
github-actions[bot]
fd7a8aedb0
Merge master into staging-next 2023-12-07 00:02:20 +00:00
Silvan Mosberger
4769458228 CONTRIBUTING.md: Update markdown emphasising syntax
GitHub supported special markdown syntax for emphasising blocks for some
time. This was however a beta feature, and still is, so it's subject to
changes.

Recently such a change happened: The syntax is different now.

See https://github.com/orgs/community/discussions/16925 for more
information
2023-12-06 03:51:39 +01:00
Mathew Polzin
fb9e48c6b9 doc: clarify stdenv phase flag attributes 2023-11-30 22:28:58 -06:00