-
Notifications
You must be signed in to change notification settings - Fork 12.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6f5c0d2
commit 345fe6d
Showing
1 changed file
with
58 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# 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()` | ||
````rust | ||
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() | ||
); | ||
} | ||
|
||
```` | ||
|
||
Use the version information in your main.rs | ||
````rust | ||
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 | ||
|
||
Copyright 2014-2018 The Rust Project Developers | ||
|
||
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. |