Skip to content

Correct typo in 24_typical_flash_part_layout.md #26

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

Open
wants to merge 2 commits into
base: release/1.28
Choose a base branch
from

Conversation

grahammc-bit
Copy link

@grahammc-bit grahammc-bit commented Jan 12, 2025

Update 24_typical_flash_part_layout.md

Updated the following lines in 24_typical_flash_part_layout.md:
Line 43: GUIED -> GUIDED
Line 45: facility -> facilitate

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Matthew Graham [email protected]

@makubacki makubacki requested a review from a team March 5, 2025 23:35
Copy link

@makubacki makubacki left a comment

Choose a reason for hiding this comment

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

Content looks good, but need the commit message updated.

@@ -42,7 +42,7 @@ the tools for creating a compressed image and a library for decompressing the
image must be provided. These non-standard compression, encryption, signing or
verification mechanisms are applied to a GUIED encapsulation section. Each
Copy link

@bexcran bexcran Mar 5, 2025

Choose a reason for hiding this comment

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

Could you fix this at the same time please?
Similar to below, I think it should be "GUIDED".

Copy link
Author

Choose a reason for hiding this comment

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

I'll make the change but will need confirmation regarding validity. Thank you for the suggestion.

@makubacki
Copy link

makubacki commented Mar 24, 2025

Can you please add the Contributed-under and Signed-off-by tags to the second commit as well? If you'd like to make both fixes in a single commit, I'm fine with that, but please squash them locally and push it.

@mdkinney
Copy link
Contributor

I see this is targeting a release branch. This change look like it should go to the master branch first and then a different PR to apply to 1.28 branch if that is required. A change to master branch would be included in the next official release.

Update facility -> facilitate. I believe this was the intended verbiage from the original author.
Update 24_typical_flash_part_layout.md

Updated the following lines in 24_typical_flash_part_layout.md:
   Line 43: GUIED -> GUIDED
   Line 45: facility -> facilitate

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Matthew Graham <[email protected]>
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.

4 participants