Skip to content

Commit

Permalink
Docs(README): Clarify ship options vs default command
Browse files Browse the repository at this point in the history
Should compensate for #25 a bit as well.

Signed-off-by: Paul Mabileau <paulmabileau@hotmail.fr>
  • Loading branch information
PaulDance committed Dec 24, 2024
1 parent e02aae1 commit e5fbb98
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,11 @@ Options:
#### Default command

When the subcommand is omitted, it will use the `ship` subcommand with default
options. See its specific documentation for more details.
options. In particular, this means its options are not made available globally
and have to be given explicitly to the subcommand, even if the default command
is a form of shortcut to it. For example, if `cargo liner` did not run as
expected and `--no-fail-fast` is desired, then `cargo liner ship --no-fail-fast`
needs to be used. See its specific documentation for more details.

Simply run `cargo liner` in order to:
* Read packages from the configuration file.
Expand Down

0 comments on commit e5fbb98

Please sign in to comment.