Skip to content

Commit

Permalink
Fixed issue #1537: Add links to documentation to various different "f…
Browse files Browse the repository at this point in the history
…eatures" after wizard has run
  • Loading branch information
derickr committed Aug 3, 2021
1 parent 787fa2a commit 6373e85
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 4 deletions.
8 changes: 7 additions & 1 deletion html/docs/include/features/profiler.html
Expand Up @@ -28,7 +28,13 @@ <h2>Introduction <a name="Introduction" href="#Introduction">#</a></h2>

<h2>Starting The Profiler <a name="starting" href="#starting">#</a></h2>

<p>Profiling is enabled by setting [CFG:mode] to <code>profile</code>. This
<p>In your <code>php.ini</code>, <code>99-xdebug.ini</code>, or other
distribution specific PHP ini file, change (or set) the [CFG:mode] setting to
<code>profile</code>. Please refer to <a
href='/docs/install#configure-php'>Configure PHP</a> in the documentation to
find out which PHP ini file to modify.</p>

<p>This
instructs Xdebug to start writing profiling information into the directory
configured with the [CFG:output_dir] directive. The name of the generated file
always starts with "<span class="filename">cachegrind.out.</span>" and ends by
Expand Down
8 changes: 6 additions & 2 deletions html/docs/include/features/step_debug.html
Expand Up @@ -14,9 +14,13 @@ <h2>Introduction <a name="Introduction" href="#Introduction">#</a></h2>
<a name="starting"></a>
<h2>Configuring Step Debugging <a name="configure" href="#configure">#</a></h2>

<p>In your <code>php.ini</code>, <code>90-xdebug.ini</code>, or other
<p>In your <code>php.ini</code>, <code>99-xdebug.ini</code>, or other
distribution specific PHP ini file, change (or set) the [CFG:mode] setting to
<code>debug</code>. In set-ups where PHP/Xdebug and your IDE all run on the
<code>debug</code>. Please refer to <a
href='/docs/install#configure-php'>Configure PHP</a> in the documentation to
find out which PHP ini file to modify.</p>

<p>In set-ups where PHP/Xdebug and your IDE all run on the
same host, this is all you need to configure on the PHP and Xdebug side.
<small>(Skip to <a href='#activate_debugger'>Activating the Debugger</a> if
that's the case.)</small> </p>
Expand Down
2 changes: 1 addition & 1 deletion views/docs/all_settings.php
Expand Up @@ -12,7 +12,7 @@
</p>
<p>
Unless specifically mentioneds, each setting can be set in
<code>php.ini</code>, files like <code>90-xdebug.ini</code>, but also in
<code>php.ini</code>, files like <code>99-xdebug.ini</code>, but also in
Apache's <code>.htaccess</code> and PHP-FPM's <code>.user.ini</code> files.
</p>
<a name="XDEBUG_CONFIG"></a>
Expand Down
21 changes: 21 additions & 0 deletions views/wizard/result.php
Expand Up @@ -158,3 +158,24 @@
<li>Restart the webserver</li>
<?php endif ?>
</ol>

<h2>Enabling Features</h2>

<p>Now Xdebug is installed, you can enable its features. Please refer to the
dedicated sections in the documentation about information on how to enable and
configure these Xdebug features.
<?php if ( $iniFileName ) : ?>
Where these sections refer to <code>php.ini</code> or similar, please
remember to use <code><?= $iniFileName ?></code>:</p>
<?php endif ?>

<ul>
<li><a href='/docs/develop'>Development Helpers</a> — help you get better
error messages and obtain better information from PHP's built-in
functions.</li>
<li><a href='/docs/step_debug'>Step Debugging</a> — allows you to
interactively walk through your code to debug control flow and examine data
structures.</li>
<li><a href='/docs/profiler'>Profiling</a> — allows you to find
bottlenecks in your script and visualize those with an external tool.</li>
</ul>

0 comments on commit 6373e85

Please sign in to comment.