microsoft/openvmm
Publicmirrored from https://github.com/microsoft/openvmmAvailable
Guide/src/dev_guide/dev_tools/xtask.md
18lines · modeblame
3fb1f627Daniel Prilik1 years ago | 1 | # cargo xtask |
| 2 | | |
| 3 | `cargo xtask` is OpenVMM's "swiss army knife" Rust binary that houses various | |
| 4 | bits of project specific tooling. | |
| 5 | | |
| 6 | For more info on how `xtask` is different from `xflowey`, see [`xflowey` vs | |
| 7 | `xtask`](./xflowey.md#xflowey-vs-xtask). | |
| 8 | | |
| 9 | Some examples of tools that you can find under `xtask`: | |
| 10 | | |
| 11 | - `cargo xtask fmt` implements various OpenVMM-specific style / linting rules | |
| 12 | - `cargo xtask fuzz` implements various OpenVMM-specific `cargo fuzz` extensions | |
| 13 | - `cargo xtask install-git-hooks` sets up git hooks for developers | |
| 14 | | |
| 15 | This list is not exhaustive. Running `cargo xtask` will list what tools are | |
| 16 | available, along with brief descriptions of what they do / how to use them. | |
| 17 | | |
| 18 | For more information of the `xtask` pattern, see <https://github.com/matklad/cargo-xtask> |