Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document JSON formats #9348

Merged
merged 1 commit into from
Jan 20, 2024
Merged

Conversation

Ericson2314
Copy link
Member

@Ericson2314 Ericson2314 commented Nov 13, 2023

Motivation

Good to document these things separately from commands.

TODO mention these are both currently unstable. Indeed they both currently violate the JSON guidelines.

Context

#9242 #7887 pulled out the underlying serializers, now we can document!

Eventually I would like this and builtins.derivation to refer to a store section on derivations that is authoritative, but that doesn't yet exist, and will take some time to make. So I think we're just best off merging this now as is.

Priorities

Add 馃憤 to pull requests you find important.

Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very good. The comments (except about headings, unless I overlooked something that makes them invalid) are non-blocking, feel free to merge with any subset of them addressed.

doc/manual/src/json/derivation.md Outdated Show resolved Hide resolved
doc/manual/src/json/experimental-notice.md Outdated Show resolved Hide resolved
doc/manual/src/json/derivation.md Show resolved Hide resolved
doc/manual/src/json/store-object-info.md Show resolved Hide resolved
doc/manual/src/json/store-object-info.md Outdated Show resolved Hide resolved
@Ericson2314 Ericson2314 force-pushed the json-formats branch 2 times, most recently from c61c56a to ddc5321 Compare January 20, 2024 22:01
Good to document these formats separately from commands that happen to
use them.

Eventually I would like this and `builtins.derivation` to refer to a
store section on derivations that is authoritative, but that doesn't yet
exist, and will take some time to make. So I think we're just best off
merging this now as is.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
@Ericson2314 Ericson2314 merged commit a93b204 into NixOS:master Jan 20, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation new-cli Relating to the "nix" command
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants