Merge #439

439: Add commit and date info to generated crates r=Emilgardis a=cr1901

I don't need this feature as much now, but I know more than once in the past while adding msp430 feature I've forgotten that my changes haven't been incorporated into a release yet.

This means the docs.rs docs are out of date relative to the PAC. I've added some info to the doc string to mention the commit and date that svd2rust was compiled with, and explicitly how to generate up-to-date svd2rust docs.

Co-authored-by: William D. Jones <thor0505@comcast.net>

Author: bors[bot]

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Added
+
+- Generated crates now contain the git commit hash and date of svd2rust
+  compilation.
+
 ### Fixed
 
 - Keyword sanitizing (`async`)

src/generate/device.rs

@@ -20,13 +20,29 @@ pub fn render(
 ) -> Result<TokenStream> {
     let mut out = TokenStream::new();
 
+    let commit_info = {
+        let tmp = include_str!(concat!(env!("OUT_DIR"), "/commit-info.txt"));
+
+        if tmp.is_empty() {
+            " (untracked)"
+        } else {
+            tmp
+        }
+    };
+
     let doc = format!(
         "Peripheral access API for {0} microcontrollers \
-         (generated using svd2rust v{1})\n\n\
-         You can find an overview of the API [here].\n\n\
-         [here]: https://docs.rs/svd2rust/{1}/svd2rust/#peripheral-api",
+         (generated using svd2rust v{1}{2})\n\n\
+         You can find an overview of the generated API [here].\n\n\
+         API features to be included in the [next] svd2rust \
+         release can be generated by cloning the svd2rust [repository], \
+         checking out the above commit, and running `cargo doc --open`.\n\n\
+         [here]: https://docs.rs/svd2rust/{1}/svd2rust/#peripheral-api\n\
+         [next]: https://github.com/rust-embedded/svd2rust/blob/master/CHANGELOG.md#unreleased\n\
+         [repository]: https://github.com/rust-embedded/svd2rust",
         d.name.to_uppercase(),
-        env!("CARGO_PKG_VERSION")
+        env!("CARGO_PKG_VERSION"),
+        commit_info
     );
 
     if target == Target::Msp430 {