Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
cargo-hakari
cargo hakari
is a command-line application to manage workspace-hack crates.
For an explanation of what workspace-hack packages are and how they can help, see the
about
module.
Platform support
- Unix platforms: Hakari works and is supported.
- Windows: Hakari works and outputs file paths with forward slashes for
consistency with Unix. CRLF line endings are not supported in the workspace-hack's
Cargo.toml
-- it is recommended that repositories disable automatic line ending conversion. Here's how to do it in Git. (Pull requests to improve this are welcome.)
Installation and usage
All of the below commands take options that control their behavior.
To install, run:
To update, run:
If $HOME/.cargo/bin
is in your PATH
, the cargo hakari
command will be available.
Usage
Initialize a workspace-hack crate for a workspace at path my-workspace-hack
:
Generate or update the contents of a workspace-hack crate.
Add the workspace-hack crate as a dependency to all other workspace crates:
Publish a crate that currently depends on the workspace-hack crate (cargo publish
can't be
used in this circumstance):
Disabling and uninstalling
Disable the workspace-hack crate temporarily by removing generated contents. (Re-enable by
running cargo hakari generate
).
Remove the workspace-hack crate as a dependency from all other workspace crates:
Configuration
cargo hakari
is configured through .guppy/hakari.toml
at the root of the workspace.
Example configuration:
## The name of the package used for workspace-hack unification.
= "workspace-hack"
## Cargo resolver version in use -- version 2 is highly recommended.
= "2"
## Add triples corresponding to platforms commonly used by developers here.
## https://doc.rust-lang.org/rustc/platform-support.html
= [
## "x86_64-unknown-linux-gnu",
## "x86_64-apple-darwin",
## "x86_64-pc-windows-msvc",
]
## Options to control Hakari output.
[]
## Write out exact versions rather than specifications. Set this to true if version numbers in
## `Cargo.toml` and `Cargo.lock` files are kept in sync, e.g. in some configurations of
## https://dependabot.com/.
## exact-versions = false
For more options, see the config
module.
Contributing
See the CONTRIBUTING file for how to help out.
License
This project is available under the terms of either the Apache 2.0 license or the MIT license.