Jörg Thalheim
daace78239
Merge pull request #14425 from obsidiansystems/json-schema-build-trace
...
JSON Schema for build trace entry
2025-11-06 18:06:57 +00:00
Jörg Thalheim
af41eccb31
Merge pull request #14469 from roberth/doc-check-link-fragments
...
Manual: fix and check link fragments
2025-11-06 09:27:19 +00:00
John Ericson
91af29f37a
manual: Fix MathJax typo
...
Thanks to @cafkafk for catching my mistake.
2025-11-05 11:08:36 -05:00
Robert Hensing
ae15d4eaf3
Fix links in the manual
2025-11-04 00:31:46 +01:00
Sergei Zimmerman
3ef22a521d
Merge pull request #14468 from fzakaria/fzakaria/nar-warning
...
Fix warning in kaitai spec
2025-11-03 22:54:55 +00:00
Farid Zakaria
c8e24491c0
Fix warning in kaitai spec
...
Warning:
```
[39/483] Generating src/kaitai-struct-checks/kaitai-generated-sources with a custom command
../src/kaitai-struct-checks/nar.ksy: /types/padded_str/seq/1/encoding:
warning: use canonical encoding name `ASCII` instead of `ascii` (see https://doc.kaitai.io/ksy_style_guide.html#encoding-name )
```
2025-11-03 14:19:54 -08:00
John Ericson
144c66215b
JSON Schema for build trace entry
...
Note, starting to make progress on #11895 by calling it this in the
manual.
2025-11-03 15:59:50 -05:00
John Ericson and Robert Hensing
72d0f7b619
Document "hash derivation quotiented", resolution, and build trace
...
Progress on #13405 , which asks for an explicit characterisation of the
equivalence relation like the one given here.
Also progress on #11895 , because we're using the term "build trace
entry" instead of "realisation".
Mention #9259 , a future work item.
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com >
2025-11-03 15:18:18 -05:00
John Ericson
0586370e58
Merge pull request #14345 from fzakaria/fzakaria/nar-kaitai-spec
...
Add documentation for NAR spec in kaitai
2025-11-03 18:24:26 +00:00
John Ericson
f63bb5b338
Merge pull request #14427 from obsidiansystems/drv-output-better-schema
...
Better JSON schema for derivation outputs
2025-11-03 18:23:29 +00:00
Farid Zakaria
53b4ea6c85
Add documentation for NAR spec in kaitai
...
* Add a new flake check
* Add unit tests
* Add Kaitai spec
* Updated documentation
2025-11-03 12:59:16 -05:00
Martin Joerg
892eba4944
fix documentation issues
2025-11-02 09:17:40 +00:00
John Ericson
c2609df08c
Better JSON schema for derivation outputs
...
It now uses a `oneOf` and properly models each type of output
(corresponding to each type of derivation) separately.
2025-10-30 17:05:00 -04:00
Eelco Dolstra
3b2186e1c8
Merge pull request #14397 from fzakaria/fzakaria/issue-14315
...
Move docker documentation to docker.io
2025-10-30 17:38:22 +00:00
John Ericson
7e2d2db8ef
Merge pull request #14399 from obsidiansystems/json-schema-path-info
...
Convert store path info JSON docs to formal JSON Schema, and test
2025-10-30 17:35:20 +00:00
John Ericson
66d7b8fe1b
Merge pull request #14396 from roberth/c-api-docs
...
doc: Improve libexpr-c docs
2025-10-29 22:38:04 +00:00
Robert Hensing and John Ericson
f301669adc
doc/dev/documentation: Use appendToVar
...
Co-authored-by: John Ericson <git@JohnEricson.me >
2025-10-29 22:53:43 +01:00
John Ericson
6280905638
Convert store path info JSON docs to formal JSON Schema, and test
...
This continues the work for formalizing our current JSON docs. Note that
in the process, a few bugs were caught:
- `closureSize` was repeated twice, forgot `closureDownloadSize`
- `file*` fields should be `download*`. They are in fact called that in
the line-oriented `.narinfo` file, but were renamed in the JSON
format.
2025-10-28 23:28:16 -04:00
John Ericson
c67966418f
Create JSON Schema for Store Paths
...
We immediately use this in the JSON schemas for Derivation and Deriving
Path, but we cannot yet use it in Store Object Info because those paths
*do* include the store dir currently.
2025-10-28 17:22:51 -04:00
John Ericson
be2572ed8d
Make inputDrvs JSON schema more precise
...
It now captures the stable non-recursive format (just an output set) and
the unstable recursive form for dynamic derivations.
2025-10-28 17:22:30 -04:00
Farid Zakaria
943788754f
Add ghcr for pre-release
2025-10-28 11:16:37 -07:00
Farid Zakaria
883860c7ff
Move docker documentation to docker.io
2025-10-28 11:14:31 -07:00
Robert Hensing
5fc0c4f102
doc: Improve libexpr-c docs
...
- Uses the more explicit `@ingroup` most of the time, to avoid problems
with nested groups, and to make group membership more explicit.
The division into headers is not great for documentation purposes,
so this helps.
- More attention for memory management details
- Various other improvements to doc comments
2025-10-28 17:57:15 +01:00
Adam Dinwoodie
972915cabd
docs: remove incorrect claim re gc --print-dead
...
Per #7591 , the `nix-store --gc --print-dead` command does not provide
any feedback about the amount of disk space that is used by dead store
paths. It looks like this has been the case since 7ab68961e (* Garbage
collector: added an option `--use-atime' to delete paths in...,
2008-09-17).
Update the nix-store documentation to remove the claim that this is
function that `nix-store --gc --print-dead` performs.
2025-10-28 09:47:25 +00:00
John Ericson and Robert Hensing
91b69e9e70
nlohmann::json instance and JSON Schema for ContentAddress
...
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com >
2025-10-27 14:47:50 -04:00
John Ericson
8d338c9234
JSON Schema for DerivedPath
...
Note that this is "deriving path" in the manual -- the great sed of the
code base to bring it in sync has yet to happen yet.
2025-10-24 12:08:00 -04:00
John Ericson and Robert Hensing
5e7ee808de
nlohmann::json instance and JSON Schema for Hash
...
Improving and codifying our experimental JSON interfacing.
Co-Authored-By: Robert Hensing <robert@roberthensing.nl >
2025-10-20 15:21:07 -04:00
Robert Hensing
c92ba4b9b7
Add titles in JSON schemas
...
This way, the description isn't rendered in the tables of contents,
leading to no more formatting errors.
2025-10-17 21:53:29 +02:00
Robert Hensing
01b001d5ba
Add JSON Schema infrastructure, use for Derivation
...
For manual, and testing formats
2025-10-16 17:24:18 -04:00
Robert Hensing
61cb9c4832
doc/dev/doc: Update local build instructions for manual
2025-10-16 13:22:22 +02:00
Soumyadip Sarkar
998f93f267
Fix typos
2025-10-13 18:15:52 +05:30
Sergei Zimmerman
0068ee6ca7
Release note for attrset optimization
2025-10-06 22:16:21 +03:00
Eelco Dolstra and Taeer Bar-Yam
8f71ef7ede
Update doc/manual/source/release-notes/rl-2.32.md
...
Co-authored-by: Taeer Bar-Yam <Radvendii@users.noreply.github.com >
2025-10-06 19:27:30 +02:00
Bernardo Meurer Costa
776038f842
docs(release-notes): note fix for fetchTarball/fetchurl substitution
2025-10-06 17:09:34 +00:00
Eelco Dolstra
f4e44040d4
Release note for external derivation builders
2025-10-06 16:26:29 +02:00
Eelco Dolstra
0376112a51
Organize release notes
2025-10-06 16:11:24 +02:00
Eelco Dolstra
9f6ed70429
release notes: 2.32.0
2025-10-06 16:04:58 +02:00
rszyma
7bd67cd8dc
doc: Fix invalid devshell attrpath
...
`native-clangStdenvPackages` devshell attrpath was being mentioned in
development docs, but doesn't work anymore (since 69fde530 ).
2025-09-26 19:49:36 +02:00
Sergei Zimmerman
d5e84383d1
doc: Document building with sanitizers
2025-09-19 01:37:15 +03:00
Sergei Zimmerman and Jade Lovelace
94d37e62fc
treewide: Support builds with ASAN, enable in CI
...
Enables builds with ASAN to catch memory corruption
bugs faster and in CI. This is an incredibly valuable
instrument that must be used as much as possible.
Somewhat based on jade's work from Lix, though there's a lot that
we have to do differently:
https://git.lix.systems/lix-project/lix/commit/19ae87e5cec71912c7e7ecec5dc8ff18d18c60ee
Co-authored-by: Jade Lovelace <lix@jade.fyi >
2025-09-19 01:33:57 +03:00
éclairevoyant
40b47b9395
doc: document global builtins
2025-09-18 00:04:31 -04:00
John Ericson
9d7229a2a4
Make the JSON format for derivation use basename store paths
...
See #13570 for details --- the idea is that included the store dir in
store paths makes systematic JSON parting with e.g. Serde, Aeson,
nlohmann, or similiar harder.
After talking to Eelco, we are changing the `Derivation` format right
away because not only is `nix derivation` technically experimental, we think it is
also less widely used in practice than, say, `nix path-info`.
Progress on #13570
2025-09-17 16:38:17 -04:00
Glen Huang
a0b633dd2b
doc: Rephrase store-object.md
2025-09-13 10:17:12 +08:00
Matej Urbas
112f311c50
hacking.md: set installation outputs as well
2025-08-31 09:53:14 +01:00
Eelco Dolstra
9c6019dd1a
Merge pull request #13804 from NixOS/release-notes
...
Release notes for Nix 2.31
2025-08-22 17:18:15 +02:00
Eelco Dolstra
82d3662f09
Tweak
2025-08-22 11:03:05 +02:00
Glen Huang
c0246460a0
doc: Fix typo
2025-08-22 15:39:18 +08:00
John Ericson
0c46c2c37f
Mention experimental SHA-256 git hashing in release notes
2025-08-21 23:17:12 -04:00
Eelco Dolstra
ae09483498
Add more release notes
2025-08-21 13:37:38 +02:00
Eelco Dolstra
4dcfb36c1e
Cleanup
2025-08-21 13:37:38 +02:00