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

Drop the append-only versioning doctrine; document the version script

Browse Source 
Module APIs and the library's exported ABI are versioned and retired
deliberately: a break ships as a new table version or a new symbol
version node, and consumers judge the versions they are handed.

Document src/libdpm-core.map — what it pins, what belongs in it, and
how a generation is retired — and declare DPM_CORE_0.1 as the shape
the next retired node takes.
This commit is contained in:
Chris Punches
2026-08-14 02:35:03 -04:00
parent 298f4d5afe
commit 267529bee3
7 changed files with 164 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/DOCUMENTATION.md
View File

@@ -1,9 +1,9 @@
# Generating the Code Reference
When Doxygen is present, the build offers a docs target that generates the API and source reference from the documentation comments carried in the headers and sources. Two output formats are available as configure-time options:
When Doxygen is present, the build offers a `docs` target that generates the API and source reference from the documentation comments carried in the headers and sources. Two output formats are available as configure-time options:
- **-DDPM_DOCS_PDF** (default ON) — PDF reference, via Doxygen's native LaTeX output; requires pdflatex and makeindex
- **-DDPM_DOCS_HTML** (default OFF) — HTML reference
- **`-DDPM_DOCS_PDF`** (default ON) — PDF reference, via Doxygen's native LaTeX output; requires `pdflatex` and `makeindex`
- **`-DDPM_DOCS_HTML`** (default OFF) — HTML reference
Generate and compile the PDF reference:
@@ -11,9 +11,9 @@ Generate and compile the PDF reference:
cmake --build <build-dir> --target docs-pdf
```
The PDF lands at <build-dir>/docs/latex/refman.pdf.
The PDF lands at `<build-dir>/docs/latex/refman.pdf`.
With DPM_DOCS_HTML enabled at configure time, the docs target additionally produces the HTML reference in <build-dir>/docs/html:
With `DPM_DOCS_HTML` enabled at configure time, the `docs` target additionally produces the HTML reference in `<build-dir>/docs/html`:
```
cmake -B <build-dir> -DDPM_DOCS_HTML=ON