actions/cargo-binstall
1
0
Fork 0
mirror of https://github.com/cargo-bins/cargo-binstall.git synced 2025-06-15 15:16:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update doc

Browse source 
Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
This commit is contained in:
Jiahao XU 2024-08-07 23:39:04 +10:00
parent c82a74c73f
commit f66c3016f3
No known key found for this signature in database
GPG key ID: 76D1E687CA3C4928
2 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
SUPPORT.md
View file

@ -13,6 +13,7 @@ As an example, the configuration would be like this:
pkg-url = "{ repo }/releases/download/v{ version }/{ name }-{ target }-v{ version }{ archive-suffix }" pkg-url = "{ repo }/releases/download/v{ version }/{ name }-{ target }-v{ version }{ archive-suffix }"
bin-dir = "{ name }-{ target }-v{ version }/{ bin }{ binary-ext }" bin-dir = "{ name }-{ target }-v{ version }/{ bin }{ binary-ext }"
pkg-fmt = "tgz" pkg-fmt = "tgz"
disabled-strategies = ["quick-install", "compile"]
``` ```
With the following configuration keys: With the following configuration keys:
@ -20,7 +21,11 @@ With the following configuration keys:
- `pkg-url` specifies the package download URL for a given target/version, templated - `pkg-url` specifies the package download URL for a given target/version, templated
- `bin-dir` specifies the binary path within the package, templated (with an `.exe` suffix on windows) - `bin-dir` specifies the binary path within the package, templated (with an `.exe` suffix on windows)
- `pkg-fmt` overrides the package format for download/extraction (defaults to: `tgz`) - `pkg-fmt` overrides the package format for download/extraction (defaults to: `tgz`)
- `disabled-strategies` to disable specific strategies (e.g. `crate-meta-data` for trying to find pre-built on your repository, `quick-install` for pre-built from third-party cargo-bins/cargo-quickinstall, `compile` for falling back to `cargo-install`) for your crate (defaults to empty array). The user can override this by explicitly specifying --strategies on the command line. - `disabled-strategies` to disable specific strategies (e.g. `crate-meta-data` for trying to find pre-built on your repository,
`quick-install` for pre-built from third-party cargo-bins/cargo-quickinstall, `compile` for falling back to `cargo-install`)
for your crate (defaults to empty array).
If `--strategies` is passed on the command line, then the `disabled-strategies` in `package.metadata` will be ignored.
Otherwise, the `disabled-strategies` in `package.metadata` and `--disable-strategies` will be merged.
`pkg-url` and `bin-dir` are templated to support different names for different versions / architectures / etc. `pkg-url` and `bin-dir` are templated to support different names for different versions / architectures / etc.

8
crates/bin/src/args.rs
View file

@ -155,6 +155,10 @@ pub struct Args {
/// Specify the strategies to be used, /// Specify the strategies to be used,
/// binstall will run the strategies specified in order. /// binstall will run the strategies specified in order.
/// ///
/// If this option is specified, then cargo-binstall will ignore
/// `disabled-strategies` in `package.metadata` in the cargo manifest
/// of the installed packages.
///
/// Default value is "crate-meta-data,quick-install,compile". /// Default value is "crate-meta-data,quick-install,compile".
#[clap( #[clap(
help_heading = "Overrides", help_heading = "Overrides",
@ -167,6 +171,10 @@ pub struct Args {
/// Disable the strategies specified. /// Disable the strategies specified.
/// If a strategy is specified in `--strategies` and `--disable-strategies`, /// If a strategy is specified in `--strategies` and `--disable-strategies`,
/// then it will be removed. /// then it will be removed.
///
/// If `--strategies` is not specified, then the strategies specified in this
/// option will be merged with the disabled-strategies` in `package.metadata`
/// in the cargo manifest of the installed packages.
#[clap( #[clap(
help_heading = "Overrides", help_heading = "Overrides",
long, long,