Visit Page
4
1
Fork
You've already forked pages
2

upgrade: Update the documentation to promote bmputil v1 use. #58

Merged
esden merged 3 commits from doc/update-instructions-for-bmputil-v1 into main 2025年07月13日 08:20:16 +02:00
esden commented 2025年07月13日 03:22:39 +02:00 (Migrated from github.com)
Copy link

Since the new bmputil v1 now supports automatic firmware updates we should promote that as the best way to keep the Black Magic Probe current.

Since the new bmputil v1 now supports automatic firmware updates we should promote that as the best way to keep the Black Magic Probe current.
@ -1,35 +1,126 @@
# Firmware Upgrade

This is an over-long line - we suggest inserting a new line just before the link text to get it to flow more nicely

This is an over-long line - we suggest inserting a new line just before the link text to get it to flow more nicely

to the latest release candidate? (Given this won't just pick an arbitrary one)

`to the latest release candidate`? (Given this won't just pick an arbitrary one)

It's usually bleeding edge or cutting edge, not both for the expression.. We'd suggest going for cutting edge in this context.

It's usually `bleeding edge` or `cutting edge`, not both for the expression.. We'd suggest going for `cutting edge` in this context.

Might be worth linking to nightly.link here instead so this can be done without a GH account?

Might be worth linking to nightly.link here instead so this can be done without a GH account?
@ -4,0 +16,4 @@
We recommend the following order of operations:
* [Install rustup](https://rustup.rs/)
* [Install cargo-binstall](https://github.com/cargo-bins/cargo-binstall?tab=readme-ov-file#installation)

nitpick: Missing new line before this for Markdown lint happiness

nitpick: Missing new line before this for Markdown lint happiness
@ -4,3 +97,4 @@
### Download or build the firmware
Download or compile the Black Magic Debug (BMD) firmware. Regarding firmware selection:

nitpick: Missing new line before this line (Markdown lint)

nitpick: Missing new line before this line (Markdown lint)

Had meant to comment on submitting the review: This is generally looking really good - there are just a handful of fairly small things that might do with tweaking and then we can merge this.

Had meant to comment on submitting the review: This is generally looking really good - there are just a handful of fairly small things that might do with tweaking and then we can merge this.
esden (Migrated from github.com) reviewed 2025年07月13日 08:09:22 +02:00
@ -4,0 +16,4 @@
We recommend the following order of operations:
* [Install rustup](https://rustup.rs/)
* [Install cargo-binstall](https://github.com/cargo-bins/cargo-binstall?tab=readme-ov-file#installation)
esden (Migrated from github.com) commented 2025年07月13日 08:09:21 +02:00
Copy link

sounds good :)

sounds good :)
esden (Migrated from github.com) reviewed 2025年07月13日 08:09:42 +02:00
@ -1,35 +1,126 @@
# Firmware Upgrade
esden (Migrated from github.com) commented 2025年07月13日 08:09:42 +02:00
Copy link

Yeah forgot to go over and reindent the paragraphs in general.

Yeah forgot to go over and reindent the paragraphs in general.
esden (Migrated from github.com) reviewed 2025年07月13日 08:11:38 +02:00
@ -1,35 +1,126 @@
# Firmware Upgrade
esden (Migrated from github.com) commented 2025年07月13日 08:11:38 +02:00
Copy link

Fixed. :)

Fixed. :)
esden (Migrated from github.com) reviewed 2025年07月13日 08:11:56 +02:00
@ -1,35 +1,126 @@
# Firmware Upgrade
esden (Migrated from github.com) commented 2025年07月13日 08:11:56 +02:00
Copy link

Good point. Fixed :)

Good point. Fixed :)
esden (Migrated from github.com) reviewed 2025年07月13日 08:12:09 +02:00
@ -1,35 +1,126 @@
# Firmware Upgrade
esden (Migrated from github.com) commented 2025年07月13日 08:12:09 +02:00
Copy link

Added, good idea. :)

Added, good idea. :)
@ -1,35 +1,126 @@
# Firmware Upgrade

Missing opening [ here to make this a README link.

Missing opening `[` here to make this a README link.
esden (Migrated from github.com) reviewed 2025年07月13日 08:18:43 +02:00
@ -1,35 +1,126 @@
# Firmware Upgrade
esden (Migrated from github.com) commented 2025年07月13日 08:18:43 +02:00
Copy link

how about now? :D

how about now? :D
@ -1,35 +1,126 @@
# Firmware Upgrade

That'll do the trick ^_^

That'll do the trick ^_^
dragonmux left a comment
Copy link

This all LGTM, merging. Thank you for sorting this out in light of the bmputil release! 🙂

This all LGTM, merging. Thank you for sorting this out in light of the `bmputil` release! 🙂
Sign in to join this conversation.
No reviewers
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
blackmagic-debug/pages!58
Reference in a new issue
blackmagic-debug/pages
No description provided.
Delete branch "doc/update-instructions-for-bmputil-v1"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?