1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-17 19:21:04 +00:00
Commit graph

2936 commits

Author SHA1 Message Date
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
DS ad83240aad doc: add missing attribute to example in dockerTools 2024-01-23 20:58:41 -08:00
github-actions[bot] 3c7375b75c
Merge master into staging-next 2024-01-22 18:00:55 +00: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
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
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] 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] 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
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