Improve rom_pick_ab_update_partition docs #2577
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kilograham
reviewed
Jul 21, 2025
| @@ -1101,6 +1101,9 @@ int rom_add_flash_runtime_partition(uint32_t start_offset, uint32_t size, uint32 | |||
| * a main image TBYB boot. It requires the same minimum workarea size as `rom_pick_ab_partition`. | |||
| * \see rom_pick_ab_partition() | |||
| * | |||
| * This should be used instead of `rom_pick_ab_partition` when performing a Flash Update Boot before calling `explicit_buy`, and can still be used without | |||
There was a problem hiding this comment.
Commenting on a wider scope:
- any in progress update or TBYB boot" perhaps "any in progress Flash Update boot or TBYB boot" (note boot repeated), though a TBYB is a flash update boot, so maybe TBYB operation IDK
- I'd put this function right after rom_pick_ab_partition in the header
- we should use \ref to refer to other functions not
func(cc @lurch) - arguably "normally" is "always" so really you could lose the word
- bit of a weird '-' in the middle of the For example sentence
- erase 2 partitions -> erase two partitions
- It also checks" It is a big dangly here (perhaps this function)
There was a problem hiding this comment.
I think I've resolved these issues, although there were no \func invocations in the current docs, so have just added more \refs
kilograham
reviewed
Jul 21, 2025
Add more `\ref`s and tidy up wording
kilograham
reviewed
Jul 21, 2025
| /*! \brief Pick A/B partition without disturbing any in progress Flash Update boot or TBYB boot | ||
| * \ingroup pico_bootrom | ||
| * | ||
| * This will call \ref rom_pick_ab_partition() using the `flash_update_boot_window_base` from the current boot, while performing extra checks to prevent disrupting |
There was a problem hiding this comment.
If we aren't copying the text from rom_pick_ab_partiton() I think we should focus on the fact that this performs the same function as rom_pick_ab_partiont(), but does a few other things. I guess this is implicit, but using "calls" just makes me think the documentation is just a precis of the function code
There was a problem hiding this comment.
I've replaced "call" with "perform the same function as" to make that clear
…pdate and replace "call"
kilograham
approved these changes
Jul 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Should be merged with raspberrypi/pico-examples#677