about summary refs log tree commit diff
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2024-11-15 19:59:38 +0100
committerPhilipp Krones <hello@philkrones.com>2024-11-17 18:16:13 +0100
commit74b95f2e65a1b6c7798e819c87de1ddc61b85610 (patch)
tree66fc369120233eed4684d378e7716a28cebcc607
parent8698c31f88763c3499b2f18215cf6f8d474e09f9 (diff)
downloadrust-74b95f2e65a1b6c7798e819c87de1ddc61b85610.tar.gz
rust-74b95f2e65a1b6c7798e819c87de1ddc61b85610.zip
Prepare clippy_utils for publishing
- Add metadata to clippy_utils/Cargo.toml file
- Add clippy_utils README.md file
-rw-r--r--clippy_utils/Cargo.toml6
-rw-r--r--clippy_utils/README.md40
2 files changed, 46 insertions, 0 deletions
diff --git a/clippy_utils/Cargo.toml b/clippy_utils/Cargo.toml
index d136f3bc6f1..fb2acf700ab 100644
--- a/clippy_utils/Cargo.toml
+++ b/clippy_utils/Cargo.toml
@@ -2,6 +2,12 @@
 name = "clippy_utils"
 version = "0.1.84"
 edition = "2021"
+description = "Helpful tools for writing lints, provided as they are used in Clippy"
+repository = "https://github.com/rust-lang/rust-clippy"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+keywords = ["clippy", "lint", "utils"]
+categories = ["development-tools"]
 
 [dependencies]
 arrayvec = { version = "0.7", default-features = false }
diff --git a/clippy_utils/README.md b/clippy_utils/README.md
new file mode 100644
index 00000000000..fb1a3f13f8c
--- /dev/null
+++ b/clippy_utils/README.md
@@ -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 -->