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

[ownership] Update ownership transfer documentation #24714

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

cfrantz
Copy link
Contributor

@cfrantz cfrantz commented Oct 1, 2024

Update the ownership transfer documentation.

  • Include a diagram of ownership state transitions.
  • Add a high-level description of the ownership configuration.
  • Describe the uses of the update_mode.
  • Update struct definitions to reflect the current implementation.

Copy link
Contributor

@jadephilipoom jadephilipoom left a comment

Choose a reason for hiding this comment

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

A few minor comments but LGTM 🙂

The current ownership transfer docs on the website are pretty outdated. Maybe we should consider simply updating SUMMARY.md to point to this page instead, and removing the old page?

sw/device/silicon_creator/rom_ext/doc/ownership.md Outdated Show resolved Hide resolved
sw/device/silicon_creator/rom_ext/doc/ownership.md Outdated Show resolved Hide resolved
sw/device/silicon_creator/rom_ext/doc/ownership.md Outdated Show resolved Hide resolved
sw/device/silicon_creator/rom_ext/doc/ownership.md Outdated Show resolved Hide resolved
sw/device/silicon_creator/rom_ext/doc/ownership.md Outdated Show resolved Hide resolved
Update the ownership transfer documentation.
- Include a diagram of ownership state transitions.
- Add a high-level description of the ownership configuration.
- Describe the uses of the `update_mode`.
- Update struct definitions to reflect the current implementation.

Co-authored-by: jadephilipoom <[email protected]>
Signed-off-by: Chris Frantz <[email protected]>
@cfrantz
Copy link
Contributor Author

cfrantz commented Oct 3, 2024

Documentation only; the CI failures are not related to this change.

@cfrantz cfrantz merged commit a9bbbf8 into lowRISC:earlgrey_es_sival Oct 3, 2024
23 of 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