microsoft/openvmm
Publicmirrored fromhttps://github.com/microsoft/openvmmAvailable
Guide/src/dev_guide/dev_tools/xtask.md
19lines · modecode
| 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 clean` cleans build system artifacts (flowey, packages, test results) |
| 12 | - `cargo xtask fmt` implements various OpenVMM-specific style / linting rules |
| 13 | - `cargo xtask fuzz` implements various OpenVMM-specific `cargo fuzz` extensions |
| 14 | - `cargo xtask install-git-hooks` sets up git hooks for developers |
| 15 | |
| 16 | This list is not exhaustive. Running `cargo xtask` will list what tools are |
| 17 | available, along with brief descriptions of what they do / how to use them. |
| 18 | |
| 19 | For more information of the `xtask` pattern, see <https://github.com/matklad/cargo-xtask> |
| 20 | |