Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 25 additions & 13 deletions website/docs/omitframepointer.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,40 @@
omitframepointer - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
Controls whether the frame pointer is omitted during compilation.

```lua
omitframepointer (value)
```

### Parameters ###

## Parameters
`value` is one of:
* `Default`: Use the compiler's default behavior.
* `On`: Omit the frame pointer.
* `Off`: Keep the frame pointer.

* `Default`: needs documentation
* `On`: needs documentation
* `Off`: needs documentation

## Applies To ###

## Applies To
The `config` scope.

### Availability ###

## Availability
Premake 5.0.0 alpha 14 or later.

### Examples ###
## Examples
Keep frame pointer in debug builds for better stack traces:
```lua
filter "configurations:Debug"
omitframepointer "Off"
```

Omit frame pointer in release builds:
```lua
filter "configurations:Release"
omitframepointer "On"
```

Use compiler defaults across all configurations:
```lua
omitframepointer (value)
omitframepointer "Default"
```

## See Also
* [GCC Optimize Options](https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html#index-fomit-frame-pointer) - Documentation on `-fomit-frame-pointer`
* [MSVC Optimization Options](https://docs.microsoft.com/en-us/cpp/build/reference/oy-frame-pointer-omission) - Microsoft Visual C++ frame pointer omission documentation
* [Clang Optimization Options](https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang-fomit-frame-pointer) - Clang compiler documentation
Loading