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.

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

README.md should mention when to use common_patches directory and discuss patching conventions #226

Closed
jessebraham opened this issue Apr 8, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@jessebraham
Copy link
Member

Since we've now changed the workflow slightly, the README.md should be updated accordingly. It should be clear to users who have never contributed before how to write patches and where to place them.

Are the common patches common to all devices? What should users do in cases of exceptions? What if patches are common to only a couple devices, do they still belong in this directory? Are we differentiating these from patches which apply to all chips in any way?

cc @MabezDev @burrbull

@jessebraham jessebraham added the documentation Improvements or additions to documentation label Apr 8, 2024
@burrbull
Copy link
Contributor

burrbull commented Apr 8, 2024

those parches are just some general rule blocks, that can be _include'd in main yaml or one in another. one or more times

@jessebraham
Copy link
Member Author

jessebraham commented Apr 26, 2024

those parches are just some general rule blocks, that can be _include'd in main yaml or one in another. one or more times

I understand that, but it may not be clear when or why to utilize these to new contributors, or the things to watch out for when doing so (having a peripheral mentioned twice in a patch file causes strange results, for instance), and I would like the entire process to remain documented like it had been the entire existence of this repository prior to merging those changes.

@burrbull
Copy link
Contributor

When rust-embedded/svdtools#229 is merged you could see how entire patch YAML looks with all rules _include'd with:

svdtools expand-patch /path/to/yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

2 participants