Merge pull request #3484 from vlakoff/documentation
[ci skip] Fix Sphinx compilation errors
diff --git a/user_guide_src/source/installation/upgrade_220.rst b/user_guide_src/source/installation/upgrade_220.rst
index beb7bd7..b2e9432 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 <libraries/encrypt>` now requires the
+.. note:: The :doc:`Encrypt Class </libraries/encrypt>` 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 24353b3..3e6db39 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -87,7 +87,7 @@
Step 6: Update your Session library usage
*****************************************
-The :doc:`Session Library </libraries/session>` has been completely
+The :doc:`Session Library </libraries/sessions>` 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 @@
A few configuration options have been removed and a few have been added.
You should really read the whole :doc:`Session library manual
-</libraries/session>` for the details, but here's a short list of changes
+</libraries/sessions>` 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 @@
- ``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
- </libraries/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 @@
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 </libraries/session#accessing-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 366aa13..5b98ea4 100644
--- a/user_guide_src/source/installation/upgrading.rst
+++ b/user_guide_src/source/installation/upgrading.rst
@@ -8,7 +8,8 @@
.. toctree::
:titlesonly:
- Upgrading from 2.1.4 to 3.0.0 <upgrade_300>
+ Upgrading from 2.2.0 to 3.0.0 <upgrade_300>
+ Upgrading from 2.1.4 to 2.2.0 <upgrade_220>
Upgrading from 2.1.3 to 2.1.4 <upgrade_214>
Upgrading from 2.1.2 to 2.1.3 <upgrade_213>
Upgrading from 2.1.1 to 2.1.2 <upgrade_212>
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 18433d1..af8c1a8 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -47,7 +47,7 @@
$this->session
-.. important:: Because the :doc:`Loader Class <../loader>` is instantiated
+.. important:: Because the :doc:`Loader Class </libraries/loader>` 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 @@
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 @@
.. 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"