wroclaw-git-backups/nix
1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-07-07 06:01:48 +02:00
Code Activity

C API: fix docs build after rebase

Browse source
This commit is contained in:
José Luis Lafuente 2024-01-09 22:51:39 +01:00 • committed by José Luis Lafuente
parent 92dacec0e4
commit 24604d024a
No known key found for this signature in database
GPG key ID: 8A3455EBE455489A
7 changed files with 23 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/external-api/README.md
View file

@ -48,7 +48,7 @@ int main() {
return 0;
}
```
**Usage:**
```ShellSession
$ gcc main.c $(pkg-config nix-expr-c --libs --cflags) -o main
@ -66,7 +66,7 @@ It will increment the argument if it is an integer and throw an error otherwise.
#include <nix_api_util.h>
#include <nix_api_expr.h>
#include <nix_api_value.h>
void increment(void* user_data, nix_c_context* ctx, State* state, Value** args, Value* v) {
nix_value_force(NULL, state, args[0]);
if (nix_get_type(NULL, args[0]) == NIX_TYPE_INT) {
@ -75,7 +75,7 @@ void increment(void* user_data, nix_c_context* ctx, State* state, Value** args,
nix_set_err_msg(ctx, NIX_ERR_UNKNOWN, "First argument should be an integer.");
}
}
void nix_plugin_entry() {
const char* args[] = {"n", NULL};
PrimOp *p = nix_alloc_primop(NULL, increment, 1, "increment", args, "Example custom built-in function: increments an integer", NULL);

16
doc/external-api/local.mk
View file

@ -1,19 +1,7 @@
.PHONY: external-api-html
ifeq ($(external_api_docs), yes)
$(docdir)/external-api/html/index.html $(docdir)/external-api/latex: $(d)/doxygen.cfg
mkdir -p $(docdir)/external-api
{ cat $< ; echo "OUTPUT_DIRECTORY=$(docdir)/external-api" ; } | doxygen -
# Generate the HTML API docs for Nix's unstable external interfaces.
# Generate the HTML API docs for Nix's unstable C bindings
.PHONY: external-api-html
external-api-html: $(docdir)/external-api/html/index.html
else
# Make a nicer error message
external-api-html:
@echo "External API docs are disabled. Configure with '--enable-external-api-docs', or avoid calling 'make external-api-html'."
@exit 1
endif