Skip to content
New issue

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

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

Already on GitHub? # to your account

Ensure checked-in RAL is consistent with generated RAL #68

Merged
merged 4 commits into from
Jun 30, 2020
Merged

Ensure checked-in RAL is consistent with generated RAL #68

merged 4 commits into from
Jun 30, 2020

Conversation

mciantyre
Copy link
Member

@mciantyre mciantyre commented Jun 29, 2020

The goal is to enable git dependencies and lower the bar for contribution. See #65 for more information.

The PR builds on #67. To ensure the checked-in RAL code is consistent with what is auto-generated, we add a new CI job, gen-ral, which will generate the RAL and check for any file differences. If users are correctly modifying the RAL by editing the imxrtral.py script, there should be no file differences between what is checked in and what is generated. But, if the user manually modifies a RAL source file, and it's not reflected in imxrtral.py, the job fails.

Note that this PR targets the check-in-ral branch, which is described by #67. If accepted, we should also feel comfortable accepting #67.

Testing

The gen-ral job

- ensures that imxrtral.py works
- ensures that the Makefile works
- ensures that the user hasn't commited RAL changes that aren't
  described in imxrtral.py

The job will generate the RAL over the existing RAL. We check git to
see if anything changes. If there are untracked changes, we fail the
job.
Default Makefile behavior will compile all of the crates. We're
just interested in checking consistency with what's auto-generated,
since successful builds will be checked by separate jobs. Create a
new 'ci' Makefile target that does everything 'all' does, except
checking the Rust code.
@mciantyre mciantyre changed the title Feature/git dependencies Ensure checked-in RAL is consistent with generated RAL Jun 29, 2020
@mciantyre mciantyre requested a review from teburd June 29, 2020 23:40
Copy link
Member

@teburd teburd left a comment

Choose a reason for hiding this comment

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

Looks good to me, and makes sense. I like it!

@mciantyre mciantyre merged commit 984ca4b into imxrt-rs:check-in-ral Jun 30, 2020
@mciantyre mciantyre deleted the feature/git-dependencies branch June 30, 2020 21:54
mitchmindtree added a commit to mitchmindtree/teensy4-rs that referenced this pull request Jul 1, 2020
As of imxrt-rs/imxrt-hal#67 and imxrt-rs/imxrt-hal#68 the `ral` workaround
is no longer necessary.

As of imxrt-rs/imxrt-hal#69 `Peripherals::steal` is available on the
master branch.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants