From 94a6d0c65fd5bea909f08d493d80d8771ef49a60 Mon Sep 17 00:00:00 2001 From: jvoisin Date: Thu, 28 Sep 2017 15:30:46 +0200 Subject: Improve the documentation wrt. installation Thanks to @real for finding this. --- doc/source/config.rst | 4 +++- doc/source/installation.rst | 11 ++++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) (limited to 'doc/source') 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 ============= Since PHP *ini-like* configuration model isn't flexible enough, -Snuffleupagus is using its own format. +Snuffleupagus is using its own format, in the file specified by +the directive ``sp.configuration_file`` (in your ``php.ini`` file), +like ``sp.configuration_file=/etc/php/conf.d/snuffleupagus.ini``. Options are chainable by using dots (``.``), and string parameters **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 :: git clone https://github.com/nbs-system/snuffleupagus - cd snuffleupagus + cd snuffleupagus/src phpize - ./configure + ./configure --with-snuffleupagus make make install -This should install ``snuffleupagus.so`` file in your extension directory. The final step is adding a load directive to ``php.ini``:: +This should install ``snuffleupagus.so`` file in your extension directory. +The final step is adding a load directive to ``php.ini``, +and to specify the location of its :doc:`configuration file `: + +:: extension=snuffleupagus.so + sp.configuration_file=/etc/php/conf.d/snuffleupagus.ini Upgrading --------- -- cgit v1.3