Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Ignore generated ral code #15

Closed
teburd opened this issue Mar 2, 2020 · 1 comment · Fixed by #16
Closed

Ignore generated ral code #15

teburd opened this issue Mar 2, 2020 · 1 comment · Fixed by #16
Assignees
@mciantyre
Labels
imxrt-ral RAL related issue question Further information is requested

Comments

@teburd
Copy link
Member

teburd commented Mar 2, 2020

I think it might make sense to ignore any generated code, to make it clearer that those files really shouldn't be edited by hand. It does mean any contributor would need to have python and some tooling installed (though already done semi-automatically via make venv) to generate the ral files.

I'd like some feedback on that before doing it.
@teburd teburd added question Further information is requested imxrt-ral RAL related issue labels Mar 2, 2020
teburd added a commit that referenced this issue Mar 2, 2020
@teburd
Ignore generated ral files
bc7391f 
This helps clarify to contributors these files are generated not
written by hand. It also helps build confidence in code generation
by enforcing the need to generate these files for each checkout.

Crate users would not need to deal with this.

Fixes #15
@teburd teburd mentioned this issue Mar 2, 2020
Merged
teburd added a commit that referenced this issue Mar 2, 2020
@teburd
Ignore generated ral files
50a4806 
This helps clarify to contributors these files are generated not
written by hand. It also helps build confidence in code generation
by enforcing the need to generate these files for each checkout.

Crate users would not need to deal with this.

Fixes #15
@teburd
Copy link
Member Author

teburd commented Mar 3, 2020

I went ahead and did it, but will wait on merging based on feedback. I'm also looking to automatically get a CI flow going in github actions that generates the code and builds it at the very least.

@teburd teburd closed this as completed in #16 Mar 4, 2020
This was referenced Jun 29, 2020
Closed
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mciantyre mciantyre

Labels
imxrt-ral RAL related issue question Further information is requested
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Ignore generated ral files imxrt-rs/imxrt-hal
2 participants
@teburd @mciantyre