[Debug] Create a main guide for Debugging #7071

wouterj · 2016-10-20T23:01:01Z

This topic was missing the main guide. This PR fixes that and also adds a couple more debugging tips.

xabbuh · 2016-12-16T16:53:24Z

debug.rst

-.. toctree::
-    :maxdepth: 1
-    :glob:
+How to Optimize your Development Environment for Debugging


xabbuh · 2016-12-16T16:53:43Z

debug.rst

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


End this paragraph with a colon?

xabbuh · 2016-12-16T16:54:10Z

debug.rst

+
+* Give the developer accurate feedback whenever something goes wrong (provided
+  by the web debug toolbar, nice exception pages, profiler, ...);
+* Be as similar as possible as the production environment to avoid problems


"Be as close as possible to the production [...]"?

xabbuh · 2016-12-16T16:54:33Z

debug.rst

+-----------------------------
+
+Interactive debug tools allow you to walk through the code step by step,
+making it easier to indentify which step is causing problems. Symfony works


xabbuh · 2016-12-16T16:55:05Z

debug.rst

+with any PHP debug environment, among them:
+
+ * Xdebug_, the most well-known PHP debugger;
+ * PsySH_, a PHP REPL_ (Read-eval-print loop) debugger. Use the


Don't we always enclose links with backticks?

xabbuh · 2016-12-16T16:56:08Z

debug.rst

+
+.. tip::
+
+    If you disable the PHP caches, don't forget to revert after your debugging


[...] revert these changes after [...]

xabbuh · 2016-12-16T16:57:07Z

debug.rst

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


[...] provides the dump() function, an alternative to PHP's var_dump() function:

xabbuh · 2016-12-16T16:57:35Z

debug.rst

+The dumper is not limited to scalar values. Arrays and objects can also be
+visualized using the VarDumper. One of the most important advantages of using
+``dump()`` is a nicer and more specialized dump of objects (e.g. Doctrine
+internals are filtered out when dumping a proxy entity).


[...] dumping an entity proxy

xabbuh · 2016-12-16T16:58:46Z

debug.rst

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


End the paragraph with a colon?

xabbuh · 2016-12-16T16:59:05Z

debug.rst

+
+``debug:container``
+    Displays information about the contents of the Symfony container for all public
+    services. To find only those matching a name, append the name as an argument.


I think the comma can be removed.

xabbuh · 2016-12-16T16:59:20Z

debug.rst

+    services. To find only those matching a name, append the name as an argument.
+
+``debug:config``
+    Shows all configured bundles, their class and their alias.


[...] their classes and their aliases.

xabbuh · 2016-12-16T16:59:38Z

debug.rst

+.. tip::
+
+    When in doubt how to use a console command, open the help section by
+    appending the ``--help`` option.


xabbuh · 2016-12-16T16:59:51Z

debug.rst

+
+``debug:translation <locale>``
+    Shows a table of the translation key, the domain, the translation and the
+    fallback translation for all known messages, if translations exist for


Remove the comma?

xabbuh · 2016-12-16T17:03:16Z

I just left some minor comments, but overall I absolutely like this PR. Great work as always Wouter. 👍

Status: Reviewed

xabbuh · 2016-12-16T17:03:58Z

Oh, and we need to update the /configuration/front_controllers_and_kernel.rst and fix the link (see the failing build job).

javiereguiluz · 2016-12-30T16:44:07Z

debug.rst

+``debug:config``
+    Shows all configured bundles, their class and their alias.
+
+``debug:router``


Maybe we should reference here the router:match command too. In my experience it's very useful for newcomers and is very useful to quickly spot routing problems.

wouterj · 2017-03-19T17:53:58Z

Ready to merge, thanks for the great review and sorry for the loooooong delay!

theofidry · 2017-03-20T01:08:14Z

debug.rst

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


I would add a not on how to install it or a link for it, as IIRC, unless the application is booted and if you forget to add the dump.php file in your composer.json, dump() won't work

The section refers to the VarDumper component installation docs. I don't think we have to duplicate the info here.

theofidry · 2017-03-20T01:09:17Z

debug.rst

+locations. To avoid problems, you can either tell your IDE to ignore the PHP
+cache files, or you can change the extension used by Symfony for these files::
+
+    $kernel->loadClassCache('classes', '.php.cache');


is loadClassCache() still a thing? I though it was no longer useful with PHP7

Indeed, let's just remove this section.

Conflicts: debug/debugging.rst

wouterj · 2017-10-07T16:01:45Z

Ready to merge imo

javiereguiluz · 2018-02-09T14:27:04Z

Wouter, I'm afraid I must close this as "won't fix" because we decided to remove the main debugging article (see #8538) and its contents are moved to different articles of the docs. Cheers!

carsonbot added the Status: Needs Review label Oct 20, 2016

wouterj mentioned this pull request Oct 20, 2016

Added the VarDumper to the debug/debugging page #7022

Closed

xabbuh reviewed Dec 16, 2016

View reviewed changes

debug.rst Outdated

.. toctree::

:maxdepth: 1

:glob:

How to Optimize your Development Environment for Debugging

Copy link

Member

xabbuh Dec 16, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Your"?

xabbuh reviewed Dec 16, 2016

View reviewed changes

debug.rst

.. tip::

When in doubt how to use a console command, open the help section by

appending the ``--help`` option.

Copy link

Member

xabbuh Dec 16, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(-h)

xabbuh reviewed Dec 16, 2016

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Dec 16, 2016

javiereguiluz reviewed Dec 30, 2016

View reviewed changes

wouterj force-pushed the debug/create_main_guide branch from 5187505 to 4f21f3a Compare March 19, 2017 17:53

theofidry reviewed Mar 20, 2017

View reviewed changes

wouterj and others added 7 commits October 7, 2017 18:00

Bootstrap main debugging guide

5dc304c

Added the VarDumper to the debug/debugging page

4c065fd

Conflicts: debug/debugging.rst

Rewrote the VarDump section a bit

a92b746

Added a section about interactive debugging tools

c015760

Moved the debug commands below again

bb389ee

Fixes after great reviews

779983d

Removed doc on load cache class

758a9f7

wouterj force-pushed the debug/create_main_guide branch from 38d364e to 758a9f7 Compare October 7, 2017 16:01

wouterj mentioned this pull request Oct 25, 2017

Remove Debugging Guide #8538

Merged

weaverryan mentioned this pull request Nov 10, 2017

Make sure the debug:* commands are documented #8610

Closed

8 tasks

javiereguiluz closed this Feb 9, 2018

wouterj deleted the debug/create_main_guide branch December 23, 2020 12:58


		.. tip::

		If you disable the PHP caches, don't forget to revert after your debugging

Uh oh!

[Debug] Create a main guide for Debugging #7071

[Debug] Create a main guide for Debugging #7071

Uh oh!

Conversation

wouterj commented Oct 20, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xabbuh commented Dec 16, 2016

Uh oh!

xabbuh commented Dec 16, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wouterj commented Mar 19, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wouterj commented Oct 7, 2017

Uh oh!

javiereguiluz commented Feb 9, 2018

Uh oh!

Uh oh!