Skip to content

Commit 74b95f2

Browse files
committed
Prepare clippy_utils for publishing
- Add metadata to clippy_utils/Cargo.toml file - Add clippy_utils README.md file
1 parent 8698c31 commit 74b95f2

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

clippy_utils/Cargo.toml

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
name = "clippy_utils"
33
version = "0.1.84"
44
edition = "2021"
5+
description = "Helpful tools for writing lints, provided as they are used in Clippy"
6+
repository = "https://github.com/rust-lang/rust-clippy"
7+
readme = "README.md"
8+
license = "MIT OR Apache-2.0"
9+
keywords = ["clippy", "lint", "utils"]
10+
categories = ["development-tools"]
511

612
[dependencies]
713
arrayvec = { version = "0.7", default-features = false }

clippy_utils/README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# `clippy-utils`
2+
3+
Helpful tools for writing lints, provided as they are used in Clippy.
4+
5+
## Usage
6+
7+
This crate is only guaranteed to build with this `nightly` toolchain:
8+
9+
<!-- begin autogenerated nightly -->
10+
```
11+
nightly-2024-11-14
12+
```
13+
<!-- end autogenerated nightly -->
14+
15+
To use `clippy-utils` in your lint, add the following to your `Cargo.toml`:
16+
17+
```
18+
clippy_utils = "0.1.XY"
19+
```
20+
21+
`XY` is the version of the nightly toolchain above and can be determined with `rustc +nightly-YYYY-MM-DD -V`.
22+
23+
## :warning: Stability :warning:
24+
25+
No stability guarantees are made for this crate! Use at your own risk.
26+
27+
Function signatures can change or be removed without replacement without any prior notice.
28+
29+
## LICENSE
30+
31+
<!-- REUSE-IgnoreStart -->
32+
33+
Copyright 2014-2024 The Rust Project Developers
34+
35+
Licensed under the Apache License, Version 2.0
36+
<[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
37+
<[https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your option. Files in the project may
38+
not be copied, modified, or distributed except according to those terms.
39+
40+
<!-- REUSE-IgnoreEnd -->

0 commit comments

Comments
 (0)