Document the usage of the php.ini save_path #2399

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
4 participants
Contributor

tvlooy commented Mar 30, 2013

Document the usage of the php.ini save_path

Q A
Doc fix? no
New docs? yes
Applies to all
Fixed tickets #2364
reference/configuration/framework.rst
@@ -242,7 +242,15 @@ save_path
**type**: ``string`` **default**: ``%kernel.cache.dir%/sessions``
This determines the argument to be passed to the save handler. If you choose
-the default file handler, this is the path where the files are created.
+the default file handler, this is the path where the files are created. You can
+also set this value to the save_path of your php.ini by overriding it value
@wouterj

wouterj Mar 30, 2013

Member

I prefer to have some inline code blocks here (for save_path and php.ini).

Inline code blocks are indicated with double backticks.

reference/configuration/framework.rst
-the default file handler, this is the path where the files are created.
+the default file handler, this is the path where the files are created. You can
+also set this value to the save_path of your php.ini by overriding it value
+with ~ like this:
@wouterj

wouterj Mar 30, 2013

Member

~ means null in yaml, I prefer to use null in this sentence

reference/configuration/framework.rst
+
+ framework:
+ session:
+ save_path: ~
@wouterj

wouterj Mar 30, 2013

Member

please also add a PHP and XML example.

reference/configuration/framework.rst
-the default file handler, this is the path where the files are created.
+the default file handler, this is the path where the files are created. You can
+also set this value to the ``save_path`` of your ``php.ini`` by overriding setting it to
+null:
@stof

stof Mar 30, 2013

Member

you should use an inline code block for the null value.

reference/configuration/framework.rst
+
+ <!-- app/config/config.xml -->
+ <framework:config>
+ <framework:session save_path="null" />
@stof

stof Mar 30, 2013

Member

it should be save-path in XML (otherwise, the XSD validation will fail)

weaverryan added a commit that referenced this pull request Mar 31, 2013

Member

weaverryan commented Mar 31, 2013

Awesome job Tom! I patched this into the 2.1 branch at sha: 6f0aced

Thanks!

@weaverryan weaverryan closed this Mar 31, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment