search

rp-rs / rp2040-pac

A Rust PAC for the RP2040 Microcontroller
142 stars 28 forks source link

Re-evaluate checked-in generated sources #78

Open jannic opened 1 year ago

jannic commented 1 year ago

The generated sources in src/ cause a lot of noise in merge requests.

Evaluate if there is a better way. As @ithinuel wrote in the matrix room: "I'm starting to wonder if you shan't remove the src from the main branch and rather have a pipeline run and generate a parallel branch with the generated code ala gh-pages."

Disadvantages of a separate branch could be:

AkiyukiOkayasu commented 7 months ago

I agree that it is difficult to review, but it is easier for beginners to understand if the source is in the main branch.

I think it is the regression caused by svd2rust or svdtool updates that we should be worried about. I have not fully researched this yet, but what about including rp2040 in svd2rust-regress?

ithinuel commented 7 months ago

We could keep the branch with the generated sources as the visible branch but ask for contributions to be made on a dev branch.

This'd keep the best of both worlds for the cost of slightly increased complexity for contributors.