From a2dee7dab707a25e4a2a1cec1c2bfcf615d2272d Mon Sep 17 00:00:00 2001 From: vlakoff Date: Tue, 20 Jan 2015 04:22:29 +0100 Subject: Fix Sphinx compilation errors --- user_guide_src/source/installation/upgrade_220.rst | 2 +- user_guide_src/source/installation/upgrade_300.rst | 10 +++++----- user_guide_src/source/installation/upgrading.rst | 3 ++- user_guide_src/source/libraries/sessions.rst | 6 +++--- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/user_guide_src/source/installation/upgrade_220.rst b/user_guide_src/source/installation/upgrade_220.rst index beb7bd7d7..b2e943223 100644 --- a/user_guide_src/source/installation/upgrade_220.rst +++ b/user_guide_src/source/installation/upgrade_220.rst @@ -2,7 +2,7 @@ Upgrading from 2.1.4 to 2.2.0 ############################# -.. note:: The :doc:`Encrypt Class ` now requires the +.. note:: The :doc:`Encrypt Class ` now requires the Mcrypt extension. If you were previously using the Encrypt Class without Mcrypt, then this is a breaking change. You must install the Mcrypt extension in order to upgrade. For information on diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 24353b35f..3e6db390e 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -87,7 +87,7 @@ or extensions to work, you need to move them to **application/core/**:: Step 6: Update your Session library usage ***************************************** -The :doc:`Session Library ` has been completely +The :doc:`Session Library ` has been completely re-written in CodeIgniter 3 and now comes with a bunch of new features, but that also means that there are changes that you should make ... @@ -104,7 +104,7 @@ possibility to use it as "userdata", like you've done until now). A few configuration options have been removed and a few have been added. You should really read the whole :doc:`Session library manual -` for the details, but here's a short list of changes +` for the details, but here's a short list of changes that you should make: - Set your ``$config['sess_driver']`` value @@ -128,8 +128,8 @@ that you should make: - ``last_activity`` field is renamed to ``timestamp`` This is accompanied by a slight change in the table indexes too, so - please read the manual about the :doc:`Session Database Driver - ` for more information. + please read the manual about the `Session Database Driver + <../libraries/sessions.html#database-driver>`_ for more information. .. important:: Only MySQL and PostgreSQL are officially supported now. Other databases may still work, but due to lack of advisory @@ -164,7 +164,7 @@ that you should make: Previously, you could access the 'session_id', 'ip_address', 'user_agent' and 'last_activity' metadata items as userdata. This is no longer possible, and you should read the notes about - :doc:`Session Metadata ` + `Session Metadata <../libraries/sessions.html#accessing-session-metadata>`_ if your application relies on those values. Finally, if you have written a Session extension, you must now move it to diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst index 366aa13f7..5b98ea46d 100644 --- a/user_guide_src/source/installation/upgrading.rst +++ b/user_guide_src/source/installation/upgrading.rst @@ -8,7 +8,8 @@ upgrading from. .. toctree:: :titlesonly: - Upgrading from 2.1.4 to 3.0.0 + Upgrading from 2.2.0 to 3.0.0 + Upgrading from 2.1.4 to 2.2.0 Upgrading from 2.1.3 to 2.1.4 Upgrading from 2.1.2 to 2.1.3 Upgrading from 2.1.1 to 2.1.2 diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst index 18433d1ac..af8c1a8d2 100644 --- a/user_guide_src/source/libraries/sessions.rst +++ b/user_guide_src/source/libraries/sessions.rst @@ -47,7 +47,7 @@ Once loaded, the Sessions library object will be available using:: $this->session -.. important:: Because the :doc:`Loader Class <../loader>` is instantiated +.. important:: Because the :doc:`Loader Class ` is instantiated by CodeIgniter's base controller, make sure to call ``parent::__construct()`` before trying to load a library from inside a controller constructor. @@ -400,7 +400,7 @@ You'll find the following Session related preferences in your Preference Default Options Description ======================== =============== ======================================== ============================================================================================ **sess_driver** files files/database/redis/memcached/*custom* The session storage driver to use. -**sess_cookie_name** ci_session [A-Za-z_-] characters only The name used for the session cookie. +**sess_cookie_name** ci_session [A-Za-z\_-] characters only The name used for the session cookie. **sess_expiration** 7200 (2 hours) Time in seconds (integer) The number of seconds you would like the session to last. If you would like a non-expiring session (until browser is closed) set the value to zero: 0 **sess_save_path** NULL None Specifies the storage location, depends on the driver being used. @@ -878,7 +878,7 @@ Class Reference .. method:: keep_flashdata($key) :param mixed $key: Flashdata key to keep, or an array of multiple keys - :returns TRUE on success, FALSE on failure + :returns: TRUE on success, FALSE on failure :rtype: bool Retains the specified session data key(s) as "flashdata" -- cgit v1.2.3-24-g4f1b