mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2024-11-22 05:56:15 +02:00
docs: fixup description of builtins.importNative (#10810)
There was an argument missing and the fact that the imported function is called.
This commit is contained in:
parent
ef140c25d1
commit
49c6f34911
1 changed files with 8 additions and 8 deletions
|
@ -19,18 +19,18 @@ struct EvalSettings : Config
|
||||||
Enable built-in functions that allow executing native code.
|
Enable built-in functions that allow executing native code.
|
||||||
|
|
||||||
In particular, this adds:
|
In particular, this adds:
|
||||||
- `builtins.importNative` *path*
|
- `builtins.importNative` *path* *symbol*
|
||||||
|
|
||||||
Load a dynamic shared object (DSO) at *path* which exposes a function pointer to a procedure that initialises a Nix language value, and return that value.
|
Opens dynamic shared object (DSO) at *path*, loads the function with the symbol name *symbol* from it and runs it.
|
||||||
The procedure must have the following signature:
|
The loaded function must have the following signature:
|
||||||
```cpp
|
```cpp
|
||||||
extern "C" typedef void (*ValueInitialiser) (EvalState & state, Value & v);
|
extern "C" typedef void (*ValueInitialiser) (EvalState & state, Value & v);
|
||||||
```
|
```
|
||||||
|
|
||||||
The [Nix C++ API documentation](@docroot@/contributing/documentation.md#api-documentation) has more details on evaluator internals.
|
The [Nix C++ API documentation](@docroot@/contributing/documentation.md#api-documentation) has more details on evaluator internals.
|
||||||
|
|
||||||
- `builtins.exec` *arguments*
|
- `builtins.exec` *arguments*
|
||||||
|
|
||||||
Execute a program, where *arguments* are specified as a list of strings, and parse its output as a Nix expression.
|
Execute a program, where *arguments* are specified as a list of strings, and parse its output as a Nix expression.
|
||||||
)"};
|
)"};
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue