about summary refs log tree commit diff
path: root/tvix/docs/src/eval/build-references.md
diff options
context:
space:
mode:
authortoastal <toastal@posteo.net>2024-06-20T07·08+0700
committertoastal <toastal@posteo.net>2024-06-21T08·08+0000
commitbf541acf29b6964a6b40a8079420a27892e713f6 (patch)
treebad562771ab3e0e633a0f32d8cb1aab7362531c8 /tvix/docs/src/eval/build-references.md
parent8dde022d3133d7e1be55be94821e6bb1d814f4ed (diff)
docs: use admonish for callouts r/8302
Change-Id: Icec7321a49c40e7f7bcb1e4b307f13b8db4eac25
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11862
Reviewed-by: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Diffstat (limited to 'tvix/docs/src/eval/build-references.md')
-rw-r--r--tvix/docs/src/eval/build-references.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/tvix/docs/src/eval/build-references.md b/tvix/docs/src/eval/build-references.md
index badcea11550e..cfa569c04a2c 100644
--- a/tvix/docs/src/eval/build-references.md
+++ b/tvix/docs/src/eval/build-references.md
@@ -23,8 +23,10 @@ formats:
    This format is used for a special case where a derivation attribute directly
    refers to a derivation path (e.g. by accessing `.drvPath` on a derivation).
 
-   Note: In C++ Nix this case is quite special and actually requires a
-   store-database query during evaluation.
+   ```admonish note
+   In C++ Nix this case is quite special and actually requires a store-database
+   query during evaluation.
+   ```
 
 3. `<path>` - a non-descript store path input, usually a plain source file (e.g.
    from something like `src = ./.` or `src = ./foo.txt`).
@@ -90,8 +92,10 @@ C++ Nix has several builtins that interface directly with string contexts:
 * `unsafeDiscardOutputDependency`: drops dependencies on the *outputs* of a
   `.drv` in the context, passing only the literal `.drv` itself
 
-  Note: This is only used for special test-cases in nixpkgs, and deprecated Nix
+  ```admonish note
+  This is only used for special test-cases in nixpkgs, and deprecated Nix
   commands like `nix-push`.
+  ```
 * `getContext`: returns the string context in serialised form as a Nix attribute
   set
 * `appendContext`: adds a given string context to the string in the same format
@@ -159,8 +163,10 @@ one evaluation should be created in Nix. This metadata needs to be available in
 These queries will need to be asked of the metadata when populating the
 derivation fields.
 
-Note: Depending on how we implement `builtins.placeholder`, it might be useful
+```admonish note
+Depending on how we implement `builtins.placeholder`, it might be useful
 to track created placeholders in this metadata, too.
+```
 
 ### Context builtins