Skip to content

Commit 4f21f3a

Browse files
committed
Fixes after great reviews
1 parent 5ae9f70 commit 4f21f3a

File tree

2 files changed

+23
-19
lines changed

2 files changed

+23
-19
lines changed

configuration/front_controllers_and_kernel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ to `decorate`_ the kernel with additional features. Examples include:
4545
* Configuring the autoloader or adding additional autoloading mechanisms;
4646
* Adding HTTP level caching by wrapping the kernel with an instance of
4747
:ref:`AppCache <symfony-gateway-cache>`;
48-
* Enabling (or skipping) the :doc:`ClassCache </debug/debugging>`;
48+
* Enabling (or skipping) the :doc:`ClassCache </debug>`;
4949
* Enabling the :doc:`Debug Component </components/debug>`.
5050

5151
The front controller can be chosen by requesting URLs like:

debug.rst

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
.. index::
22
single: Debugging
33

4-
How to Optimize your Development Environment for Debugging
4+
How to Optimize Your Development Environment for Debugging
55
==========================================================
66

77
When you work on a Symfony project on your local machine, you should use the
88
``dev`` environment (``app_dev.php`` front controller). This environment
9-
configuration is optimized for two main purposes.
9+
configuration is optimized for two main purposes:
1010

1111
* Give the developer accurate feedback whenever something goes wrong (provided
1212
by the web debug toolbar, nice exception pages, profiler, ...);
13-
* Be as similar as possible as the production environment to avoid problems
14-
when deploying the project.
13+
* Be as close as possible to the production environment to avoid problems when
14+
deploying the project.
1515

1616
Using Interactive Debug Tools
1717
-----------------------------
1818

1919
Interactive debug tools allow you to walk through the code step by step,
20-
making it easier to indentify which step is causing problems. Symfony works
20+
making it easier to identify which step is causing problems. Symfony works
2121
with any PHP debug environment, among them:
2222

23-
* Xdebug_, the most well-known PHP debugger;
24-
* PsySH_, a PHP REPL_ (Read-eval-print loop) debugger. Use the
25-
FidryPsyshBundle_ for a dedicated Symfony integration of PsySH.
23+
* `Xdebug`_, the most well-known PHP debugger;
24+
* `PsySH`_, a PHP `REPL`_ (Read-eval-print loop) debugger. Use the
25+
`FidryPsyshBundle`_ for a dedicated Symfony integration of PsySH.
2626

2727
Disabling the Bootstrap File and Class Caching
2828
----------------------------------------------
@@ -60,8 +60,8 @@ below::
6060

6161
.. tip::
6262

63-
If you disable the PHP caches, don't forget to revert after your debugging
64-
session.
63+
If you disable the PHP caches, don't forget to revert these changes after
64+
your debugging session.
6565

6666
Some IDEs do not like the fact that some classes are stored in different
6767
locations. To avoid problems, you can either tell your IDE to ignore the PHP
@@ -74,8 +74,8 @@ Dumping Variables with the VarDumper
7474

7575
To ease the debugging of a variable in your application, you can use the
7676
:doc:`VarDumper component </components/var_dumper>` to dump the content of a
77-
variable. The component provides an alternative to the PHP :phpfunction:`var_dump()`
78-
function, in the form of ``dump()``::
77+
variable. The component provides the ``dump()`` function, an alternative to
78+
PHP's :phpfunction:`var_dump()` function::
7979

8080
// create a variable with a value
8181
$myVar = ...;
@@ -86,7 +86,7 @@ function, in the form of ``dump()``::
8686
The dumper is not limited to scalar values. Arrays and objects can also be
8787
visualized using the VarDumper. One of the most important advantages of using
8888
``dump()`` is a nicer and more specialized dump of objects (e.g. Doctrine
89-
internals are filtered out when dumping a proxy entity).
89+
internals are filtered out when dumping an entity proxy).
9090

9191
If the dumper is used on a command line, the result is a formatted string.
9292
Otherwise, the result is a piece of HTML, which can be expanded to show nested
@@ -107,28 +107,32 @@ Useful Debugging Commands
107107

108108
When developing a large application, it can be hard to keep track of all the
109109
different services, routes and translations. Luckily, Symfony has some commands
110-
that can help you visualize and find the information.
110+
that can help you visualize and find the information:
111111

112112
``debug:container``
113113
Displays information about the contents of the Symfony container for all public
114-
services. To find only those matching a name, append the name as an argument.
114+
services. Append a service ID as an argument to find only those matching the ID.
115115

116116
``debug:config``
117-
Shows all configured bundles, their class and their alias.
117+
Shows all configured bundles, their classes and their aliases.
118118

119119
``debug:router``
120120
Displays information about all configured routes in the application as a
121121
table with the name, method, scheme, host and path for each route.
122122

123+
``router:match <path_info>``
124+
Shows the route information matching the provided path info or an error if
125+
no route matches.
126+
123127
``debug:translation <locale>``
124128
Shows a table of the translation key, the domain, the translation and the
125-
fallback translation for all known messages, if translations exist for
129+
fallback translation for all known messages if translations exist for
126130
the given locale.
127131

128132
.. tip::
129133

130134
When in doubt how to use a console command, open the help section by
131-
appending the ``--help`` option.
135+
appending the ``--help`` (``-h``) option.
132136

133137
.. _Xdebug: https://xdebug.org/
134138
.. _PsySH: http://psysh.org/

0 commit comments

Comments
 (0)