Commit Graph

2912 Commits

Author SHA1 Message Date
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
Mathew Polzin
ce58e0643b doc: idris2 section 2024-01-15 18:19:53 -06: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
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
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
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
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
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