Enhance omitframepointer.md documentation#2512
Merged
nickclark2016 merged 3 commits intopremake:masterfrom Sep 21, 2025
Merged
Conversation
Updated documentation for omitframepointer parameters and examples.
nickclark2016
requested changes
Sep 21, 2025
Member
nickclark2016
left a comment
nickclark2016
left a comment
There was a problem hiding this comment.
I would suggest against direct discussion of performance and behavior changes other than the fact that the frame pointer is omitted. Instead, link out to documentation from various toolchain vendors discussing the performance and other characteristics.
Other than that, this looks good. Thank you for the contribution!
Removed LLVM documentation link from the See Also section.
nickclark2016
approved these changes
Sep 21, 2025
Member
|
Thanks for the contribution. In the future, please squash your branch down to a single commit. |
noresources
pushed a commit
to noresources/premake-core
that referenced
this pull request
Jan 5, 2026
* Enhance omitframepointer.md documentation Updated documentation for omitframepointer parameters and examples. * Revise omitframepointer documentation * Remove wrong LLVM Function Attributes link Removed LLVM documentation link from the See Also section.
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
2 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.
What does this PR do?
Updates the documentation for the
omitframepointerAPI, replacing placeholder text with clear explanations of each parameter (Default,On,Off). Also adds practical usage examples for common scenarios (debug vs release builds).How does this PR change Premake's behavior?
This PR does not change Premake’s behavior. It only improves the generated documentation so users understand what the
omitframepointersetting does.Are there any breaking changes? Will any existing behavior change?
No breaking changes. This is a documentation-only update.
Anything else we should know?
This update makes the documentation more approachable for users who aren’t familiar with compiler frame pointer options. It explains the trade-off between performance optimizations and debugging convenience.
Did you check all the boxes?
closes #XXXXin comment to auto-close issue when PR is merged)