Skip to content

Commit 1e5425e

Browse files
committed
Added xdebug.cloud_id and DBG-W-DETACH documentation
1 parent fc53ef1 commit 1e5425e

File tree

4 files changed

+62
-0
lines changed

4 files changed

+62
-0
lines changed

.env

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
XDEBUG_MODE=develop,debug

html/docs/include/features/errors.html

+42
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,48 @@ <h2>Debugger</h2>
222222
</p>
223223
</dd>
224224

225+
<a name="DBG-W-DETACH"></a>
226+
<dt>DBG-W-DETACH</dt>
227+
<dd>
228+
<p class="reason">
229+
Xdebug succesfully connected to an IDE or <a
230+
href="https://xdebug.cloud">Xdebug Cloud</a>, but the IDE or Xdebug Cloud
231+
aborted the debugging session with the <code>detach</code> protocol
232+
command.
233+
</p>
234+
<p>
235+
IDEs can detach for several reasons:
236+
<ul>
237+
<li>The IDE can detach when it can not relate the incoming request and associated file name with its path mappings.</li>
238+
<li>The IDE chooses to ignore the request on your behalf, through a dialog.</li>
239+
<li>The IDE chooses to ignore the request for other reasons.</li>
240+
<li>You can instruct the IDE to stop debugging, and let the application running.</li>
241+
</ul>
242+
</p>
243+
<p>
244+
Suggested solutions:
245+
<ul>
246+
<li>Set up the right path mappings for your IDE.</li>
247+
<li>Don't choose to ignore the incoming debugging session when the IDE asks.</li>
248+
</ul>
249+
</p>
250+
<p>
251+
Xdebug Cloud uses detach when the Cloud ID is not existing, or when no IDE
252+
is connected for the Cloud ID. A message with the exact reason Diagnostics
253+
Log that is part of [FUNC:xdebug_info]'s output.</p>
254+
</p>
255+
<p>
256+
Suggested solutions:
257+
<ul>
258+
<li>Check whether the Cloud ID as configured in Xdebug with
259+
[CFG:cloud_id] matches the one set in your IDE.</li>
260+
<li>Check your Xdebug Cloud <a
261+
href='https://xdebug.cloud/profile#tokens'>profile page</a> to see if
262+
you have used an available token.</li>
263+
</ul>
264+
</p>
265+
</dd>
266+
225267
<a name='DBG-W-HDR'></a>
226268
<dt>DBG-W-HDR</dt>
227269
<dd>
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<p>
2+
With this setting you configure Xdebug for use with <a
3+
href="https://xdebug.cloud">Xdebug Cloud</a>. It needs to match one of the
4+
tokens from your <a href="https://xdebug.cloud/profile#tokens">profile
5+
page</a>.
6+
</p>
7+
<p>
8+
Your IDE needs to be configured with the same token for Xdebug and your IDE to
9+
communicate through Xdebug Cloud.
10+
</p>
11+
<p>In PhpStorm you can find this setting under:<br/>
12+
<code>File | Settings | PHP | Debug | Xdebug Cloud</code> for Windows and Linux<br/>
13+
<code>PhpStorm | Preferences | PHP | Debug | Xdebug Cloud</code> for macOS
14+
</p>

src/Controller/Docs/SettingsController.php

+5
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,11 @@ class SettingsController
140140
\FUNC_STEP_DEBUG
141141
],
142142

143+
'cloud_id' => [
144+
'string', '', null,
145+
\FUNC_STEP_DEBUG
146+
],
147+
143148
'connect_timeout_ms' => [
144149
'integer', 200, null,
145150
\FUNC_STEP_DEBUG

0 commit comments

Comments
 (0)