diff options
Diffstat (limited to '')
-rw-r--r-- | src/doc/man/cargo-verify-project.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/src/doc/man/cargo-verify-project.md b/src/doc/man/cargo-verify-project.md new file mode 100644 index 0000000..8b334fb --- /dev/null +++ b/src/doc/man/cargo-verify-project.md @@ -0,0 +1,58 @@ +# cargo-verify-project(1) + +## NAME + +cargo-verify-project --- Check correctness of crate manifest + +## SYNOPSIS + +`cargo verify-project` [_options_] + +## DESCRIPTION + +This command will parse the local manifest and check its validity. It emits a +JSON object with the result. A successful validation will display: + + {"success":"true"} + +An invalid workspace will display: + + {"invalid":"human-readable error message"} + +## OPTIONS + +### Display Options + +{{#options}} + +{{> options-display }} + +{{/options}} + +### Manifest Options + +{{#options}} + +{{> options-manifest-path }} + +{{> options-locked }} + +{{/options}} + +{{> section-options-common }} + +{{> section-environment }} + +## EXIT STATUS + +* `0`: The workspace is OK. +* `1`: The workspace is invalid. + +## EXAMPLES + +1. Check the current workspace for errors: + + cargo verify-project + +## SEE ALSO +{{man "cargo" 1}}, {{man "cargo-package" 1}} |