docs: use admonish for callouts

Change-Id: Icec7321a49c40e7f7bcb1e4b307f13b8db4eac25
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11862
Reviewed-by: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
This commit is contained in:
toastal 2024-06-20 14:08:31 +07:00
parent 8dde022d31
commit bf541acf29
5 changed files with 21 additions and 9 deletions

View file

@ -82,8 +82,10 @@ stack when the scope ends.
## Moving parts
WARNING: This documents the *current* implementation. If you only care about the
```admonish caution
This documents the *current* implementation. If you only care about the
conceptual aspects, see above.
```
There's a few types involved:

View file

@ -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

View file

@ -1,8 +1,10 @@
# Specification of the Nix Language
WARNING: This document is a work in progress. Please keep an eye on
```admonish attention
This document is a work in progress. Please keep an eye on
[`topic:nix-spec`](https://cl.tvl.fyi/q/topic:nix-spec) for ongoing
CLs.
```
Nix is a general-purpose, functional programming language which this
document aims to describe.

View file

@ -205,7 +205,7 @@ and potentially a chain of `Directory` objects requested from
When the desired file is reached, the *BlobService* can be used to read the
contents of this file, and return it back to the evaluator.
FUTUREWORK: define how importing from symlinks should/does work.
FUTUREWORK: Define how importing from symlinks should/does work.
Contrary to Nix, this has the advantage of not having to copy all of the
contents of a store path to the evaluating machine, but really only fetching

View file

@ -47,8 +47,10 @@ works in C++ Nix, the only production ready Nix implementation currently availab
## Nix (Pointer) Equality in C++ Nix
TIP: The summary presented here is up-to-date as of 2023-06-27 and was tested
with Nix 2.3, 2.11 and 2.15.
```admonish info
The summary presented here is up-to-date as of 2023-06-27 and was tested with
Nix 2.3, 2.11 and 2.15.
```
### `EvalState::eqValues` and `ExprOpEq::eval`