Skip to content

docs: the ways to name a tool are whole build programs, each compiled - #44

Merged
speak-agent merged 1 commit into
mainfrom
docs/tool-sources-examples
Oct 1, 2026
Merged

speak-agent merged 1 commit into
mainfrom
docs/tool-sources-examples

Conversation

@speak-agent

Copy link
Copy Markdown
Member

Follow-up to #43, documentation only.

Chapter 3 of docs/tool-sources.md stated the four spellings by assigning the same
option four times in one main. That reads as an index rather than an example, and
no project writes it that way.

Each way is now a complete build.mcpp:

  • a program path, with deps-vcpkg
  • a tree, with deps-cmake (whose layout search differs from vcpkg's)
  • PATH as a stated choice, with rules-spirv
  • a toolkit root, with rules-cuda
  • a plain root, with rules-qt -- whose option has always been a directory
  • the vendored copy plus the machine's own, with deps-vcpkg and rerun_if_env_changed

Every example was compiled as a real build program against 0.19.0 before being
written down. That is how the missing import mcpp.plugins.tool; was found when
this chapter was first written: a feature makes a module available, not visible.

The table in 3.6 is unchanged and stays what it is -- an index of which option each
member reads and what it looks for under a root.

The chapter stated four spellings by assigning the same option four times in one
`main`, which is an index, not an example -- no project writes that. Each way is
now a complete `build.mcpp`: a program path with deps-vcpkg, a tree with
deps-cmake, PATH with rules-spirv, a toolkit root with rules-cuda, a plain root
with rules-qt, and the vendored-plus-environment program with deps-vcpkg. Every
one of them was compiled as a real build program before being written down, which
is also how the missing `import mcpp.plugins.tool;` was found earlier.

The table in 3.6 stays what it is: an index of which option each member reads and
what it looks for under a root.
@speak-agent
speak-agent merged commit e4734b8 into main Oct 1, 2026
4 checks passed
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