Skip to content

[Reference] Document AppKernel config settings #2217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 4, 2013

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Feb 5, 2013

Q A
Doc fix? no
New docs? yes
Applies to all
Fixed tickets -

Todo

  • Document the Kernel name setting

We can configure some things by overriding methods of the Kernel in the AppKernel, I think we should document those. This way, we can document how to set the charset in Symfony2.1 (see #1519).

I don't understand where the name of the Kernel is used for, so I didn't include a description for that currently. Can someone (@stof ?) tell me where this is used?

@stof
Copy link
Member

stof commented Feb 11, 2013

it is used in the name of the generated classes (for the container and the routing classes) to avoid clashes when using several kernels.

* :doc:`Twig </reference/configuration/twig>`
* :doc:`Monolog </reference/configuration/monolog>`
* :doc:`Web_profiler </reference/configuration/web_profiler>`
* :doc:`Configuration in the Kernel </reference/configuration/kernel>`
Copy link
Member

Choose a reason for hiding this comment

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

this should be placed elsewhere IMO as this is not something you configure in config.yml like the others so it could be confusing

Copy link
Member Author

Choose a reason for hiding this comment

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

@stof but is some sort of configuration for the complete project. We may put a new line between these 2 lists, to make it clear it is something else, or do you have a better idea?

Copy link
Member

Choose a reason for hiding this comment

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

Maybe just add it as its own standalone bullet point below this list (so a sibling to * **Forms and Validation**) - we can try it there and see how it looks.

@wouterj
Copy link
Member Author

wouterj commented Feb 17, 2013

@stof thanks for the information. Is it usefull to document how to change this, as it doesn't look like a thing you want to change?

@stof
Copy link
Member

stof commented Feb 17, 2013

@wouterj not really. The name does not really matters to you. The case where it is useful is having several kernels (in which case you still don't care about the values as long as they are different) but the default value should be still enough most of the time as the easiest way to achieve multiple kernels (i.e. without having to overwrite lots of stuff) is simply to duplicate the structure of the app folder in a different folder (the name of the kernel defaulting to the name of this folder)

weaverryan added a commit that referenced this pull request Mar 4, 2013
[Reference] Document AppKernel config settings
@weaverryan weaverryan merged commit 65edac6 into symfony:2.0 Mar 4, 2013
weaverryan added a commit that referenced this pull request Mar 4, 2013
@weaverryan
Copy link
Member

Hi guys!

I've merged this in and made a few changes at sha: 672ded5 - including the addition of some of the final details that @stof made. If you see any errors, please let me know.

I've merged this into the 2.1 branch so that we can attack the last part of #1519 :).

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants