about summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2024-01-15doc: idris2 sectionMathew Polzin2-0/+48
2024-01-15Merge pull request #281211 from fricklerhandwerk/documentation-conventionsValentin Gagarin1-9/+13
doc: reword documentation conventions
2024-01-15Merge pull request #277534 from mcdonc/doc-trivial-builders-writetextValentin Gagarin1-22/+376
* 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-15review passValentin Gagarin1-94/+115
2024-01-15doc: reword documentation conventionsValentin Gagarin1-9/+13
2024-01-15doc: mention new documentation-reviewers subteamValentin Gagarin1-0/+4
2024-01-15do not nest a note within a warning, break out writeTextFile examples into ↵Chris McDonough1-23/+42
multiple example sections, test first writeTextFile example (it was broken, heh) and fix, move prose out of code blocks
2024-01-15Add a periodChris McDonough1-1/+1
Co-authored-by: Alexander Groleau <alex@proof.construction>
2024-01-15Move proseChris McDonough1-5/+5
Co-authored-by: Alexander Groleau <alex@proof.construction>
2024-01-15trivial-builders: Remove redundant docs - link insteadRobert Hensing1-1/+1
2024-01-14Merge pull request #280816 from katexochen/docs/goJörg Thalheim1-18/+123
doc: extend Go documentation
2024-01-14Merge pull request #278380 from DeeUnderscore/fix/nginx-etagRyan Lahfa1-1/+1
nginx: change etags for statically compressed files served from store
2024-01-13doc: extend Go documentationPaul Meyer1-18/+123
2024-01-13nginx: change etags for statically compressed files served from storeDee Anzorge1-1/+1
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-12add to exampleChris McDonough1-0/+6
2024-01-12describing the composiion of the store path elements is not really that usefulChris McDonough1-5/+5
2024-01-12not realized; producedChris McDonough1-1/+1
2024-01-12incorporate the suggestion at ↵Chris McDonough1-1/+1
https://github.com/NixOS/nixpkgs/pull/277534/files#r1450959283
2024-01-12incorporate the spirit of change proposed by @DanielSidhion at ↵Chris McDonough1-19/+6
https://github.com/NixOS/nixpkgs/pull/277534#discussion_r1450778530
2024-01-12Apply @bzm3r suggestions from code reviewChris McDonough1-9/+11
Co-authored-by: Brian Merchant <bzm3r@proton.me>
2024-01-12whitespace cleanupChris McDonough1-1/+1
2024-01-12update arguments to definition lists as per docs team meeeting / @danielsidhionChris McDonough1-24/+97
2024-01-12Merge remote-tracking branch 'upstream/master' into ↵Chris McDonough7-51/+200
doc-trivial-builders-writetext
2024-01-12texlive: document LuaLaTeX font cache (#280080)Benedikt Tissot1-0/+20
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-11docs/dart: Fix example autoPubspecLock syntaxhacker10241-1/+1
2024-01-10buildDartApplication: Allow reading pubspec.lock with IFDhacker10241-2/+14
2024-01-09doc: polish the docs of `checkpointBuildTools`Bryan Lai1-9/+12
... following suggestions from @phip1611 and @infinisil.
2024-01-08checkpointBuildTools: mkCheckpointedBuild -> mkCheckpointBuildBryan Lai1-1/+1
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-05Merge pull request #263345 from hacker1024/feature/pub2nixMaciej Krüger1-12/+54
dart: Use Nix instead of Pub
2024-01-04doc: add documentation conventions to keep a consistent styleDS1-0/+64
2024-01-02docs/ruby: update/drop references to old versionajs1241-3/+3
2024-01-02ruby_2_7: removeajs1241-2/+2
2024-01-01doc/python: update buildPythonApplication exampleMartin Weinelt1-6/+5
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.
2023-12-31Merge pull request #276821 from DanielSidhion/update-binarycache-sectionSilvan Mosberger1-21/+30
doc: update mkBinaryCache section with admonitions and conventions
2023-12-29doc: improve documentation for trivial text writing functionsChris McDonough1-16/+262
2023-12-28doc: fix python-updates branch namenetali1-1/+1
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-26buildDartApplication: Document customSourceBuildershacker10241-0/+8
2023-12-26buildDartApplication: Remove depsListFilehacker10241-4/+0
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-26dartHooks.dartConfigHook: Simplify packageRun functionhacker10241-1/+1
2023-12-26dartHooks.dartConfigHook: Add packageRun utilityhacker10241-3/+4
2023-12-26buildDartApplication: Document running build toolshacker10241-0/+22
2023-12-26dart: Add headings to nix-shell documentation sectionshacker10241-3/+3
2023-12-26buildDartApplication: Document nix-shell usagehacker10241-0/+16
2023-12-26dart: Update documentation for pub2nixhacker10241-8/+7
2023-12-25doc: update mkBinaryCache section with admonitions and conventionsDS1-21/+30
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-23doc: update the appimageTools section content and examples (#276029)Daniel Sidhion1-25/+144
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-21Merge pull request #274503 from lopter/patch-1Wael Nasreddine1-1/+0
Golang docs: remove "-s" and "-w" from the ldflags example
2023-12-21Merge pull request #271797 from bzm3r/masterSilvan Mosberger1-4/+40
doc: diagram explaining what it means for a dependency to be propagated
2023-12-21doc: Clarify dependency propagationBrian Merchant1-4/+40
2023-12-21doc: migrate examples in testers chapter to admonitions (#275791)Daniel Sidhion1-44/+58