diff options
| author | sterni <sternenseemann@systemli.org> | 2023-01-25T14·16+0100 |
|---|---|---|
| committer | clbot <clbot@tvl.fyi> | 2023-01-25T14·30+0000 |
| commit | daa3721f73265fd28cd39a88d64876c910e58df0 (patch) | |
| tree | 67c356cd3bb77843bd51b5e273d579bcdcf46ea1 /tvix | |
| parent | 8a8325fb9d2cfaf7c208db0f7d676dcab9c4eba0 (diff) | |
docs(tvix): fix minor spelling problems in pointer equality document r/5759
Main one is the its-it's mistake in the last paragraph, the rest was suggested by LanguageTool. Change-Id: If1b87a11f480452f312fc2759be7ded782d0a522 Reviewed-on: https://cl.tvl.fyi/c/depot/+/7930 Reviewed-by: flokli <flokli@flokli.de> Autosubmit: sterni <sternenseemann@systemli.org> Tested-by: BuildkiteCI
Diffstat (limited to 'tvix')
| -rw-r--r-- | tvix/docs/value-pointer-equality.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/tvix/docs/value-pointer-equality.md b/tvix/docs/value-pointer-equality.md index a57273c6b59f..78b1466f3a8f 100644 --- a/tvix/docs/value-pointer-equality.md +++ b/tvix/docs/value-pointer-equality.md @@ -5,7 +5,7 @@ It is a piece of semi-obscure Nix trivia that while functions are generally not comparable, they can be compared in certain situations. This is actually quite an important fact, as it is essential for the evaluation of nixpkgs: The attribute sets -used to represent platforms in nixpkgs, like `stdenv.buildPlatform`, contain functions, +used to represent platforms in nixpkgs, like `stdenv.buildPlatform`, contain functions, such as `stdenv.buildPlatform.canExecute`. When writing cross logic, one invariably ends up writing expressions that compare these sets, e.g. `stdenv.buildPlatform != stdenv.hostPlatform`. Since attribute set equality is the equality of their attribute @@ -46,7 +46,7 @@ So what is _actually_ going on? ## Nix (pointer) Equality in C++ Nix -TIP: The summary presented here is up to date as of 2022-11-23 and was tested with Nix 2.3 and 2.11. +TIP: The summary presented here is up-to-date as of 2022-11-23 and was tested with Nix 2.3 and 2.11. The function implementing equality in C++ Nix is `EvalState::eqValues` which starts with [the following bit of code][eqValues-pointer-eq]: @@ -79,7 +79,7 @@ In fact, we can also write our `pointerEqual` function as: lhs: rhs: [ lhs ] == [ rhs ] ``` -It's interesting that `EvalState::eqValues` forces the left and right hand value before trying pointer +It's interesting that `EvalState::eqValues` forces the left and right-hand value before trying pointer equality. It explains that `let x = throw ""; in x == x` does not evaluate successfully, but it is puzzling why `let f = x: x; in f == f` does not return `true`. In fact, why do we need to wrap the values in a list or attribute set at all for our `pointerEqual` function to work? @@ -183,7 +183,7 @@ indicating that pointer comparison may be removed in the future. Now, I can't speak for the upstream C++ Nix developers, but sure can speculate. As already pointed out, this feature is currently needed for evaluating nixpkgs. -While it's use could realistically be eliminated (only bothersome spot is probably +While its use could realistically be eliminated (only bothersome spot is probably the `emulator` function, but that should also be doable), removing the feature would seriously compromise C++ Nix's ability to evaluate historical nixpkgs revision which is arguably a strength of the system. |