Dark-Horse-Linux/dpm-core-ng
3
0
Fork 0
Code Issues Pull Requests Actions Activity

Stop bolding function signatures in the documentation

Browse Source 
A signature containing char** argv closed its own bold emphasis early,
which garbled the dpm_execute and dpm_module_execute entries and the
text following them. Signatures are plain code spans now, so a signature
carrying a double asterisk renders like every other one.
This commit is contained in:
Chris Punches
2026-08-16 00:21:52 -04:00
parent cd1e15acec
commit dcd8b3fa2c
3 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/CONSUMERS.md
View File

@@ -48,7 +48,7 @@ The root override is what makes chroot builds, image assembly, and sysroot manag
## Acquiring and Using Modules
**`dpm_require`** loads a module by name, on demand:
`dpm_require` loads a module by name, on demand:
```
dpm_module* mod = dpm_require(ctx, "mymodule");
@@ -56,7 +56,7 @@ dpm_module* mod = dpm_require(ctx, "mymodule");
libdpm-core.so validates the module completely at load; a handle is returned only for a fully valid module. NULL means the module is absent or invalid — `dpm_last_error`(ctx) carries the precise reason. Modules load at most once per context; repeated calls return the same handle.
**`dpm_module_info_of`** reports what the library saw in the loaded module:
`dpm_module_info_of` reports what the library saw in the loaded module:
```
dpm_module_info info;
@@ -67,7 +67,7 @@ dpm_module_info_of(ctx, mod, &info);
Deciding whether that version is suitable is yours. libdpm-core.so applies no version criterion of its own — a handle means the module is valid, not that it suits you.
**`dpm_execute`** invokes the module — a command name and arguments:
`dpm_execute` invokes the module — a command name and arguments:
```
int rc = dpm_execute(ctx, mod, "command", argc, argv);
@@ -90,12 +90,12 @@ The cursor covers every valid module in the module path; invalid candidates are
## Services
- **`dpm_core_version`()** — the library version; callable without a context.
- **`dpm_module_info_of`(ctx, mod, out)** — the name, version, and description read from a loaded module.
- **`dpm_config_get`(ctx, module, section, key)** — a value from a module's configuration namespace, or NULL if unset.
- **`dpm_log`(ctx, level, message)** — writes to the context's configured log targets; levels are `DPM_LOG_FATAL` through `DPM_LOG_DEBUG`.
- **`dpm_module_path`(ctx)** — the resolved module directory.
- **`dpm_last_error`(ctx)** — a human-readable description of the most recent failure on the context, or NULL.
- `dpm_core_version`()** — the library version; callable without a context.
- `dpm_module_info_of`(ctx, mod, out)** — the name, version, and description read from a loaded module.
- `dpm_config_get`(ctx, module, section, key)** — a value from a module's configuration namespace, or NULL if unset.
- `dpm_log`(ctx, level, message)** — writes to the context's configured log targets; levels are `DPM_LOG_FATAL` through `DPM_LOG_DEBUG`.
- `dpm_module_path`(ctx)** — the resolved module directory.
- `dpm_last_error`(ctx)** — a human-readable description of the most recent failure on the context, or NULL.
## Ownership and Errors