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
Chris McDonough
f4cdad8aab
doc: improve documentation for trivial text writing functions
2023-12-29 13:12:56 -05:00
DS
f0fb6f0a26
doc: update mkBinaryCache section with admonitions and conventions
...
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-25 17:34:59 -08:00
Daniel Sidhion
e525be5a07
doc: update the appimageTools section content and examples ( #276029 )
...
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-23 11:36:25 +01:00
Daniel Sidhion
292ea0d917
doc: migrate examples in testers chapter to admonitions ( #275791 )
2023-12-21 12:54:32 +01:00
DS
b47d073e2d
doc: add more details on testers.testVersion
2023-12-20 03:04:32 -08:00
messemar
5ebb78d952
doc: checkpointBuild: fix wording
...
Co-authored-by: Philipp Schuster <phip1611@gmail.com>
2023-12-13 11:15:29 +01:00
Martin Messer
15c2c6827b
checkpointBuild: doc remove textual description in favor of an integrated example
2023-12-12 14:12:15 +01:00
messemar
0d6d654f36
doc: checkpointBuild: fix wording
...
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-12-12 13:19:21 +01:00
messemar
f61980dbf9
doc: fix typo in checkpoint build section
...
Co-authored-by: Markus Partheymueller <markus.partheymueller@cyberus-technology.de>
2023-12-12 10:43:54 +01:00
Martin Messer
0ab2262bdd
checkpointBuild: fix whitespaces in documentation
2023-12-07 17:15:17 +01:00
Martin Messer
6db9612204
rename: incremental -> checkpointed builds
2023-12-07 16:56:16 +01:00
Martin Messer
fc2e3fac61
doc: add section about checkpointed build
2023-12-07 16:55:36 +01:00
Yueh-Shun Li
9963ad5c5f
doc: builders -> build helpers to reduce ambigualty
2023-11-07 19:58:53 +00:00
