From e178b9f650e1a70e009d1fb25cd8350910ce6efe Mon Sep 17 00:00:00 2001 From: Jesse Braham Date: Fri, 31 Jan 2025 09:58:17 +0100 Subject: [PATCH] Update xtask's `README.md` --- xtask/README.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/xtask/README.md b/xtask/README.md index 128b7a769a..51a6b54915 100644 --- a/xtask/README.md +++ b/xtask/README.md @@ -8,19 +8,22 @@ Automation using [cargo-xtask](https://github.com/matklad/cargo-xtask). Usage: xtask Commands: - build-documentation Build documentation for the specified chip - build-examples Build all examples for the specified chip - build-package Build the specified package with the given options - build-tests Build all applicable tests or the specified test for a specified chip - bump-version Bump the version of the specified package(s) - fmt-packages Format all packages in the workspace with rustfmt - generate-efuse-fields Generate the eFuse fields source file from a CSV - lint-packages Lint all packages in the workspace with clippy - run-example Run the given example for the specified chip - run-doc-test Run doctests for specified chip and package - run-tests Run all applicable tests or the specified test for a specified chip - run-elfs Run all ELFs in a folder - help Print this message or the help of the given subcommand(s) + build-documentation Build documentation for the specified chip + build-documentation-index Build documentation index including the specified packages + build-examples Build all examples for the specified chip + build-package Build the specified package with the given options + build-tests Build all applicable tests or the specified test for a specified chip + bump-version Bump the version of the specified package(s) + fmt-packages Format all packages in the workspace with rustfmt + generate-efuse-fields Generate the eFuse fields source file from a CSV + lint-packages Lint all packages in the workspace with clippy + publish Attempt to publish the specified package + run-doc-tests Run doctests for specified chip and package + run-example Run the given example for the specified chip + run-tests Run all applicable tests or the specified test for a specified chip + run-elfs Run all ELFs in a folder + tag-releases Generate git tags for all new package releases + help Print this message or the help of the given subcommand(s) Options: -h, --help Print help