mirror of https://github.com/rust-lang/rust-clippy synced 2024-12-11 22:02:55 +00:00

History

Jade 6c2199ea9f rfc3052: Remove authors field from Cargo manifests Since RFC 3052 soft deprecated the authors field anyway, hiding it from crates.io, docs.rs, and making Cargo not add it by default, and it is not generally up to date/useful information, we should remove it from crates in this repo.		2021-07-29 14:56:05 -07:00
..
src	Merge commit '3ae8faff4d46ad92f194c2a4b941c3152a701b31' into clippyup	2021-06-03 08:41:37 +02:00
Cargo.toml	rfc3052: Remove authors field from Cargo manifests	2021-07-29 14:56:05 -07:00
LICENSE-APACHE	Merge commit '7ea7cd165ad6705603852771bf82cc2fd6560db5' into clippyup2	2020-05-28 15:45:24 +02:00
LICENSE-MIT	Merge commit '7ea7cd165ad6705603852771bf82cc2fd6560db5' into clippyup2	2020-05-28 15:45:24 +02:00
README.md	Update Copyright year	2020-02-20 12:06:45 +01:00

README.md

rustc_tools_util

A small tool to help you generate version information for packages installed from a git repo

Usage

Add a build.rs file to your repo and list it in Cargo.toml

build = "build.rs"

List rustc_tools_util as regular AND build dependency.

[dependencies]
rustc_tools_util = "0.1"

[build-dependencies]
rustc_tools_util = "0.1"

In build.rs, generate the data in your main()

fn main() {
    println!(
        "cargo:rustc-env=GIT_HASH={}",
        rustc_tools_util::get_commit_hash().unwrap_or_default()
    );
    println!(
        "cargo:rustc-env=COMMIT_DATE={}",
        rustc_tools_util::get_commit_date().unwrap_or_default()
    );
    println!(
        "cargo:rustc-env=RUSTC_RELEASE_CHANNEL={}",
        rustc_tools_util::get_channel().unwrap_or_default()
    );
}

Use the version information in your main.rs

use rustc_tools_util::*;

fn show_version() {
    let version_info = rustc_tools_util::get_version_info!();
    println!("{}", version_info);
}

This gives the following output in clippy: clippy 0.0.212 (a416c5e 2018-12-14)

License

Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option. All files in the project carrying such notice may not be copied, modified, or distributed except according to those terms.