minor #12730 Add mandatory exit status (slootjes)

javiereguiluz · javiereguiluz · commit 0a45d57b6ff2 · 2019-12-09T15:33:36.000+01:00
This PR was submitted for the 5.0 branch but it was merged into the 4.4 branch instead (closes #12730). Discussion ---------- Add mandatory exit status Since Symfony 5 it is required to return an integer from a command but this is not yet reflected in the documentation. I've modified the execute() functions and added a note with the new requirement which links to an explanation of exit statuses. Commits ------- 49f341f Add mandatory exit status
diff --git a/console.rst b/console.rst
@@ -46,6 +46,8 @@ want a command to create a user::
         protected function execute(InputInterface $input, OutputInterface $output)
         {
             // ...
+            
+            return 0;
         }
     }
 
@@ -316,6 +318,7 @@ command:
 :method:`Symfony\\Component\\Console\\Command\\Command::execute` *(required)*
     This method is executed after ``interact()`` and ``initialize()``.
     It contains the logic you want the command to execute.
+    Must return an integer which will be used as the command `exit status`_.
 
 .. _console-testing-commands:
 
@@ -395,3 +398,5 @@ tools capable of helping you with different tasks:
 * :doc:`/components/console/helpers/formatterhelper`: customize the output colorization
 * :doc:`/components/console/helpers/progressbar`: shows a progress bar
 * :doc:`/components/console/helpers/table`: displays tabular data as a table
+
+.. _`exit status`: https://en.wikipedia.org/wiki/Exit_status

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,8 @@ want a command to create a user::`
`46`	`46`	`protected function execute(InputInterface $input, OutputInterface $output)`
`47`	`47`	`{`
`48`	`48`	`// ...`
	`49`	`+`
	`50`	`+ return 0;`
`49`	`51`	`}`
`50`	`52`	`}`
`51`	`53`
`@@ -316,6 +318,7 @@ command:`
`316`	`318`	:method:`Symfony\\Component\\Console\\Command\\Command::execute` (required)
`317`	`319`	This method is executed after ``interact()`` and ``initialize()``.
`318`	`320`	`It contains the logic you want the command to execute.`
	`321`	+ Must return an integer which will be used as the command `exit status`_.
`319`	`322`
`320`	`323`	`.. _console-testing-commands:`
`321`	`324`
`@@ -395,3 +398,5 @@ tools capable of helping you with different tasks:`
`395`	`398`	* :doc:`/components/console/helpers/formatterhelper`: customize the output colorization
`396`	`399`	* :doc:`/components/console/helpers/progressbar`: shows a progress bar
`397`	`400`	* :doc:`/components/console/helpers/table`: displays tabular data as a table
	`401`	`+`
	`402`	+.. _`exit status`: https://en.wikipedia.org/wiki/Exit_status