Skip to content

Conversation

@PerikiyoXD
Copy link
Contributor

What does this PR do?
Updates the documentation for the omitframepointer API, 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 omitframepointer setting 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?

Updated documentation for omitframepointer parameters and examples.
Copy link
Member

@nickclark2016 nickclark2016 left a comment

Choose a reason for hiding this comment

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

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!

@nickclark2016 nickclark2016 merged commit 563dc2f into premake:master Sep 21, 2025
51 checks passed
@nickclark2016
Copy link
Member

Thanks for the contribution. In the future, please squash your branch down to a single commit.

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