Skip to content

Add commit and date info to generated crates #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 1, 2020

Conversation

cr1901
Copy link
Contributor

@cr1901 cr1901 commented Apr 27, 2020

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.

@cr1901 cr1901 requested a review from a team as a code owner April 27, 2020 06:55
@rust-highfive
Copy link

r? @burrbull

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-tools labels Apr 27, 2020
Copy link
Member

@Emilgardis Emilgardis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this approach, however, do we need to mention how to generate a "newer" API?

Linking svd2rust repo would be nice though.

Also, I would like it if we switched over to println!("cargo:rustc-env=REV={}", git_rev), but that's another pr.

cr1901 and others added 2 commits April 27, 2020 17:20
@cr1901
Copy link
Contributor Author

cr1901 commented Apr 28, 2020

@Emilgardis

Also, I would like it if we switched over to println!("cargo:rustc-env=REV={}", git_rev), but that's another pr.

FWIW, msp430_svd uses the vergen crate to do what you described. See its build.rs.

@Emilgardis
Copy link
Member

bors r+

@bors
Copy link
Contributor

bors bot commented May 1, 2020

Build succeeded:

@bors bors bot merged commit 3f0e249 into rust-embedded:master May 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants