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

chore: updated the docs for this [PR](https://github.com/HaoboGu/rmk-… #215

Merged
merged 5 commits into from
Dec 25, 2024

Conversation

fhanrath
Copy link
Contributor

This is an update to the docs for this pull request.

@HaoboGu
Copy link
Owner

HaoboGu commented Dec 23, 2024

Thanks a lot! There are some minor issues, we can get it merged after fixing them.

@fhanrath
Copy link
Contributor Author

Alright, what issues are you referring to specifically?

@HaoboGu
Copy link
Owner

HaoboGu commented Dec 24, 2024

Alright, what issues are you referring to specifically?

Could you see the pending comments?

I can see it in the PR history

image

@fhanrath
Copy link
Contributor Author

Could you see the pending comments?

I can see it in the PR history

I'm not able to see anything like that. Only the comments on this page.
Other than that, I only see the "Commits", "Checks" and "Files changed" tab.

It looks like your Reviews are pending. I'm not too familiar with GitHub, but do you maybe need to commit or finish your review before others will be able to see it?

@fhanrath
Copy link
Contributor Author

fhanrath commented Dec 24, 2024

image

Regarding the first one:
I've compared the family ID that was used in the example before (0x2dc309c5) to the list of families and their mapping to IDS and found that stm32f411x-e maps to the correct ID. The list itself I constructed from the original python script.

Regarding the second one:
There are some families where Clap's ValueEnum injects a -between letters. Didn't notice this before, so I'll update the examples.

examples/use_rust/stm32f4/Makefile.toml Outdated Show resolved Hide resolved
examples/use_config/nrf52832_ble/Makefile.toml Outdated Show resolved Hide resolved
docs/src/user_guide/2-2_local_compilation.md Outdated Show resolved Hide resolved
@HaoboGu
Copy link
Owner

HaoboGu commented Dec 24, 2024

oh I forgot to submit the review, sorry for that!

@HaoboGu
Copy link
Owner

HaoboGu commented Dec 24, 2024

I've compared the family ID that was used in the example before (0x2dc309c5) to the list of families and their mapping to IDS and found that stm32f411x-e maps to the correct ID. The list itself I constructed from the original python script.

Got it. let's update it to stm32f4 now. There're some inconsistencies in the previous code.

"-f",
"0x2dc309c5", # Use your chip family ID in the uf2conv.py file as -f argument
"-o",
"--family",
Copy link
Owner

Choose a reason for hiding this comment

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

wrong argument

@HaoboGu
Copy link
Owner

HaoboGu commented Dec 25, 2024

pls fix the ci error then I can merge it

@HaoboGu
Copy link
Owner

HaoboGu commented Dec 25, 2024

Great work! I'm merging it, thanks a lot!

@HaoboGu
Copy link
Owner

HaoboGu commented Dec 25, 2024

There's something we can do to improve it, for example, releasing the cargo-hex-to-uf2 binary so that we can use cargo binstall to speedup the CI. Anyway, that's the future work.

@HaoboGu HaoboGu merged commit a9fe18e into HaoboGu:main Dec 25, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants