Generated reference for the harmont CMake API.
cmake
Callable singleton for the CMake toolchain — access as hm.cmake.
Call directly to construct a CMakeProject, or use the bare-form
action methods (cmake.build(), cmake.test(), etc.) for a
one-shot leaf.
cmake(*, path='.', lang='c', image=None, base=None) -> CMakeProject| Parameter | Type | Default | Description |
|---|---|---|---|
path | str | '.' | Path to the project root (where CMakeLists.txt lives). |
lang | str | 'c' | Language tag, either "c" or "cpp". Affects label |
| prefixes only; the cmake commands are identical. | |||
image | str | None | None | Local-mode Docker base image override. |
base | Step | None | None | Existing Step to attach to instead of emitting a fresh |
| apt-base step. |
Returns CMakeProject — A CMakeProject ready for action methods.
cmake.build()
build(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
cmake.configure()
configure(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
cmake.fmt()
fmt(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
cmake.test()
test(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
CMakeEntry
Callable singleton for the CMake toolchain — access as hm.cmake.
Call directly to construct a CMakeProject, or use the bare-form
action methods (cmake.build(), cmake.test(), etc.) for a
one-shot leaf.
CMakeEntry.build()
build(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
CMakeEntry.configure()
configure(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
CMakeEntry.fmt()
fmt(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
CMakeEntry.test()
test(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
CMakeProject
CMake (C/C++) project install chain — constructed via hm.cmake().
installed is the cmake-verify step. Action methods (configure,
build, test, fmt) attach leaves to installed.
Fields
| Field | Type | Default |
|---|---|---|
path | str | required |
installed | Step | required |
CMakeProject.build()
build(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
CMakeProject.configure()
configure(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
CMakeProject.fmt()
fmt(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
CMakeProject.test()
test(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step