colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
605,021 Commits 123 Branches 0 Tags 3.3 GiB
471337c65d
Commit Graph

63 Commits

Author SHA1 Message Date
Janne Heß
bc5ee2b8f8 treewide: Switch markdown placeholder from "..." to <...> 
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-28 09:28:12 +01:00
Janne Heß
fcc95ff817 treewide: Fix all Nix ASTs in all markdown files 
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
 2024-03-28 09:28:12 +01:00
Janne Heß
bc77c7a973 treewide: Mark Nix blocks in markdown as Nix 
This should help us with highlighting and future formatting.
 2024-03-28 09:28:12 +01:00
sekc
b1b78f4369
doc/build-helpers: add missing semicolons (#298632) 
Co-authored-by: seksea <williamireland0@gmail.com>
 2024-03-25 12:59:19 +01:00
Someone
63709965b7
Merge pull request #178717 from ShamrockLee/write-multiple-references 
trivial-builders: replace writeReferencesToFile with writeClosure
 2024-03-19 08:57:20 +00:00
Daniel Sidhion
83f77a1b38
Merge pull request #294019 from Lurkki14/doc-makedesktopitem 
doc: document makeDesktopItem
 2024-03-18 16:08:29 -07:00
Yueh-Shun Li
e9fd4389d2 writeClosure: init, replacing writeReferencesToFile 
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-19 02:45:50 +08:00
Jussi Kuokkanen
7d61bb198f doc: document makeDesktopItem 2024-03-18 18:24:51 +02:00
Silvan Mosberger
f60515ddea
Merge pull request #293416 from DanielSidhion/remove-makesnap 
snapTools: remove
 2024-03-14 16:46:22 +01:00
Robert Hensing
e99021ff75 trivial-builders: Deduplicate docs 
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-11 11:33:14 +01:00
DS
1d85557b50 snapTools: remove 
`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-03-04 22:22:14 -08: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
WxNzEMof
7799f4695b Document the new streamLayeredImage parameters 2024-02-26 18:41:07 +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
Robert Hensing
d2dfcfcfad
Merge pull request #289584 from athre0z/docker-zstd 
dockerTools: configurable compression schema
 2024-02-19 18:06:54 +01: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
DS
ba79b098ea doc: use long-form docker commands, improve wording 2024-02-12 15:38:00 -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
Rebecca Turner
41376dd064
writeShellApplication: Update manual 2024-02-01 16:02:34 -08: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
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
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
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
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
DS
ad83240aad doc: add missing attribute to example in dockerTools 2024-01-23 20:58:41 -08: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
dc30cf4f88
Merge pull request #259567 from Eisfunke/document-mkShellNoCC 
doc: add section about mkShellNoCC
 2024-01-18 16:10:21 +01:00
DS
2c9e2b6569 doc: update content on dockerTools.buildImage and follow doc conventions 2024-01-16 23:56:59 -08:00
Valentin Gagarin
b22ec91243 review pass 2024-01-15 22:34:00 +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
Nicolas Lenz
8c65bdc334
doc: add section about mkShellNoCC 2024-01-14 10:54:17 +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
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