edk2-BuildSpecification: Document ,XIP suffix in FV INF [files] section - #27
Merged
mdkinney merged 1 commit intoJul 16, 2026
Conversation
mdkinney
requested review from
ardbiesheuvel,
leiflindholm and
makubacki
as code owners
July 15, 2026 20:36
os-d
reviewed
Jul 15, 2026
makubacki
reviewed
Jul 16, 2026
Document the optional ,XIP suffix extension to EFI_FILE_NAME entries in the Firmware Volume INF [files] section (Appendix F.3). The ,XIP suffix appended to a file path indicates that the referenced FFS file should be rebased for eXecute-In-Place (XIP) operation when ForceRebase is enabled. This suffix is auto-generated by the build system based on the Xip keyword in the applicable FDF [Rule] section and should not be manually edited. When the ,XIP suffix is present on one or more EFI_FILE_NAME entries, GenFv uses selective rebase: only files with the ,XIP suffix are rebased. When no files have the ,XIP suffix, legacy behavior of rebasing all files is preserved. Update the EBNF to add the <XipSuffix> production rule. Add Parameters section documenting XipSuffix behavior. Update Example to show ,XIP suffix usage. Update the revision history in README.md with version 1.32 changes. REF: tianocore/edk2#12551 REF: tianocore/edk2#12807 Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
mdkinney
force-pushed
the
add-xip-suffix-to-fv-inf-file-format
branch
from
July 16, 2026 18:59
e09176b to
8879745
Compare
makubacki
approved these changes
Jul 16, 2026
os-d
approved these changes
Jul 16, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Document the optional ,XIP suffix extension to EFI_FILE_NAME entries in the Firmware Volume INF [files] section (Appendix F.3).
The ,XIP suffix appended to a file path indicates that the referenced FFS file should be rebased for eXecute-In-Place (XIP) operation when ForceRebase is enabled. This suffix is auto-generated by the build system based on the Xip keyword in the applicable FDF [Rule] section and should not be manually edited.
When the ,XIP suffix is present on one or more EFI_FILE_NAME entries, GenFv uses selective rebase: only files with the ,XIP suffix are rebased. When no files have the ,XIP suffix, legacy behavior of rebasing all files is preserved.
Update the EBNF to add the production rule. Add Parameters section documenting XipSuffix behavior. Update Example to show ,XIP suffix usage.
Update the revision history in README.md with version 1.32 changes.
REF: tianocore/edk2#12551
REF: tianocore/edk2#12807
Contributed-under: TianoCore Contribution Agreement 1.1