Documentation
¶
Overview ¶
Package tools is a parent directory marker for repo-local Go tooling that is built but not redistributed as part of the public libtftest module surface.
Each sub-directory is its own `package main` Go program. Tools live here so they can `import` libtftest packages cheaply during development without leaking into the redistributable surface — the `tools/...` import path is reserved for build-time helpers, never runtime dependencies.
Current tools:
- tools/docgen — scans the repo for // libtftest:requires markers, renders the feature matrix in docs/feature-matrix.md, and gates CI on every RequirePro caller having a marker. See tools/docgen/doc.go for details.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Command docgen scans the libtftest repo for `// libtftest:requires <tag>[,<tag>...] <reason>` marker comments, emits a JSON intermediate representation, renders the human-readable feature matrix to docs/feature-matrix.md, and gates CI by verifying that every function calling libtftest.RequirePro carries a marker.
|
Command docgen scans the libtftest repo for `// libtftest:requires <tag>[,<tag>...] <reason>` marker comments, emits a JSON intermediate representation, renders the human-readable feature matrix to docs/feature-matrix.md, and gates CI by verifying that every function calling libtftest.RequirePro carries a marker. |
Click to show internal directories.
Click to hide internal directories.