about summary refs log tree commit diff
path: root/tvix/nix-compat/src
diff options
context:
space:
mode:
authorPeter Kolloch <info@eigenvalue.net>2024-02-17T04·08+0700
committerPeter Kolloch <info@eigenvalue.net>2024-02-17T04·47+0000
commitda3ce74f7345b4a723b04545d99120827d60e890 (patch)
tree944b04f00dddaed24021fffd1474a5aed23a6419 /tvix/nix-compat/src
parent3d51b20cca61c957d96a1133ce4b8931d52ce717 (diff)
docs(tvix/nix-compat): on store paths in fields r/7532
Change-Id: Ie78b1c49d7386c70833a3b751799993ad9121aa6
Reviewed-on: https://cl.tvl.fyi/c/depot/+/10933
Tested-by: BuildkiteCI
Autosubmit: Peter Kolloch <info@eigenvalue.net>
Reviewed-by: flokli <flokli@flokli.de>
Diffstat (limited to 'tvix/nix-compat/src')
-rw-r--r--tvix/nix-compat/src/derivation/mod.rs3
-rw-r--r--tvix/nix-compat/src/derivation/output.rs2
2 files changed, 5 insertions, 0 deletions
diff --git a/tvix/nix-compat/src/derivation/mod.rs b/tvix/nix-compat/src/derivation/mod.rs
index 9b1db0f68e8b..5a59d640d65d 100644
--- a/tvix/nix-compat/src/derivation/mod.rs
+++ b/tvix/nix-compat/src/derivation/mod.rs
@@ -32,12 +32,15 @@ pub struct Derivation {
     #[serde(rename = "env")]
     pub environment: BTreeMap<String, BString>,
 
+    /// Map from drv path to output names used from this derivation.
     #[serde(rename = "inputDrvs")]
     pub input_derivations: BTreeMap<String, BTreeSet<String>>,
 
+    /// Plain store paths of additional inputs.
     #[serde(rename = "inputSrcs")]
     pub input_sources: BTreeSet<String>,
 
+    /// Maps output names to Output.
     pub outputs: BTreeMap<String, Output>,
 
     pub system: String,
diff --git a/tvix/nix-compat/src/derivation/output.rs b/tvix/nix-compat/src/derivation/output.rs
index b7fa1ac379b0..521ea3dedc9c 100644
--- a/tvix/nix-compat/src/derivation/output.rs
+++ b/tvix/nix-compat/src/derivation/output.rs
@@ -4,8 +4,10 @@ use crate::store_path::StorePathRef;
 use serde::{Deserialize, Serialize};
 use serde_json::Map;
 
+/// References the derivation output.
 #[derive(Clone, Debug, Default, Eq, PartialEq, Serialize)]
 pub struct Output {
+    /// Store path of build result.
     pub path: String,
 
     #[serde(flatten)]