Skip to content

Commit d6cf7d8

Browse files
authored
Enhance omitframepointer.md documentation
Updated documentation for omitframepointer parameters and examples.
1 parent c3bdf5b commit d6cf7d8

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

website/docs/omitframepointer.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,30 @@ omitframepointer - This page was auto-generated. Feel free to help us improve th
44
omitframepointer (value)
55
```
66

7-
### Parameters ###
7+
### Parameters
88

99
`value` is one of:
1010

11-
* `Default`: needs documentation
12-
* `On`: needs documentation
13-
* `Off`: needs documentation
11+
* `Default`: Use the compiler’s default behavior. The compiler decides whether to omit the frame pointer based on optimization settings and target architecture.
12+
* `On`: Omit the frame pointer. This frees up a register for optimization, resulting in smaller and faster code, but makes debugging and stack traces less reliable.
13+
* `Off`: Keep the frame pointer. This provides more accurate stack traces and easier debugging at the cost of some optimization opportunities.
1414

15-
## Applies To ###
15+
## Applies To
1616

1717
The `config` scope.
1818

19-
### Availability ###
19+
### Availability
2020

2121
Premake 5.0.0 alpha 14 or later.
2222

23-
### Examples ###
23+
### Examples
2424

2525
```lua
26-
omitframepointer (value)
27-
```
26+
-- Keep frame pointer in debug builds for better stack traces
27+
filter "configurations:Debug"
28+
omitframepointer "Off"
2829

30+
-- Omit frame pointer in release builds for performance
31+
filter "configurations:Release"
32+
omitframepointer "On"
33+
```

0 commit comments

Comments
 (0)