Skip to content

Document mwrap usage and runnable package templates - #836

Closed
Sunrisepeak wants to merge 3 commits into
mainfrom
docs/mwrap-usage-templates
Closed

Sunrisepeak wants to merge 3 commits into
mainfrom
docs/mwrap-usage-templates

Conversation

@Sunrisepeak

Copy link
Copy Markdown
Member

Traditional header-library adapters need usage guidance that keeps the package/module identity separate from the upstream C/C++ API. This change documents package-owned project templates and updates the usage skill for additive features, macro mapping, and the mcpplibs.mwrap convention.

The matching English and Chinese getting-started text links the index specification; the specification is maintained in the companion mcpp-index PR. Checkpoint commits are retained.

Closes #835.

Validation: documentation style and structure checks, skill validation, and git diff --check pass. The qualified template selector and self.name behavior were checked against current main and exercised by the ONNX Runtime template's actual scaffold/build/run integration.

Sunrisepeak added a commit that referenced this pull request Oct 23, 2026
… paths; spaced homes build (#834)

The target base: [target.<triple>].sysroot takes a package, a locator (glibc@system, musl@system, an Apple SDK, msvc@…), { path, provides } or "", from four tiers (CLI/env, the project, config.toml, the target row). It is resolved once into tc.base and measured with the driver. The artifact binds its base: PT_INTERP and RUNPATH, rule B, the fingerprint and the pack floor. A stated gnu-sysroot base hands ld --sysroot; mcpp no longer writes into a vendor's sysroot. x86_64-ios-sim is verified.

The execution host: [target.<triple>].run_under composes <run_under…> <runner…> <artifact> <args>, and runners receive MCPP_RUN_*. An Apple artifact on a non-macOS host without run_under is refused.

#832: release and dist define NDEBUG and trim the paths an artifact carries (trim_paths, ndebug). A pasted command quotes its path. A home whose path holds a space builds: build.ninja quotes its programs and toolchain paths for the host, and glibc's linker scripts quote their names (openxlings/xim-pkgindex#1044). A home outside ASCII names gcc's module mapper. xlings 2026.10.24.1 is bundled and is the vendored floor.

Docs from #836: package-owned project templates and the mcpplibs.mwrap convention.

Closes #833, #835.

Co-authored-by: speak-agent <248744407+speak-agent@users.noreply.github.com>
@Sunrisepeak

Copy link
Copy Markdown
Member Author

Carried into #834 with its three commits and their author (merged as d5ec182), released in 2026.10.24.1. Note: the getting-started page and the usage skill link https://github.com/mcpplibs/mcpp-index/blob/main/docs/mwrap.md, which does not exist yet; it resolves once the companion mcpp-index change lands.

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.

Document mwrap module wrappers and runnable package templates

2 participants