diff --git a/docs/BUILD.md b/docs/BUILD.md index a9b696f..f5073ee 100644 --- a/docs/BUILD.md +++ b/docs/BUILD.md @@ -1,4 +1,4 @@ -# Building libdpm-core.so and the dpm binary +# Building libdpm-core.so and the dpm Binary ## Prerequisites diff --git a/docs/CONSUMERS.md b/docs/CONSUMERS.md index 75693b3..c2dc912 100644 --- a/docs/CONSUMERS.md +++ b/docs/CONSUMERS.md @@ -2,7 +2,7 @@ Programs link libdpm-core.so as an ordinary shared library dependency — the same way they link any other library — to reach the package manager in-process: build systems, installers, image builders, system tooling, and foreign-language bindings all use the library the `dpm` binary is built on. A program holding a default context is working against system configuration, the system module path, the system tree, and system locking, the same environment the installed `dpm` binary sees. -## Compiling and linking +## Compiling and Linking With the library installed, include the public header and link it: @@ -18,7 +18,7 @@ The header installs to the standard include path and the library to the standard `` names no module and carries no module-specific type. It offers two things: discovery of modules, and interaction with them. -## The context +## The Context All work happens through a context handle: @@ -46,7 +46,7 @@ Leaving `config_dir` NULL selects `/etc/dpm/conf.d/`; leaving `module_path` NULL The root override is what makes chroot builds, image assembly, and sysroot management work: package operations act on the given tree instead of the running system. Multiple simultaneous contexts with different roots are legal. -## Acquiring and using modules +## Acquiring and Using Modules **`dpm_require`** loads a module by name, on demand: @@ -75,7 +75,7 @@ int rc = dpm_execute(ctx, mod, "command", argc, argv); This is the only path into module code, and it is the same path the `dpm` binary uses and the same path a module uses to reach a peer. You address a module by name and a capability by command string, so your program compiles against no module header, no struct layout, and no module symbol. What a module accepts as commands and arguments, and what its return codes mean, is documented by that module. -## Enumerating modules +## Enumerating Modules ``` dpm_cursor* cur = dpm_list_modules(ctx); @@ -97,11 +97,11 @@ The cursor covers every valid module in the module path; invalid candidates are - **`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 +## Ownership and Errors Strings returned by the library are owned by the context (or by the module that produced them) and remain valid until `dpm_close`; callers never free them. Functions returning int use 0 for success. Functions returning pointers use NULL for failure, with detail available from `dpm_last_error`. -## Complete example +## Complete Example ``` #include diff --git a/docs/DESIGN.md b/docs/DESIGN.md index 7baa8aa..ea6f069 100644 --- a/docs/DESIGN.md +++ b/docs/DESIGN.md @@ -7,7 +7,7 @@ - Every implementation exists exactly once, and is consumable by the `dpm` binary, by other layers, and by external programs (build systems, Dark Horse tooling) through C interfaces. - No module ever links, includes, or hardcodes anything belonging to another module. Every module-to-module interaction passes through libdpm-core.so. -## Architecture overview +## Architecture Overview ``` the dpm binary -> -> module A -> -> module B @@ -18,7 +18,7 @@ a build system -> -> module A -> -> module B The header names no module and carries no module-specific type. It offers discovery and interaction, and that is the entire vocabulary — which is what allows the `dpm` binary, a build system, and a module to all use it without any of them being privileged. -### One process, one library instance +### One Process, One Library Instance The whole chain executes in the caller's address space. The `dpm` binary (or the build system) is the process; libdpm-core.so is mapped into it; every module the library loads is mapped into it as well. Calls are direct function calls — no subprocess, no serialization, no output parsing. @@ -26,7 +26,7 @@ A module links libdpm-core.so like any other consumer, and when the module is lo Modules are loaded with `RTLD_LOCAL`, so a module's symbols never enter the global namespace. The only symbols a module can resolve are libdpm-core.so's. No path from one module to another exists that does not pass through the library. -## Versioning model +## Versioning Model Every version question is settled by the party that has to live with the answer. libdpm-core.so reports; it rules on nothing. @@ -49,7 +49,7 @@ It provides: All functions are extern "C". All returned strings are owned by the library (or by the module that produced them), are valid until the context is closed, and are never freed by the caller. All functions returning int use 0 for success and nonzero error codes; details of the most recent failure are retrievable per-context. -### Context lifecycle +### Context Lifecycle **`dpm_ctx* dpm_open(const dpm_open_overrides* overrides)`** Creates a context. Reads configuration from `/etc/dpm/conf.d/` (or the config directory named in overrides), resolves the module path (overrides take precedence over config, config over the built-in default), and initializes logging per configuration. Performs no module loading. Returns NULL only on allocation failure or an unreadable/invalid explicit override; a missing config directory is not an error — defaults apply. `overrides` may be NULL, and may specify: config directory, module path, target root (for chroot/image/sysroot operation), and log level. Multiple simultaneous contexts with different roots are legal. @@ -57,10 +57,10 @@ Creates a context. Reads configuration from `/etc/dpm/conf.d/` (or the config di **`void dpm_close(dpm_ctx* ctx)`** Releases the context: unloads every module handle it issued, closes log targets, frees all memory owned by the context. All handles and strings obtained through the context are invalid after this call. NULL is a no-op. -### Module acquisition +### Module Acquisition **`dpm_module* dpm_require(dpm_ctx* ctx, const char* name)`** -Resolves the module `name` in the module path and runs the full load-time validation sequence (see Load-time enforcement) if the module is not already loaded in this context. On success returns a module handle owned by the context (repeated calls return the same handle — modules are loaded at most once per context). On failure returns NULL and records the precise reason: not found, or validation step failed with the step and detail. No version criterion is applied here; compatibility is the caller's to determine from the reported version. +Resolves the module `name` in the module path and runs the full load-time validation sequence (see Load-Time Enforcement) if the module is not already loaded in this context. On success returns a module handle owned by the context (repeated calls return the same handle — modules are loaded at most once per context). On failure returns NULL and records the precise reason: not found, or validation step failed with the step and detail. No version criterion is applied here; compatibility is the caller's to determine from the reported version. **`int dpm_module_info_of(dpm_ctx* ctx, dpm_module* mod, dpm_module_info* out)`** Fills `out` with the loaded module's name, version, and description exactly as they were read at load (string pointers valid until context close). This is how a consumer obtains the version it will judge. The library attaches no meaning to the values. Returns 0 on success, nonzero if the module cannot be reported on. @@ -81,7 +81,7 @@ Advances the cursor. Fills `out` with the next module's name, version, and descr **`void dpm_cursor_free(dpm_cursor* cur)`** Releases the cursor. NULL is a no-op. -### Services (available to modules and external consumers alike) +### Services (Available to Modules and External Consumers Alike) **`const char* dpm_core_version(void)`** Returns the library version as a static X.Y.Z string. Callable without a context. @@ -98,7 +98,7 @@ Returns the resolved module directory path for this context. **`const char* dpm_last_error(dpm_ctx* ctx)`** Returns a human-readable description of the most recent failure recorded on this context, or NULL if none. Overwritten by the next failing call on the same context. -## Module contract +## Module Contract A module is one .so in the module directory. It includes ``, links `-ldpm-core`, and exports the following reserved symbols as extern "C". Returned strings are static or module-owned, non-NULL, and valid for the lifetime of the loaded module; the library and consumers never free them. @@ -117,7 +117,7 @@ Returns a one-line human-readable description, used in module listings. **A module publishes no headers to other modules.** Its capabilities are addressed by command string through `dpm_execute`, so nothing about its internals — types, struct layouts, symbol names — is ever compiled into a caller. A module's documented command vocabulary is its interface. -## Load-time enforcement +## Load-Time Enforcement libdpm-core.so is the sole authority on module validity; the contract above is enforced by its validator, not by any SDK. Validation is all-or-nothing; a module is registered only after passing every step: @@ -126,7 +126,7 @@ libdpm-core.so is the sole authority on module validity; the contract above is e Failures happen at install/load time, loudly and itemized. Consumers never receive a partially valid module: if a handle was handed out, the contract already validated. -## Module: raw — the file-based installer +## Module: raw — The File-Based Installer Ships with the base system alongside libdpm-core.so. Depends on the baseline only; archive decompression is vendored in, and the package format is chosen to keep that small. This is what makes barren-environment operation possible: libdpm-core.so plus raw function with nothing else present. @@ -134,7 +134,7 @@ Ships with the base system alongside libdpm-core.so. Depends on the baseline onl - **Operations**, addressed as commands: install a package file, remove, verify, and queries answered by walking the tree — slow but always correct, zero dependencies. - **Owns the lock file and a transaction journal** with a generation counter. Every mutation in the entire system ultimately passes through raw, so locking and journaling are implemented exactly once and inherited by every layer above. -## Module: pkg — the full package manager +## Module: pkg — The Full Package Manager Ships as a package, installed by raw once sqlite3 is installed. Requires raw — by name, through libdpm-core.so, judging raw's reported version itself — and libsqlite3. @@ -143,11 +143,11 @@ Ships as a package, installed by raw once sqlite3 is installed. Requires raw — - Adds what the cache enables: fast queries, dependency resolution against the installed set, multi-package transactions with rollback. - Consumers that want dependency-aware operations dispatch to pkg by name; they transitively get raw's guarantees because there is no second code path to the tree. -## The dpm binary +## The dpm Binary `dpm` is argument parsing and printing. It includes ``, links `-ldpm-core`, enumerates modules, and forwards subcommands through dispatch. Its command surface is exactly the set of loadable modules — in the barren case that's raw's commands; on a full system, everything installed. No capability logic lives in it. -## External consumers +## External Consumers Build systems and Dark Horse components link `libdpm-core.so` as an ordinary shared library dependency — `#include `, `-ldpm-core`, the same as any other library they link: @@ -158,7 +158,7 @@ Build systems and Dark Horse components link `libdpm-core.so` as an ordinary sha The header installs to the standard include path and the library to the standard lib path. A consumer that opens a default context (no overrides) is working against system configuration, the system module path, the system tree, and system locking — the same environment the installed `dpm` binary sees, because that binary is just another caller of the same library. Overrides redirect individual paths only when a caller explicitly sets them. Whether a consumer addresses raw only (image builders that just deploy trees) or pkg (dependency-aware tooling) is their choice of require(); behavior is identical to the `dpm` binary's because it is the same implementation. -## Bootstrap chain +## Bootstrap Chain ``` minimal start: dpm + libdpm-core.so + raw module (baseline deps only) @@ -169,7 +169,7 @@ now: libdpm-core.so discovers pkg, validates it, full management is Every layer is a package installed and upgraded by the layer beneath it; the package manager maintains itself with the same mechanism it offers the OS. Future modules follow the identical pattern — a repo/network module declares its requirements (pkg, a TLS library), lands as a package, and the capability appears on next discovery. -## Repository structure +## Repository Structure Modules are developed independently from each other and independently from the library — one repository per module, plus the libdpm-core.so repository. Each repo owns its source, build, and tests, and produces exactly one artifact: @@ -179,7 +179,7 @@ Modules are developed independently from each other and independently from the l No repository can block another's development: a module builds and its full pre-integration test surface runs with nothing present but its own checkout and an installed or vendored libdpm-core.so. Release coordination happens through the versioning model — each consumer judging the versions it is handed — rather than through lockstep builds. -### Layout of the libdpm-core.so repository +### Layout of the libdpm-core.so Repository ``` include/dpm/ public headers — installed to the system include path; the @@ -208,17 +208,17 @@ Terminology: **the `dpm` binary** names the command-line tool; **libdpm-core.so* | `info.so` | `/usr/lib/dpm/modules/info.so` | | modules (`raw.so`, `pkg.so`, `repo.so`, `source.so`, ...) | `/usr/lib/dpm/modules/.so` | -## Development and testing +## Development and Testing Development works because the design has no build-time coupling between peers: nothing links against a peer module, ever, and nothing includes a peer's headers, ever. "Not all the pieces are there" is the normal, permanent condition at build time. What remains resolves into three test layers, each needing strictly less than the full system. -### What a build requires +### What a Build Requires A module compiles against `` and links `libdpm-core.so` — the one real link dependency, and by definition the stable, always-present, baseline-only piece. Cheap to have in every dev environment, trivially vendorable as a checkout. Peers are reached at runtime by name and command string. Building pkg does not require raw to exist anywhere, and there is no compile-time knowledge of raw to acquire — not a header, not a struct, not a symbol. A module repo therefore builds self-contained, always. -### Test layers +### Test Layers **1. Unit tests — need nothing.** The module's implementation compiles once as an object library, linked into both the .so and a test binary. Pure logic, error paths, parsing — no library, no peers. @@ -226,7 +226,7 @@ Peers are reached at runtime by name and command string. Building pkg does not r **3. Integration — the only layer that needs everything, and it builds itself.** Real libdpm-core.so plus real raw, then the actual bootstrap chain into a scratch root: `dpm_open` against an alternate root, raw installs sqlite3 and the pkg package into it, the library discovers pkg, real operations run against the throwaway tree. Because alternate roots are first-class in the API, this needs a directory, not a VM. Full-distribution CI does the same with real packages. -### Day-to-day workflow +### Day-to-Day Workflow - Working on **pkg**: edit, run unit tests (instant, zero environment), harness run with a raw stub before merge. A real raw is never needed, or even possessed, until integration. - Working on **raw**: same, except its tests need only fixture package files and a scratch tree. @@ -235,7 +235,7 @@ Peers are reached at runtime by name and command string. Building pkg does not r The discipline that keeps this honest: stubs are written to the command vocabulary the real peer documents, and layer-2 validation plus the layer-3 bootstrap run in CI, so a stub that drifts from reality is caught by the first integration pass rather than shipped. -## Development capabilities +## Development Capabilities During development the `dpm` binary must be pointable at a locally built library, and that library must be configurable to local paths (module path, config dir, etc.). Two mechanisms provide this: @@ -250,7 +250,7 @@ The config-dir override matters most: once the context reads config from the loc **Rule**: every field of the `dpm_open` overrides struct must be exposed as a flag on the `dpm` binary, so anything a linked consumer can redirect, a developer at the shell can redirect too. This holds for any future override field — nothing ships reachable from code but not from the command line. -## Evolution rules +## Evolution Rules - **A module's interface is its command vocabulary.** Retiring or changing the meaning of a command is a version change in the module that owns it, judged by every consumer that dispatches to it. - **Breaking the library's exported ABI means a new symbol version generation**: the export set is what consumers link against, so a break is a deliberate, versioned event rather than an incidental one. diff --git a/docs/MODULES.md b/docs/MODULES.md index 29472b9..e3b08d1 100644 --- a/docs/MODULES.md +++ b/docs/MODULES.md @@ -2,7 +2,7 @@ A DPM module is one shared object in the module directory. libdpm-core.so loads it, validates it completely, and dispatches commands to it on behalf of whatever asked — the `dpm` binary, a build system, or another module. This document covers writing, building, testing, and installing a module. -## The module contract +## The Module Contract A module includes ``, links `-ldpm-core`, and exports the following symbols as extern "C". All returned strings must be non-NULL, static or module-owned, and valid for the lifetime of the loaded module; callers never free them. @@ -21,7 +21,7 @@ The `dpm_ctx` type and the service declarations all come from the installed publ #include ``` -## You determine your own compatibility with the library +## You Determine Your Own Compatibility With the Library Your module is built against the system-installed `libdpm-core.so` and is responsible for being correct against it. Where you need to act on what you are running under, `dpm_core_version()` reports the running version and you decide what to do: @@ -31,7 +31,7 @@ const char* running = dpm_core_version(); Check it, proceed or fail on your own terms, and report through `dpm_log` and your return code. -## Your interface is your command vocabulary +## Your Interface Is Your Command Vocabulary A module publishes no headers, no struct layouts, and no symbols to anything that calls it. Everything it offers is reached through `dpm_module_execute`, addressed by command string, with arguments passed as an argument vector and a status returned as an int. @@ -39,7 +39,7 @@ That is what a caller compiles against: a module name and a command name, both s **Symbol naming**: every functional export is prefixed with the module's name (mymodule_\*). The dpm_ prefix is reserved for the contract symbols and for libdpm-core.so. -## Calling another module +## Calling Another Module A module reaches a peer by performing the same two steps its own caller performed — ask libdpm-core.so for the module by name, then ask libdpm-core.so to invoke it: @@ -62,7 +62,7 @@ The `ctx` is the one handed to your entry point. Nothing else is needed to reach A module that depends on a peer is the party that judges the peer's version. Require it, read its reported version with `dpm_module_info_of`, and decide whether it is suitable for the commands you intend to issue. libdpm-core.so reports; it does not rule. -## Validation at load +## Validation at Load libdpm-core.so is the sole authority on module validity, and validation is all-or-nothing. Before a module is offered to anyone, it verifies that every reserved contract symbol resolves and that the version and description probes return well-formed values. A module failing either step is refused with an itemized reason, visible in the load-failure output. A module that loads is fully valid — consumers never defend against partial states. @@ -96,7 +96,7 @@ cmake --build libdpm-core.so is the only DPM link dependency a module ever has. Dependencies on other modules are runtime concerns, resolved by name through require and dispatch — a peer module is never linked, never included, and never needs to be present to build or to test. -## Running and testing locally +## Running and Testing Locally Load the freshly built module through a locally run `dpm` binary without installing anything: @@ -112,6 +112,6 @@ Where your module calls a peer, put a **stub module** in the fixture module path Modules install to `lib/dpm/modules` under the install prefix (`/usr/lib/dpm/modules` on a distribution install). libdpm-core.so discovers the module on its next scan; no registration step exists beyond the file being present and valid. -## A working example +## A Working Example The info module bundled with the `dpm` binary and libdpm-core.so, at `src/bundled-modules/info/`, tests and demonstrates full DPM system functionality, and in doing so shows the contract, command routing, and this build structure in working form. diff --git a/docs/OVERVIEW.md b/docs/OVERVIEW.md index fbd3c61..1b8d996 100644 --- a/docs/OVERVIEW.md +++ b/docs/OVERVIEW.md @@ -1,6 +1,6 @@ # DPM — An Overview -## What DPM is +## What DPM Is DPM is the package manager for Dark Horse Linux. At its center is **libdpm-core.so**, a shared library that discovers modules, validates them, and routes calls to them, and that provides configuration and logging to whatever it has loaded. Modules — shared objects in the module directory — implement package functionality. @@ -8,7 +8,7 @@ DPM is the package manager for Dark Horse Linux. At its center is **libdpm-core. libdpm-core.so implements no package operations. It routes and hosts. -## The shape of the system +## The Shape of the System Everything reaches a module the same way, and a module reaching another module is the same step repeated: @@ -26,7 +26,7 @@ Two properties make the routing rule real rather than a convention: - **There is one instance of libdpm-core.so in the process.** A module links against the library like any other consumer, and when the module is loaded the dynamic linker binds it to the copy already mapped. A module therefore drives the same context, the same module registry, and the same configuration the original caller opened. - **Modules cannot see each other.** They are loaded with `RTLD_LOCAL`, so a module's symbols never enter the global namespace. The only symbols a module can resolve are libdpm-core.so's, so there is physically no path from one module to another that does not pass through the library. -## Running the dpm binary +## Running the dpm Binary The `dpm` binary's subcommand surface is exactly the set of loadable modules. `dpm [args...]` loads that module and hands the command to it; `dpm help` asks the module to describe itself. There is no fixed list of operations baked into the tool, because the tool contains no capability logic — it parses arguments and prints. @@ -41,7 +41,7 @@ Four flags redirect the system defaults: These four exist because of a rule the design imposes on itself: every field a linked program can override must also be a flag, so anything reachable from code is reachable from a shell. That rule holds for any override added in the future. -## Writing a program against the library +## Writing a Program Against the Library A program includes `` and links `-ldpm-core`, the same as it would link any other shared library. Everything it does happens through a **context**, an opaque handle obtained from `dpm_open`. @@ -61,7 +61,7 @@ The context owns everything it hands out. Every string a caller receives stays v **Services.** A module reaches the library through the context that dispatched the call: `dpm_log` to write a message, `dpm_config_get` to read a value from its own configuration namespace, `dpm_module_path` to learn where modules live, `dpm_core_version` to learn the library's version. A module needs no file handling and no logging machinery of its own. -## How a module reaches another module +## How a Module Reaches Another Module A module is a consumer of `` exactly like the `dpm` binary is. To reach a peer it performs the identical two steps its own caller performed: ask the library for the module by name, then ask the library to invoke it. @@ -81,7 +81,7 @@ The `ctx` a module needs is the one handed to it in its own entry point, so it r **A module never links, includes, or hardcodes anything belonging to another module.** No peer headers, no shared struct layouts, no peer symbols. The only build dependency a module has is libdpm-core.so, and the only knowledge it holds about a peer is the peer's name and the command it wants to run. That is what allows every module to live in its own repository and be built with no peer present anywhere on the machine. -## What DPM reads and writes on disk +## What DPM Reads and Writes on Disk **Configuration** lives in `/etc/dpm/conf.d/`. Each `.conf` file in that directory is one namespace named after the file: `core.conf` holds the library's own settings, and a module named `mymodule` reads `mymodule.conf`. Files are sectioned, and a value is addressed by namespace, section, and key. The library's own file carries the log level, whether to write a log file and where, and the default module directory. @@ -100,7 +100,7 @@ The `ctx` a module needs is the one handed to it in its own entry point, so it r | public header | `/usr/include/dpm/core.h` | | modules | `/usr/lib/dpm/modules/.so` | -## The module contract +## The Module Contract *What a module author implements.* @@ -110,7 +110,7 @@ The entry point receives the context that dispatched the call, the command name, A module is built against the system-installed `libdpm-core.so` and is responsible for being correct against it. Where it needs to know what it is running on, `dpm_core_version()` reports the running version and the module acts on that itself. -## Load-time enforcement +## Load-Time Enforcement libdpm-core.so validates a module completely before offering it to anyone: @@ -129,29 +129,29 @@ A module determines its own compatibility with the library it is running against A module that depends on another module requires it, reads the version reported back, and decides for itself whether that version is suitable for the commands it intends to issue. libdpm-core.so reports what it saw and draws no conclusion from it, so a handle means the module is valid rather than that it suits any particular caller. -## Why it works this way +## Why It Works This Way -### Because it must run on a barren system +### Because It Must Run on a Barren System The founding constraint is that DPM has to work in an environment providing nothing but libc and libstdc++, using the same binaries that run on a fully populated system. That forbids libdpm-core.so from taking on any dependency beyond the baseline, which forbids package logic from living inside it, which produces the division the whole architecture rests on: **libdpm-core.so routes and hosts, modules implement.** Anything needing a database, compression, or TLS is a module that arrives later. -### Because capability has to grow in layers +### Because Capability Has to Grow in Layers Each layer of the system installs the dependencies of the next using only what already works. That requires upper layers to reach lower ones through a stable in-process interface rather than by re-implementing them, and it requires writes to flow strictly downward — a layer mutates the system only through the layer beneath it. Shared concerns like locking are then implemented once, at the bottom, and inherited by everything above. -### Because one implementation must serve every caller +### Because One Implementation Must Serve Every Caller The requirement that every implementation exist exactly once, and be consumable by the `dpm` binary, by other layers, and by external programs, is what makes libdpm-core.so a C ABI library rather than an application with a library carved out of it. It is also why the command line and the C API stay in step: the flags are the override fields, one for one, so a program and a person redirect the same things by the same names. -### Because nothing may be trusted that has not been verified +### Because Nothing May Be Trusted That Has Not Been Verified libdpm-core.so is the sole authority on module validity, and the contract is enforced by its validator rather than by an SDK a module author might skip, patch, or fall behind. That is why validation is all-or-nothing and why it happens at load: failures surface loudly and itemized at install time instead of halfway through an operation on a user's system. -### Because coordination happens at load, not at build +### Because Coordination Happens at Load, Not at Build A caller states the module name and command it needs and is told at load whether the module is there. That is what allows modules to be released independently: agreement is reached when the pieces meet, through declared versions each consumer judges for itself, instead of through lockstep builds. -### Because modules are developed independently +### Because Modules Are Developed Independently One repository per module, plus the libdpm-core.so repository. A module links libdpm-core.so and nothing else from DPM; peer modules never appear in its repository, build, or test environment. "Not all the pieces are there" is the normal, permanent condition at build time, so the architecture is arranged to make that a non-event: @@ -162,7 +162,7 @@ One repository per module, plus the libdpm-core.so repository. A module links li This repository's own fixtures are deliberately broken stub modules — missing symbols, a malformed version — plus one known-good stub. Developing libdpm-core.so never requires a real package module to exist. -## What this repository produces +## What This Repository Produces - **`libdpm-core.so`** — the library - **the `dpm` binary** — the command-line tool @@ -179,7 +179,7 @@ Every other module is developed against libdpm-core.so and lives outside this re 5. A module is either fully valid or not loaded — no partial states, no consumer-side defense. 6. Anything a linked program can redirect, a shell user can redirect too. -## Further reading +## Further Reading - **DESIGN.md** — the full design specification - **CONSUMERS.md** — linking libdpm-core.so and driving it from a program diff --git a/include/dpm/core.h b/include/dpm/core.h index f1f8e90..e463bc0 100644 --- a/include/dpm/core.h +++ b/include/dpm/core.h @@ -321,7 +321,7 @@ DPM_API const char* dpm_last_error(dpm_ctx* ctx); /* ------------------------------------------------------------------ */ /** - * @mainpage libdpm-core.so — API reference + * @mainpage libdpm-core.so — API Reference * * This is the generated reference for libdpm-core.so, extracted from * the source. It covers the public C API in , the library's @@ -336,7 +336,7 @@ DPM_API const char* dpm_last_error(dpm_ctx* ctx); */ /** - * @page module_contract The module contract + * @page module_contract The Module Contract * * A module is one .so in the module directory. It includes * , links -ldpm-core, and exports three reserved symbols as @@ -349,14 +349,14 @@ DPM_API const char* dpm_last_error(dpm_ctx* ctx); * const char* dpm_module_description(void); * @endcode * - * @section module_contract_surface The functional surface + * @section module_contract_surface The Functional Surface * * dpm_module_execute is the module's entire functional surface; its * capabilities are addressed by command string, so a module publishes * no headers, struct layouts, or symbols to anything that calls it. * NULL or an empty command behaves as the module's help command. * - * @section module_contract_version Version compatibility + * @section module_contract_version Version Compatibility * * A module determines for itself whether it can work with the library * it is running against: dpm_core_version() reports the running