8000 docs: add a guide for adding support for an external package by aivazis · Pull Request #41 · aivazis/mm · GitHub
[go: up one dir, main page]

Skip to content

docs: add a guide for adding support for an external package - #41

Merged
aivazis merged 1 commit into
mainfrom
docs-externals
Jun 7, 2026
Merged

aivazis merged 1 commit into
mainfrom
docs-externals

Conversation

@aivazis
@aivazis aivazis commented Jun 7, 2026
Copy link
Copy Markdown
Owner

Adds docs/externals.md — a recipe-scope how-to for adding support for an external package, in the voice of docs/testing.md. Motivated by the .dependencies work (PR #40): adding an external now involves real judgment calls (induced dependencies, which values warrant markers.required, installed vs. declared) that aren't visible in any single init.mm.

Covers:

  • the four tiers — declared .extern → requested closure → supported → available (where available = <pkg>.dir resolves)
  • an annotated make/extern/<pkg>/init.mm template
  • .dependencies as load-bearing: static, induced (the hdf5 → mpi example, lazy =), and load-time-chosen (gsl/blas)
  • verification markers, with the rule of thumb that markers.required is only for a conditionally computed critical value
  • flavor/mode-driven libraries (mpi/fftw/vtk/hdf5)
  • installed-vs-declared and the extern.complain.severity knob
  • checking work with mm extern.info / mm <pkg>.verify / mm extern.verify, a checklist, and override locations

Also adds externals.md (and the previously-missing testing.md) to README's Documentation list. Docs-only; no code changes.

@aivazis
aivazis merged commit 9f3f4d2 into main Jun 7, 2026
@aivazis
aivazis deleted the docs-externals branch June 7, 2026 23:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

0