dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
671,244 Commits 3 Branches 0 Tags 4.3 GiB
78098e02af
Commit Graph

96 Commits

Author SHA1 Message Date
Philip Taron
be245de559
Merge pull request #333262 from nbraud/doc/runCommandWith 
nixpkgs-manual: Document `runCommandWith`, refactor `runCommand{,CC,Local}`
 2024-08-19 12:29:58 -07:00
nicoo
9e5d56e8c6 doc/build-helpers: forward-link runCommand* in runCommandWith 2024-08-19 19:16:43 +00:00
nicoo
2b8a6a7e43 doc/build-helpers: refactor the paragraph about runCommandLocal 2024-08-19 19:16:43 +00:00
nicoo
e3d7e7f2a7 doc/build-helpers: add note relating runCommand and runCommandWith 2024-08-19 19:16:42 +00:00
nicoo
482d6eaab2 doc/build-helpers: refactor the paragraphs about runCommand{,CC} 
Co-authored-by: Johannes Kirschbauer <hsjobeki+github@gmail.com>
 2024-08-19 19:16:42 +00:00
nicoo
80e3fd91a9 doc/build-helpers: document runCommandWith 
Co-authored-by: Johannes Kirschbauer <hsjobeki+github@gmail.com>
 2024-08-19 19:16:42 +00:00
nicoo
e0fc12cd12 doc: add type signature of testers.runCommand 2024-08-08 15:43:47 +00:00
nicoo
d0a96c6eda testers.runCommand: add, document, and test 2024-08-08 15:29:14 +00:00
Robert Hensing
7237aa700f devShellTools: Docs, fix args env 2024-07-28 23:17:18 +02:00
Robert Hensing
4ca52fdf5f
Merge pull request #323613 from CyberShadow/fix-nix-path-without-channels-v2 
nix-channel: do not set empty nix-path when disabling channels
 2024-07-28 13:31:10 +02:00
Peder Bergebakken Sundt
99dec1f6b0 treewide: fix doc typos 
Done with `fd \\\.md$ . --type f -x typos --write-changes`
 2024-07-26 00:55:13 +02:00
Robert Hensing
c5e5aa7266
Merge pull request #308822 from yorickvP/yorickvp/streamLayeredImage-overridable 
dockerTools.streamLayeredImage: add includeNixDB argument, expose conf and streamScript
 2024-07-24 16:02:35 +02:00
Robert Hensing
3fb14db08a testers.shellcheck: init 
Needed for testing upcoming commit.
 2024-07-16 20:10:02 +02:00
aleksana
2969ce1dd3 doc/fetchers: correct fetchtorrent sha256 attribute to hash 
This seems incorrect because sha256 is not an acceptable attribute of
fetchtorrent.
 2024-07-04 18:43:48 +08:00
Silvan Mosberger
06a8bee760
Merge pull request #323398 from NixOS/prep-dev-shell 
init `devShellTools`
 2024-07-03 05:19:42 +02:00
Doron Behar
32d57df8ac
Merge pull request #320266 from doronbehar/pkg/versionInstallHook 
versionCheckHook: init
 2024-07-03 01:37:49 +03:00
a-kenji
ec5679262f writeScriptBin: fix typo in docs 2024-07-02 15:51:18 +02:00
Robert Hensing
8398e087cd devShellTools.{stringValue -> valueToString} 2024-06-29 17:22:57 +02:00
Robert Hensing
469039098b devShellTools.stringValue: init 2024-06-29 17:21:01 +02:00
Robert Hensing
091d8370a2 devShellTools: init (empty) 2024-06-29 16:41:13 +02:00
Doron Behar
f42d4debf0 doc: recommend versionCheckHook whenever relevant 2024-06-28 18:03:59 +03:00
Artturin
2be37441da doc: Improve the makeSetupHook example 
also format it with nixfmt
 2024-06-15 21:02:53 +03:00
Travis A. Everett
9ff9bbdb34
doc: add stdenv passthru chapter (#315909) 
* doc: add stdenv passthru chapter

Broad strokes:
- create the chapter
- move existing stdenv passthru coverage into it
- move out-of-place coverage of passthru.tests from the stdenv meta chapter into it
- (try to) apply 1-sentence-per-line to text I've touched
- add legacy anchors for everything moved
- update existing links to the new anchors
- add tentative motivating text
- make nixpkgs-internal links relative/branchless

razor: if it is only ever needed by contributors, which is likely if links
refer to the latest revision of the source code, then it's for
the contributor guide

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
 2024-06-11 10:51:03 +02:00
Alyssa Ross
ba96c1f7e5 doc: fix make-disk-image.nix example 2024-06-04 21:46:41 +01:00
Ivan Trubach
b25101d1fb doc: fix testers.testEqualContents fragment link 2024-05-31 05:35:48 +03:00
Robert Hensing
e0c43a96d2
testers.lycheeLinkCheck: init (#298665) 
* testers.lycheeLinkCheck: init

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
 2024-05-27 01:14:19 +02:00
Yorick van Pelt
4d51990bc5
dockerTools: document streamLayeredImage's includeNixDB argument 2024-05-06 15:06:50 +02:00
Yorick van Pelt
62e9e0f963
dockerTools: add includeNixDB to buildImage and document 2024-05-06 14:57:08 +02:00
Jan Tojnar
4e02eae70e doc/gnome: Use wrapGApps* hook for referring to the hook family 2024-04-27 00:05:46 +02:00
Peder Bergebakken Sundt
bbb1f25bfb buildFHSEnvBubblewrap: do not infer pname from name 2024-04-24 15:26:52 +02:00
DS
e67c738314 doc: update fetchzip docs, add examples and follow conventions 
With updates in a doc team meeting with Valentin, Silvan and Johannes :)
 2024-04-11 17:09:41 +02:00
Daniel Sidhion
c9c7d2f237
doc: document fetchurl more completely, follow doc conventions (#300429) 
* doc: document fetchurl more completely, follow doc conventions

Co-authored-by: Johannes Kirschbauer <hsjobeki+github@gmail.com>
 2024-04-04 14:12:42 +02:00
Daniel Sidhion
0decb324b3
doc: improve fetchers overview, deduplicate readme content, follow doc 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-04-03 08:18:11 +02:00
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