summaryrefslogtreecommitdiffstats
path: root/doc/build-helpers
AgeCommit message (Collapse)Author
2024-04-11doc: update fetchzip docs, add examples and follow conventionsDS
With updates in a doc team meeting with Valentin, Silvan and Johannes :)
2024-04-04doc: document fetchurl more completely, follow doc conventions (#300429)Daniel Sidhion
* doc: document fetchurl more completely, follow doc conventions Co-authored-by: Johannes Kirschbauer <hsjobeki+github@gmail.com>
2024-04-03doc: improve fetchers overview, deduplicate readme content, follow doc ↵Daniel Sidhion
conventions (#297654) * doc: improve fetchers overview, deduplicate readme content * Improve caveat explanation and some fetchurl content * move out consumer docs on source fetching * move note on mirror URLs to the relevant section this may be better suited for the `fetchurl` reference, but it's probably better to just render that information into the manual. for now, because - contributor documentation encourages mirrors - we can expect contributors to dig into the source - linking source files is trivial in in-code documentation we leave it there. * move instructions for updating hashes to the manual * Add more clarity on text, reorganise source hash methods --------- Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Dominic Mills-Howell <dominic.millz27@gmail.com> Co-authored-by: lolbinarycat <dogedoge61+github@gmail.com>
2024-03-28treewide: Switch markdown placeholder from "..." to <...>Janne Heß
We use angle brackets since they look a lot like a placeholder while also being valid nix code, as suggested by roberth here: https://github.com/NixOS/nixpkgs/pull/299554#discussion_r1541797970
2024-03-28treewide: Fix all Nix ASTs in all markdown filesJanne Heß
This allows for correct highlighting and maybe future automatic formatting. The AST was verified to work with nixfmt only.
2024-03-28treewide: Mark Nix blocks in markdown as NixJanne Heß
This should help us with highlighting and future formatting.
2024-03-25doc/build-helpers: add missing semicolons (#298632)sekc
Co-authored-by: seksea <williamireland0@gmail.com>
2024-03-19Merge pull request #178717 from ShamrockLee/write-multiple-referencesSomeone
trivial-builders: replace writeReferencesToFile with writeClosure
2024-03-18Merge pull request #294019 from Lurkki14/doc-makedesktopitemDaniel Sidhion
doc: document makeDesktopItem
2024-03-19writeClosure: init, replacing writeReferencesToFileYueh-Shun Li
Replace writeReferencesToFile with writeClosure. Make writeClosure accept a list of paths instead of a path. Re-implement with JSON-based exportReferencesGraph interface provided by __structuredAttrs = true. Reword the documentation. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com> Co-authored-by: Someone Serge <sergei.kozlukov@aalto.fi>
2024-03-18doc: document makeDesktopItemJussi Kuokkanen
2024-03-14Merge pull request #293416 from DanielSidhion/remove-makesnapSilvan Mosberger
snapTools: remove
2024-03-11trivial-builders: Deduplicate docsRobert Hensing
I didn't have the opportunity to do all work at once, so I've added TODOs to bring attention to the situation.
2024-03-04snapTools: removeDS
`snapTools.makeSnap` has produced broken snaps since at least Oct 2020, as indicated by the following issue: https://github.com/NixOS/nixpkgs/issues/100618 No person has shown interest in maintaining it, and given that there is no fix available, it's assumed that all attempts made to fix that function have not succeeded. Given that `snapTools` only contained `makeSnap`, it was removed completely.
2024-02-29doc: update docs for portableService, follow doc conventionsDS
2024-02-29Merge pull request #290886 from DanielSidhion/update-ocitoolsSilvan Mosberger
doc: update docs in ociTools, follow doc conventions
2024-02-29doc: update docs in ociTools, follow doc conventionsDS
2024-02-26Document the new streamLayeredImage parametersWxNzEMof
2024-02-22doc/fetchers: document downloadToTemp for fetchurl (#288762)Matthieu Coudron
* doc/fetchers: document downloadToTemp for fetchurl Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-02-19Merge pull request #289584 from athre0z/docker-zstdRobert Hensing
dockerTools: configurable compression schema
2024-02-17dockerTools: configurable compression schemaJoel Höner
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-12doc: use long-form docker commands, improve wordingDS
2024-02-08doc: update buildNixShellImage docs, add streamNixShellImage docsDS
2024-02-08Merge pull request #285223 from DanielSidhion/update-dockertools-envhelpersSilvan Mosberger
doc: update environment helpers in dockerTools docs, add fakeNss section
2024-02-01writeShellApplication: Update manualRebecca Turner
2024-02-01doc: update dockerTools.exportImage content and use doc conventions (#283392)Daniel Sidhion
* 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-01doc: update environment helpers in dockerTools docs, add fakeNss sectionDS
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2024-01-25Merge pull request #283106 from DanielSidhion/update-dockertools-pullimageSilvan Mosberger
doc: update dockerTools.pullImage content and use doc conventions
2024-01-25doc: update dockerTools.pullImage content and use doc conventionsDS
2024-01-25Merge pull request #283394 from DanielSidhion/fix-dockertools-exampleSilvan Mosberger
doc: add missing attribute to example in dockerTools
2024-01-25doc: Note on how to use shadowSetup with buildLayeredImage (#267220)Kevin Brubeck Unhammer
* 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-23doc: add missing attribute to example in dockerToolsDS
2024-01-18doc: update content on dockerTools layered images and follow doc conventionsDS
2024-01-18Merge pull request #278956 from DanielSidhion/update-dockertools-buildimageSilvan Mosberger
doc: update content on dockerTools.buildImage and follow doc conventions
2024-01-18Merge pull request #259567 from Eisfunke/document-mkShellNoCCSilvan Mosberger
doc: add section about mkShellNoCC
2024-01-16doc: update content on dockerTools.buildImage and follow doc conventionsDS
2024-01-15review passValentin Gagarin
2024-01-15do not nest a note within a warning, break out writeTextFile examples into ↵Chris McDonough
multiple example sections, test first writeTextFile example (it was broken, heh) and fix, move prose out of code blocks
2024-01-15Add a periodChris McDonough
Co-authored-by: Alexander Groleau <alex@proof.construction>
2024-01-15Move proseChris McDonough
Co-authored-by: Alexander Groleau <alex@proof.construction>
2024-01-15trivial-builders: Remove redundant docs - link insteadRobert Hensing
2024-01-14doc: add section about mkShellNoCCNicolas Lenz
2024-01-12add to exampleChris McDonough
2024-01-12describing the composiion of the store path elements is not really that usefulChris McDonough
2024-01-12not realized; producedChris McDonough
2024-01-12incorporate the suggestion at ↵Chris McDonough
https://github.com/NixOS/nixpkgs/pull/277534/files#r1450959283
2024-01-12incorporate the spirit of change proposed by @DanielSidhion at ↵Chris McDonough
https://github.com/NixOS/nixpkgs/pull/277534#discussion_r1450778530
2024-01-12Apply @bzm3r suggestions from code reviewChris McDonough
Co-authored-by: Brian Merchant <bzm3r@proton.me>
2024-01-12whitespace cleanupChris McDonough
2024-01-12update arguments to definition lists as per docs team meeeting / @danielsidhionChris McDonough
generated by cgit v1.2.3 (git 2.25.1) at 2024-08-30 05:20:12 +0000