Eric Githinji 6d3dec9c4c Add note clarifying xtask not a package to be installed. (#2847) ...

As mentioned in #2803 , if someone has the `cargo-xtask` crate installed
in their system, they will get a deprecation warning every time they run
one of the `cargo xtask ...` commands.

The only way to encounter the deprecation warning is by someone
intentionally running `cargo install cargo-xtask`. To mitigate this we
are adding a note in the README to explain the usage of xtask in the
project and that it is not a package to be installed.

A previous PR #2804 addressed this by adding aliases for each xtask
subcommand and deprecating the use of `cargo xtask` as a prefix for
these commands. While this fixes the warning, the disadvantage is that
it doesn't allow one to run `cargo xtask` to view all available
subcommands in the project with help instructions. Also the help message
that appears if one does e.g. `cargo install-tools --help` still refers
to `xtask` which might be confusing for the user. So overall it's a
better user experience to keep the usage as `cargo xtask <subcommand>`.

Also the use of `cargo xtask` is a pattern used in other large rust
projects (see some examples
[here](https://github.com/matklad/cargo-xtask?tab=readme-ov-file#external-examples)).

Co-authored-by: Eric Githinji <egithinji@google.com>

2025-08-12 22:08:56 -04:00

..

config.toml

Add note clarifying xtask not a package to be installed. (#2847)

2025-08-12 22:08:56 -04:00