Peder Bergebakken Sundt
6fd3990534
trivial: make symlinkJoin support pname+version alone
2024-09-28 01:35:47 +02:00
networkException
f0b6425d73
doc/build-helpers: fix wrong invokations of writeTextFile with destination
...
This patch fixes occurances of writeTextFile invokations with
a destination set but without a leading slash. This would cause
an opaque build time error.
2024-09-21 23:59:42 +02:00
Matthias Beyer
f78adb0891
doc: Move "This is equivalent to" into example block
...
This patch moves the code snippet which is shown as equivalent to the
example into the actual example block.
Visually, it was not easy to parse that the "equivalent" code piece
belonged to the code snippet that was hidden in the example (which is
collapsed by default).
By moving it into the example block, the "equivalent" piece is hidden by
default as well.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2024-08-28 11:26:23 +02: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
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
a-kenji
ec5679262f
writeScriptBin: fix typo in docs
2024-07-02 15:51:18 +02: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
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
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
Rebecca Turner
41376dd064
writeShellApplication: Update manual
2024-02-01 16:02:34 -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
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
f4cdad8aab
doc: improve documentation for trivial text writing functions
2023-12-29 13:12:56 -05:00
Yueh-Shun Li
9963ad5c5f
doc: builders -> build helpers to reduce ambigualty
2023-11-07 19:58:53 +00:00
