Documented the console environment variables #4665
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
javiereguiluz
commented
Dec 17, 2014
| Q | A |
|---|---|
| Doc fix? | no |
| New docs? | yes |
| Applies to | all |
| Fixed tickets | #4162 |
| $ php app/console command_name | ||
|
|
||
| # 'prod' environment and debug enabled | ||
| $ php app/console command_name --env=prod |
There was a problem hiding this comment.
this is wrong. The console file has a special handling for the prod env, forcing it to be in no-debug mode: https://github.com/symfony/symfony-standard/blob/20516f547e3282a1b3aeec2a284efd311aa9f5a4/app/console#L19
Use --env=test instead for this case
| any command: | ||
|
|
||
| * ``SYMFONY_ENV``, sets the execution environment of the command to the value of | ||
| this variable (``dev``, ``prod``, ``test``, etc.) |
There was a problem hiding this comment.
this should end with a semi-colon
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| By default, Symfony commands are executed in the ``dev`` environment and with the | ||
| debug mode enabled. Use ``--env`` and ``-no-debug`` options to modify this behavior: |
| * ``SYMFONY_ENV``, sets the execution environment of the command to the value of | ||
| this variable (``dev``, ``prod``, ``test``, etc.); | ||
| * ``SYMFONY_DEBUG``, if ``0``, debug mode is disabled. Otherwise, debug mode is | ||
| enabled. |
There was a problem hiding this comment.
What about using a definition list here?
|
@javiereguiluz Wow, thanks for your really fast reaction. 👍 |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| By default, Symfony commands are executed in the ``dev`` environment and with the | ||
| debug mode enabled. Use the ``--env`` and ``-no-debug`` options to modify this |
There was a problem hiding this comment.
I think there is one dash missing in front of no-debug
There was a problem hiding this comment.
Very good catch! Thanks.
|
This is awesome - great work Javier! |
weaverryan
added a commit
that referenced
this pull request
Dec 22, 2014
…iluz) This PR was merged into the 2.3 branch. Discussion ---------- Documented the console environment variables | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | all | Fixed tickets | #4162 Commits ------- df2a0f2 Fixes and tweaks dd8157f More tweaks and grammar fixes 2fb082d Rewordings and transformed a list into a definition list a1d88d8 More grammar fixes 8ead4a4 Minor grammar fix 6fc8f4c Fixed some errors in the explanation 7c4cd17 Documented the console environment variables
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.