minor #10914 Mentioned all the debug:* commands (javiereguiluz)

javiereguiluz · javiereguiluz · commit 843a05636b86 · 2019-01-22T08:37:48.000+01:00
This PR was merged into the 4.2 branch. Discussion ---------- Mentioned all the debug:* commands Fixed #8610. Commits ------- fbf8676 Mentioned all the debug:* commands
diff --git a/form/create_custom_field_type.rst b/form/create_custom_field_type.rst
@@ -87,6 +87,15 @@ The goal of this field was to extend the choice type to enable selection of the
 shipping type. This is achieved by fixing the ``choices`` to a list of available
 shipping options.
 
+.. tip::
+
+    Run the following command to verify that the form type was successfully
+    registered in the application:
+
+    .. code-block:: terminal
+
+        $ php bin/console debug:form
+
 Creating a Template for the Field
 ---------------------------------
 
diff --git a/form/create_form_type_extension.rst b/form/create_form_type_extension.rst
@@ -81,6 +81,15 @@ Once the extension is registered, any method that you've overridden (e.g.
 ``buildForm()``) will be called whenever *any* field of the given type
 (``FileType``) is built.
 
+.. tip::
+
+    Run the following command to verify that the form type extension was
+    successfully registered in the application:
+
+    .. code-block:: terminal
+
+        $ php bin/console debug:form
+
 Adding the extension Business Logic
 -----------------------------------
 
diff --git a/form/type_guesser.rst b/form/type_guesser.rst
@@ -232,3 +232,12 @@ and tag it with ``form.type_guesser``:
             ->getFormFactory();
 
         // ...
+
+.. tip::
+
+    Run the following command to verify that the form type guesser was
+    successfullyregistered in the application:
+
+    .. code-block:: terminal
+
+        $ php bin/console debug:form
diff --git a/reference/forms/types/birthday.rst b/reference/forms/types/birthday.rst
@@ -50,6 +50,8 @@ option defaults to 120 years ago to the current year.
 | Class                | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\BirthdayType`        |
 +----------------------+-------------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Overridden Options
 ------------------
 
diff --git a/reference/forms/types/button.rst b/reference/forms/types/button.rst
@@ -19,6 +19,8 @@ A simple, non-responsive button.
 | Class                | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ButtonType` |
 +----------------------+----------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Inherited Options
 -----------------
 
diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst
@@ -37,6 +37,8 @@ if you want to handle submitted values like "0" or "false").
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\CheckboxType` |
 +-------------+------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Example Usage
 -------------
 
diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst
@@ -50,6 +50,8 @@ To use this field, you must specify *either* ``choices`` or ``choice_loader`` op
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ChoiceType`         |
 +-------------+------------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Example Usage
 -------------
 
diff --git a/reference/forms/types/collection.rst b/reference/forms/types/collection.rst
@@ -40,6 +40,8 @@ photos).
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\CollectionType`    |
 +-------------+-----------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 .. note::
 
     If you are working with a collection of Doctrine entities, pay special
diff --git a/reference/forms/types/color.rst b/reference/forms/types/color.rst
@@ -36,6 +36,8 @@ element.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ColorType` |
 +-------------+---------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Inherited Options
 -----------------
 
diff --git a/reference/forms/types/country.rst b/reference/forms/types/country.rst
@@ -54,6 +54,8 @@ the option manually, but then you should just use the ``ChoiceType`` directly.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\CountryType` |
 +-------------+-----------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/currency.rst b/reference/forms/types/currency.rst
@@ -46,6 +46,8 @@ manually, but then you should just use the ``ChoiceType`` directly.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\CurrencyType` |
 +-------------+------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/date.rst b/reference/forms/types/date.rst
@@ -47,6 +47,8 @@ and can understand a number of different input formats via the `input`_ option.
 | Class                | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\DateType`          |
 +----------------------+-----------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Basic Usage
 -----------
 
diff --git a/reference/forms/types/dateinterval.rst b/reference/forms/types/dateinterval.rst
@@ -51,6 +51,8 @@ or an array (see `input`_).
 | Class                | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\DateIntervalType`       |
 +----------------------+----------------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Basic Usage
 -----------
 
diff --git a/reference/forms/types/datetime.rst b/reference/forms/types/datetime.rst
@@ -56,6 +56,8 @@ the data can be a ``DateTime`` object, a string, a timestamp or an array.
 | Class                | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\DateTimeType`      |
 +----------------------+-----------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/email.rst b/reference/forms/types/email.rst
@@ -29,6 +29,8 @@ The ``EmailType`` field is a text field that is rendered using the HTML5
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\EmailType` |
 +-------------+---------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Inherited Options
 -----------------
 
diff --git a/reference/forms/types/entity.rst b/reference/forms/types/entity.rst
@@ -54,6 +54,8 @@ objects from the database.
 | Class       | :class:`Symfony\\Bridge\\Doctrine\\Form\\Type\\EntityType`       |
 +-------------+------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Basic Usage
 -----------
 
diff --git a/reference/forms/types/file.rst b/reference/forms/types/file.rst
@@ -31,6 +31,8 @@ The ``FileType`` represents a file input in your form.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FileType`  |
 +-------------+---------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Basic Usage
 -----------
 
diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst
@@ -46,6 +46,8 @@ on all types for which ``FormType`` is the parent.
 | Class     | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType` |
 +-----------+--------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/hidden.rst b/reference/forms/types/hidden.rst
@@ -23,6 +23,8 @@ The hidden type represents a hidden input field.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\HiddenType` |
 +-------------+----------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Overridden Options
 ------------------
 
diff --git a/reference/forms/types/integer.rst b/reference/forms/types/integer.rst
@@ -42,6 +42,8 @@ integers. By default, all non-integer values (e.g. 6.78) will round down
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\IntegerType` |
 +-------------+-----------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/language.rst b/reference/forms/types/language.rst
@@ -56,6 +56,8 @@ manually, but then you should just use the ``ChoiceType`` directly.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\LanguageType` |
 +-------------+------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/locale.rst b/reference/forms/types/locale.rst
@@ -57,6 +57,8 @@ manually, but then you should just use the ``ChoiceType`` directly.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\LocaleType`   |
 +-------------+------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/money.rst b/reference/forms/types/money.rst
@@ -43,6 +43,8 @@ how the input and output of the data is handled.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\MoneyType` |
 +-------------+---------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/number.rst b/reference/forms/types/number.rst
@@ -38,6 +38,8 @@ that you want to use for your number.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\NumberType` |
 +-------------+----------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/options/_debug_form.rst.inc b/reference/forms/types/options/_debug_form.rst.inc
@@ -0,0 +1,9 @@
+.. tip::
+
+    The full list of options defined and inherited by this form type is
+    available running this command in your app:
+
+    .. code-block:: terminal
+
+        # replace 'FooType' by the class name of your form type
+        $ php bin/console debug:form FooType
diff --git a/reference/forms/types/password.rst b/reference/forms/types/password.rst
@@ -31,6 +31,8 @@ The ``PasswordType`` field renders an input password text box.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\PasswordType` |
 +-------------+------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/percent.rst b/reference/forms/types/percent.rst
@@ -40,6 +40,8 @@ This field adds a percentage sign "``%``" after the input box.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\PercentType` |
 +-------------+-----------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/radio.rst b/reference/forms/types/radio.rst
@@ -40,6 +40,8 @@ If you want to have a boolean field, use :doc:`CheckboxType </reference/forms/ty
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\RadioType` |
 +-------------+---------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Inherited Options
 -----------------
 
diff --git a/reference/forms/types/range.rst b/reference/forms/types/range.rst
@@ -29,6 +29,8 @@ The ``RangeType`` field is a slider that is rendered using the HTML5
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\RangeType` |
 +-------------+---------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Basic Usage
 -----------
 
diff --git a/reference/forms/types/repeated.rst b/reference/forms/types/repeated.rst
@@ -35,6 +35,8 @@ accuracy.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\RepeatedType` |
 +-------------+------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Example Usage
 -------------
 
diff --git a/reference/forms/types/reset.rst b/reference/forms/types/reset.rst
@@ -19,6 +19,8 @@ A button that resets all fields to their original values.
 | Class                | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ResetType` |
 +----------------------+---------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Inherited Options
 -----------------
 
diff --git a/reference/forms/types/search.rst b/reference/forms/types/search.rst
@@ -30,6 +30,8 @@ Read about the input search field at `DiveIntoHTML5.info`_
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\SearchType` |
 +-------------+----------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Inherited Options
 -----------------
 
diff --git a/reference/forms/types/submit.rst b/reference/forms/types/submit.rst
@@ -21,6 +21,8 @@ A submit button.
 | Class                | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\SubmitType` |
 +----------------------+----------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 The Submit button has an additional method
 :method:`Symfony\\Component\\Form\\ClickableInterface::isClicked` that lets
 you check whether this button was used to submit the form. This is especially
diff --git a/reference/forms/types/tel.rst b/reference/forms/types/tel.rst
@@ -35,6 +35,8 @@ to input phone numbers.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TelType`   |
 +-------------+---------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Inherited Options
 -----------------
 
diff --git a/reference/forms/types/text.rst b/reference/forms/types/text.rst
@@ -32,6 +32,8 @@ The TextType field represents the most basic input text field.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TextType` |
 +-------------+--------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Inherited Options
 -----------------
 
diff --git a/reference/forms/types/textarea.rst b/reference/forms/types/textarea.rst
@@ -29,6 +29,8 @@ Renders a ``textarea`` HTML element.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TextareaType` |
 +-------------+------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 .. tip::
 
     If you prefer to use an **advanced WYSIWYG editor** instead of a plain
diff --git a/reference/forms/types/time.rst b/reference/forms/types/time.rst
@@ -48,6 +48,8 @@ stored as a ``DateTime`` object, a string, a timestamp or an array.
 | Class                | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TimeType`          |
 +----------------------+-----------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Basic Usage
 -----------
 
diff --git a/reference/forms/types/timezone.rst b/reference/forms/types/timezone.rst
@@ -51,6 +51,8 @@ manually, but then you should just use the ``ChoiceType`` directly.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\TimezoneType` |
 +-------------+------------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/reference/forms/types/url.rst b/reference/forms/types/url.rst
@@ -32,6 +32,8 @@ have a protocol.
 | Class       | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\UrlType` |
 +-------------+-------------------------------------------------------------------+
 
+.. include:: /reference/forms/types/options/_debug_form.rst.inc
+
 Field Options
 -------------
 
diff --git a/setup.rst b/setup.rst
@@ -110,7 +110,13 @@ setup your project with the following commands:
     $ composer install
 
 You'll probably also need to customize your :ref:`.env <config-dot-env>` and do a
-few other project-specific tasks (e.g. creating database schema).
+few other project-specific tasks (e.g. creating database schema). When working
+on a existing Symfony app for the first time, it may be useful to run this
+command which displays information about the app:
+
+.. code-block:: terminal
+
+    $ php bin/console about
 
 Checking for Security Vulnerabilities
 -------------------------------------
diff --git a/templating.rst b/templating.rst
@@ -98,7 +98,12 @@ it:
 
 Twig comes with a long list of `tags`_, `filters`_ and `functions`_ that are available
 by default. You can even add your own *custom* filters, functions (and more) via
-a :doc:`Twig Extension </templating/twig_extension>`.
+a :doc:`Twig Extension </templating/twig_extension>`. Run the following command
+to list them all:
+
+.. code-block:: terminal
+
+    $ php bin/console debug:twig
 
 Twig code will look similar to PHP code, with subtle, nice differences. The following
 example uses a standard ``for`` tag and the ``cycle()`` function to print ten div tags,
diff --git a/templating/twig_extension.rst b/templating/twig_extension.rst
