summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjvoisin2017-09-28 15:30:46 +0200
committerjvoisin2017-09-28 15:30:46 +0200
commit94a6d0c65fd5bea909f08d493d80d8771ef49a60 (patch)
treecb44bb6d344dfe6afb92ac2d873cb62ba94a0115
parenta92612da7ed1ceecc907232c36ff99e7dd18630c (diff)
Improve the documentation wrt. installation
Thanks to @real for finding this.
-rw-r--r--doc/source/config.rst4
-rw-r--r--doc/source/installation.rst11
2 files changed, 11 insertions, 4 deletions
diff --git a/doc/source/config.rst b/doc/source/config.rst
index 760ae1b..84fc193 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -2,7 +2,9 @@ Configuration
2============= 2=============
3 3
4Since PHP *ini-like* configuration model isn't flexible enough, 4Since PHP *ini-like* configuration model isn't flexible enough,
5Snuffleupagus is using its own format. 5Snuffleupagus is using its own format, in the file specified by
6the directive ``sp.configuration_file`` (in your ``php.ini`` file),
7like ``sp.configuration_file=/etc/php/conf.d/snuffleupagus.ini``.
6 8
7Options are chainable by using dots (``.``), and string parameters 9Options are chainable by using dots (``.``), and string parameters
8**must** be quoted, while booleans and integers aren't. 10**must** be quoted, while booleans and integers aren't.
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 779008d..383d0f0 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -17,15 +17,20 @@ Quickstart
17:: 17::
18 18
19 git clone https://github.com/nbs-system/snuffleupagus 19 git clone https://github.com/nbs-system/snuffleupagus
20 cd snuffleupagus 20 cd snuffleupagus/src
21 phpize 21 phpize
22 ./configure 22 ./configure --with-snuffleupagus
23 make 23 make
24 make install 24 make install
25 25
26This should install ``snuffleupagus.so`` file in your extension directory. The final step is adding a load directive to ``php.ini``:: 26This should install ``snuffleupagus.so`` file in your extension directory.
27The final step is adding a load directive to ``php.ini``,
28and to specify the location of its :doc:`configuration file <config>`:
29
30::
27 31
28 extension=snuffleupagus.so 32 extension=snuffleupagus.so
33 sp.configuration_file=/etc/php/conf.d/snuffleupagus.ini
29 34
30Upgrading 35Upgrading
31--------- 36---------