|
1 | 1 | ; This file is generated by the 'xdebug.org:html/docs/convert.php' robot |
2 | | -; for Xdebug 3.5.0alpha3 — do not modify by hand |
| 2 | +; for Xdebug 3.5.0 — do not modify by hand |
3 | 3 |
|
4 | 4 | ; ----------------------------------------------------------------------------- |
5 | 5 | ; xdebug.cli_color |
|
219 | 219 | ; |
220 | 220 | ;xdebug.connect_timeout_ms = 200 |
221 | 221 |
|
| 222 | +; ----------------------------------------------------------------------------- |
| 223 | +; xdebug.control_socket |
| 224 | +; |
| 225 | +; Introduced in version 3.3 |
| 226 | +; |
| 227 | +; Type: string, Default value: "default" |
| 228 | +; |
| 229 | +; Linux and Windows *only*. |
| 230 | +; |
| 231 | +; When set to ``"default"`` (the default value) or ``"time"``, then Xdebug will |
| 232 | +; poll an anonymous pipe (Linux) or Named Pipe (Windows) every 25 ms for a |
| 233 | +; command. |
| 234 | +; |
| 235 | +; A command can currently be used to: |
| 236 | +; |
| 237 | +; - request process information (time, memory usage, and entry file) |
| 238 | +; |
| 239 | +; - initiate a debugging session by (trying to) connect to the IDE |
| 240 | +; |
| 241 | +; - force a breakpoint |
| 242 | +; |
| 243 | +; You should use the Xdebug Control tool to interact with this control socket. |
| 244 | +; |
| 245 | +; When this setting is set to ``"off"``, then Xdebug will not create a control |
| 246 | +; socket, and hence you can't send commands to it. |
| 247 | +; |
| 248 | +; | If your system (or container) does not have a reliable TSC clock, then "default" does not enable control sockets. You have to change this setting to "time" instead. |
| 249 | +; | |
| 250 | +; | This is to prevent slowing down PHP by wasting time to check the current time through a slow clock interface. |
| 251 | +; | |
| 252 | +; | If Xdebug detects that the TSC clock is not available, it will print a warning in the log file. |
| 253 | +; | |
| 254 | +; | You can find out which clock source Xdebug has detected in xdebug_info() output. |
| 255 | +; | |
| 256 | +; | |
| 257 | +; |
| 258 | +; .. note:: |
| 259 | +; |
| 260 | +; You can programatically check whether control sockets are enabled for your |
| 261 | +; PHP build by calling xdebug_info() with ``extension-flags`` as category. If |
| 262 | +; control sockets are available, then ``control-socket`` is returned in the |
| 263 | +; resulting array. If a TSC clock is available, then ``tsc`` is also present |
| 264 | +; in the resulting array. |
| 265 | +; |
| 266 | +; |
| 267 | +;xdebug.control_socket = "default" |
| 268 | + |
222 | 269 | ; ----------------------------------------------------------------------------- |
223 | 270 | ; xdebug.discover_client_host |
224 | 271 | ; |
|
621 | 668 | ; ERR: File '/foo/cachegrind.out.2693358' could not be opened. |
622 | 669 | ; WARN: /foo: No such file or directory |
623 | 670 | ; |
624 | | -; For Function Trace: |
| 671 | +; For Function Trace and Flame Graphs: |
625 | 672 | ; |
626 | 673 | ; ERR: File '/foo/trace.1485761369' could not be opened. |
627 | 674 | ; WARN: /foo: No such file or directory |
|
689 | 736 | ; Many Linux distributions now use systemd, which implements **private tmp** |
690 | 737 | ; directories. This means that when PHP is run through a web server or as |
691 | 738 | ; PHP-FPM, the ``/tmp`` directory is prefixed with something akin to: |
692 | | -; |
693 | | -; /tmp/systemd-private-ea3cfa882b4e478993e1994033fc5feb-apache.service-FfWZRg |
694 | | -; |
| 739 | +; ``/tmp/systemd-private-ea3cfa882b4e478993e1994033fc5feb-apache.service-FfWZRg`` |
695 | 740 | ; |
696 | 741 | ; .. note:: |
697 | 742 | ; |
|
821 | 866 | ; KCacheGrind [2]. |
822 | 867 | ; |
823 | 868 | ; trace |
824 | | -; Enables the Function Trace feature, which allows you record every function |
825 | | -; call, including arguments, variable assignment, and return value that is |
826 | | -; made during a request to a file. |
| 869 | +; Enables the Function Trace and Flame Graphs features. |
| 870 | +; |
| 871 | +; The former allows you record every function call, including arguments, |
| 872 | +; variable assignment, and return value that is made during a request to a |
| 873 | +; file. |
| 874 | +; |
| 875 | +; The latter can be used to visualise certain performance characteristics. |
827 | 876 | ; |
828 | 877 | ; You can enable multiple modes at the same time by comma separating their |
829 | 878 | ; identifiers as value to xdebug.mode: ``xdebug.mode=develop,trace``. |
|
874 | 923 | ; ``XDEBUG_CONFIG``environment variable [1]. [1] |
875 | 924 | ; /docs/all_settings#XDEBUG_CONFIG |
876 | 925 | ; |
| 926 | +; .. warning:: |
| 927 | +; |
| 928 | +; Many Linux distributions now use systemd, which implements **private tmp** |
| 929 | +; directories. This means that when PHP is run through a web server or as |
| 930 | +; PHP-FPM, the ``/tmp`` directory is prefixed with something akin to: |
| 931 | +; ``/tmp/systemd-private-ea3cfa882b4e478993e1994033fc5feb-apache.service-FfWZRg`` |
| 932 | +; |
877 | 933 | ; |
878 | 934 | ;xdebug.output_dir = /tmp |
879 | 935 |
|
|
987 | 1043 | ; |
988 | 1044 | ; Type: string, Default value: default |
989 | 1045 | ; |
990 | | -; A Function Trace, Garbage Collection Statistics, Profiling, or Step Debugging |
991 | | -; can be activated at the start of a PHP request. Whether this happens depends |
992 | | -; on the value of this setting: |
| 1046 | +; Step Debugging, a Function Trace, Flame Graphs, Garbage Collection Statistics, |
| 1047 | +; or Profiling can be activated at the start of a PHP request. Whether this |
| 1048 | +; happens depends on the value of this setting: |
993 | 1049 | ; |
994 | 1050 | ; yes |
995 | 1051 | ; The functionality starts when the PHP request starts, and before any PHP |
|
1015 | 1071 | ; ``$_POST`` variable, or ``$_COOKIE`` (HTTP cookie name). |
1016 | 1072 | ; |
1017 | 1073 | ; There is a legacy fallback to a functionality specific trigger name: |
1018 | | -; ``XDEBUG_PROFILE`` (for Profiling), ``XDEBUG_TRACE`` (for a Function |
1019 | | -; Trace), and ``XDEBUG_SESSION`` (for Step Debugging). |
| 1074 | +; ``XDEBUG_PROFILE`` (for Profiling), ``XDEBUG_TRACE`` (for a Function Trace |
| 1075 | +; or Flame Graphs), and ``XDEBUG_SESSION`` (for Step Debugging). |
1020 | 1076 | ; |
1021 | 1077 | ; There is another legacy trigger for Step Debugging only. If you set the |
1022 | 1078 | ; ``XDEBUG_CONFIG`` environment variable to any value, then the step |
|
1066 | 1122 | ; table below lists the fields in each type of record. Fields are tab separated. |
1067 | 1123 | ; ----- ------------------------------------------------------------------------------ |
1068 | 1124 | ; 2 writes a trace formatted in (simple) HTML. |
| 1125 | +; ----- ------------------------------------------------------------------------------ |
| 1126 | +; 3 writes a "cost" flame graph. See the documentation on Flame Graphs for more |
| 1127 | +; information. |
| 1128 | +; ----- ------------------------------------------------------------------------------ |
| 1129 | +; 4 writes a "memory usage" flame graph. See the documentation on Flame Graphs for |
| 1130 | +; more information. |
1069 | 1131 | ; ===== ============================================================================== |
1070 | 1132 | ; |
1071 | 1133 | ; Fields for the computerized format, depend on the record type. |
1072 | 1134 | ; |
1073 | 1135 | ; *Entry Line* |
1074 | 1136 | ; |
1075 | | -; ===== ================================================================= |
| 1137 | +; ===== =================================================================== |
1076 | 1138 | ; Field Description |
1077 | | -; ===== ================================================================= |
| 1139 | +; ===== =================================================================== |
1078 | 1140 | ; 1 level |
1079 | | -; ----- ----------------------------------------------------------------- |
| 1141 | +; ----- ------------------------------------------------------------------- |
1080 | 1142 | ; 2 function # |
1081 | | -; ----- ----------------------------------------------------------------- |
| 1143 | +; ----- ------------------------------------------------------------------- |
1082 | 1144 | ; 3 always |
1083 | 1145 | ; |
1084 | 1146 | ; '0' |
1085 | | -; ----- ----------------------------------------------------------------- |
| 1147 | +; ----- ------------------------------------------------------------------- |
1086 | 1148 | ; 4 time index |
1087 | | -; ----- ----------------------------------------------------------------- |
| 1149 | +; ----- ------------------------------------------------------------------- |
1088 | 1150 | ; 5 memory usage |
1089 | | -; ----- ----------------------------------------------------------------- |
| 1151 | +; ----- ------------------------------------------------------------------- |
1090 | 1152 | ; 6 function name |
1091 | | -; ----- ----------------------------------------------------------------- |
| 1153 | +; ----- ------------------------------------------------------------------- |
1092 | 1154 | ; 7 user-defined (1) or internal function (0) |
1093 | | -; ----- ----------------------------------------------------------------- |
| 1155 | +; ----- ------------------------------------------------------------------- |
1094 | 1156 | ; 8 name of the include or require file |
1095 | | -; ----- ----------------------------------------------------------------- |
| 1157 | +; ----- ------------------------------------------------------------------- |
1096 | 1158 | ; 9 filename |
1097 | | -; ----- ----------------------------------------------------------------- |
| 1159 | +; ----- ------------------------------------------------------------------- |
1098 | 1160 | ; 10 line number |
1099 | | -; ----- ----------------------------------------------------------------- |
| 1161 | +; ----- ------------------------------------------------------------------- |
1100 | 1162 | ; 11 no. of arguments |
1101 | | -; ----- ----------------------------------------------------------------- |
1102 | | -; 12.. arguments (as many as specified in field 11) â tab separated |
1103 | | -; ===== ================================================================= |
| 1163 | +; ----- ------------------------------------------------------------------- |
| 1164 | +; 12.. arguments (as many as specified in field 11) — tab separated |
| 1165 | +; ===== =================================================================== |
1104 | 1166 | ; |
1105 | 1167 | ; *Exit Line* |
1106 | 1168 | ; |
|
1152 | 1214 | ; |
1153 | 1215 | ; This settings accepts a bitfield to enable options: |
1154 | 1216 | ; |
1155 | | -; 1 |
| 1217 | +; 0x01 |
1156 | 1218 | ; Trace file data will be appended to an already existing file with the same |
1157 | 1219 | ; name, instead of it being overwritten. |
1158 | 1220 | ; |
1159 | | -; 2 |
| 1221 | +; 0x02 |
1160 | 1222 | ; Switches the file format to a tab separated format. The format is |
1161 | 1223 | ; described in the xdebug.trace_format setting as "format 1". |
1162 | 1224 | ; |
1163 | | -; 4 |
| 1225 | +; 0x04 |
1164 | 1226 | ; Switches to a file format that shows data as an HTML table |
1165 | 1227 | ; |
1166 | | -; 8 |
| 1228 | +; 0x08 |
1167 | 1229 | ; With this bit set, |
1168 | 1230 | ; |
1169 | 1231 | ; ``.xt`` is not added automatically to the end of trace file names. |
1170 | 1232 | ; |
| 1233 | +; 0x10 |
| 1234 | +; Switches to a file format that provides information for "cost" |
| 1235 | +; flamegraphs. |
| 1236 | +; |
| 1237 | +; 0x20 |
| 1238 | +; Switches to a file format that provides information for "memory usage" |
| 1239 | +; flamegraphs. |
| 1240 | +; |
1171 | 1241 | ; To combine multiple flags, you can use bitwise-OR ( ``|``). |
1172 | 1242 | ; |
1173 | | -; ``xdebug.trace_options=2|8`` enables both the tab separated format, and stops |
1174 | | -; the addition of ``.xt`` to the end of the file name. |
| 1243 | +; ``xdebug.trace_options=0x02|0x08`` enables both the tab separated format, and |
| 1244 | +; stops the addition of ``.xt`` to the end of the file name. |
1175 | 1245 | ; |
1176 | 1246 | ; |
1177 | 1247 | ;xdebug.trace_options = 0 |
|
0 commit comments