mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2024-11-21 21:46:15 +02:00
C API: fix docs build after rebase
This commit is contained in:
parent
92dacec0e4
commit
24604d024a
7 changed files with 23 additions and 18 deletions
9
Makefile
9
Makefile
|
@ -129,3 +129,12 @@ internal-api-html:
|
||||||
@echo "Internal API docs are disabled. Configure with '--enable-internal-api-docs', or avoid calling 'make internal-api-html'."
|
@echo "Internal API docs are disabled. Configure with '--enable-internal-api-docs', or avoid calling 'make internal-api-html'."
|
||||||
@exit 1
|
@exit 1
|
||||||
endif
|
endif
|
||||||
|
|
||||||
|
ifeq ($(ENABLE_EXTERNAL_API_DOCS), yes)
|
||||||
|
$(eval $(call include-sub-makefile, doc/external-api/local.mk))
|
||||||
|
else
|
||||||
|
.PHONY: external-api-html
|
||||||
|
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
|
||||||
|
|
|
@ -12,6 +12,7 @@ ENABLE_BUILD = @ENABLE_BUILD@
|
||||||
ENABLE_DOC_GEN = @ENABLE_DOC_GEN@
|
ENABLE_DOC_GEN = @ENABLE_DOC_GEN@
|
||||||
ENABLE_FUNCTIONAL_TESTS = @ENABLE_FUNCTIONAL_TESTS@
|
ENABLE_FUNCTIONAL_TESTS = @ENABLE_FUNCTIONAL_TESTS@
|
||||||
ENABLE_INTERNAL_API_DOCS = @ENABLE_INTERNAL_API_DOCS@
|
ENABLE_INTERNAL_API_DOCS = @ENABLE_INTERNAL_API_DOCS@
|
||||||
|
ENABLE_EXTERNAL_API_DOCS = @ENABLE_EXTERNAL_API_DOCS@
|
||||||
ENABLE_S3 = @ENABLE_S3@
|
ENABLE_S3 = @ENABLE_S3@
|
||||||
ENABLE_UNIT_TESTS = @ENABLE_UNIT_TESTS@
|
ENABLE_UNIT_TESTS = @ENABLE_UNIT_TESTS@
|
||||||
GTEST_LIBS = @GTEST_LIBS@
|
GTEST_LIBS = @GTEST_LIBS@
|
||||||
|
|
|
@ -177,6 +177,10 @@ AC_ARG_ENABLE(internal-api-docs, AS_HELP_STRING([--enable-internal-api-docs],[Bu
|
||||||
ENABLE_INTERNAL_API_DOCS=$enableval, ENABLE_INTERNAL_API_DOCS=no)
|
ENABLE_INTERNAL_API_DOCS=$enableval, ENABLE_INTERNAL_API_DOCS=no)
|
||||||
AC_SUBST(ENABLE_INTERNAL_API_DOCS)
|
AC_SUBST(ENABLE_INTERNAL_API_DOCS)
|
||||||
|
|
||||||
|
AC_ARG_ENABLE(external-api-docs, AS_HELP_STRING([--enable-external-api-docs],[Build API docs for Nix's external unstable C interfaces]),
|
||||||
|
ENABLE_EXTERNAL_API_DOCS=$enableval, ENABLE_EXTERNAL_API_DOCS=no)
|
||||||
|
AC_SUBST(ENABLE_EXTERNAL_API_DOCS)
|
||||||
|
|
||||||
AS_IF(
|
AS_IF(
|
||||||
[test "$ENABLE_FUNCTIONAL_TESTS" == "yes" || test "$ENABLE_DOC_GEN" == "yes"],
|
[test "$ENABLE_FUNCTIONAL_TESTS" == "yes" || test "$ENABLE_DOC_GEN" == "yes"],
|
||||||
[NEED_PROG(jq, jq)])
|
[NEED_PROG(jq, jq)])
|
||||||
|
|
|
@ -48,7 +48,7 @@ int main() {
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Usage:**
|
**Usage:**
|
||||||
```ShellSession
|
```ShellSession
|
||||||
$ gcc main.c $(pkg-config nix-expr-c --libs --cflags) -o main
|
$ 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_util.h>
|
||||||
#include <nix_api_expr.h>
|
#include <nix_api_expr.h>
|
||||||
#include <nix_api_value.h>
|
#include <nix_api_value.h>
|
||||||
|
|
||||||
void increment(void* user_data, nix_c_context* ctx, State* state, Value** args, Value* v) {
|
void increment(void* user_data, nix_c_context* ctx, State* state, Value** args, Value* v) {
|
||||||
nix_value_force(NULL, state, args[0]);
|
nix_value_force(NULL, state, args[0]);
|
||||||
if (nix_get_type(NULL, args[0]) == NIX_TYPE_INT) {
|
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.");
|
nix_set_err_msg(ctx, NIX_ERR_UNKNOWN, "First argument should be an integer.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void nix_plugin_entry() {
|
void nix_plugin_entry() {
|
||||||
const char* args[] = {"n", NULL};
|
const char* args[] = {"n", NULL};
|
||||||
PrimOp *p = nix_alloc_primop(NULL, increment, 1, "increment", args, "Example custom built-in function: increments an integer", NULL);
|
PrimOp *p = nix_alloc_primop(NULL, increment, 1, "increment", args, "Example custom built-in function: increments an integer", NULL);
|
||||||
|
|
|
@ -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
|
$(docdir)/external-api/html/index.html $(docdir)/external-api/latex: $(d)/doxygen.cfg
|
||||||
mkdir -p $(docdir)/external-api
|
mkdir -p $(docdir)/external-api
|
||||||
{ cat $< ; echo "OUTPUT_DIRECTORY=$(docdir)/external-api" ; } | doxygen -
|
{ 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
|
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
|
|
||||||
|
|
|
@ -184,6 +184,9 @@ in {
|
||||||
./doc/manual
|
./doc/manual
|
||||||
] ++ lib.optionals enableInternalAPIDocs [
|
] ++ lib.optionals enableInternalAPIDocs [
|
||||||
./doc/internal-api
|
./doc/internal-api
|
||||||
|
] ++ lib.optionals enableExternalAPIDocs [
|
||||||
|
./doc/external-api
|
||||||
|
] ++ lib.optionals (enableInternalAPIDocs || enableExternalAPIDocs) [
|
||||||
# Source might not be compiled, but still must be available
|
# Source might not be compiled, but still must be available
|
||||||
# for Doxygen to gather comments.
|
# for Doxygen to gather comments.
|
||||||
./src
|
./src
|
||||||
|
|
|
@ -109,7 +109,7 @@ bool nix_store_is_valid_path(nix_c_context * context, Store * store, StorePath *
|
||||||
/**
|
/**
|
||||||
* @brief Realise a Nix store path
|
* @brief Realise a Nix store path
|
||||||
*
|
*
|
||||||
* Blocking, calls callback once for each realisedoutput
|
* Blocking, calls callback once for each realised output
|
||||||
*
|
*
|
||||||
* @param[out] context Optional, stores error information
|
* @param[out] context Optional, stores error information
|
||||||
* @param[in] store Nix Store reference
|
* @param[in] store Nix Store reference
|
||||||
|
|
Loading…
Reference in a new issue