-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prepare
clippy_utils
README and Cargo.toml for publishing (#13693)
Follow up to #13691 Adds metadata to the `clippy_utils/Cargo.toml`, which is mostly copied from the root `Cargo.toml`. Adds a `README.md` file listing the nightly version `clippy_utils` can be used with, mentions that there are no stability guarantees and the license. The next PR will add automation to update the nightly toolchains in those files and the versions in the `Cargo.toml`s. cc #13556 changelog: none
- Loading branch information
Showing
2 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# `clippy-utils` | ||
|
||
Helpful tools for writing lints, provided as they are used in Clippy. | ||
|
||
## Usage | ||
|
||
This crate is only guaranteed to build with this `nightly` toolchain: | ||
|
||
<!-- begin autogenerated nightly --> | ||
``` | ||
nightly-2024-11-14 | ||
``` | ||
<!-- end autogenerated nightly --> | ||
|
||
To use `clippy-utils` in your lint, add the following to your `Cargo.toml`: | ||
|
||
``` | ||
clippy_utils = "0.1.XY" | ||
``` | ||
|
||
`XY` is the version of the nightly toolchain above and can be determined with `rustc +nightly-YYYY-MM-DD -V`. | ||
|
||
## :warning: Stability :warning: | ||
|
||
No stability guarantees are made for this crate! Use at your own risk. | ||
|
||
Function signatures can change or be removed without replacement without any prior notice. | ||
|
||
## LICENSE | ||
|
||
<!-- REUSE-IgnoreStart --> | ||
|
||
Copyright 2014-2024 The Rust Project Developers | ||
|
||
Licensed under the Apache License, Version 2.0 | ||
<[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license | ||
<[https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your option. Files in the project may | ||
not be copied, modified, or distributed except according to those terms. | ||
|
||
<!-- REUSE-IgnoreEnd --> |