summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJon Pugh2017-04-07 19:38:25 (GMT)
committerJon Pugh2017-04-07 19:38:25 (GMT)
commitfc6ef6bc9008c2c06b5bfcaf62d968c53bab256d (patch)
treef95a25bb022d67086965354d94fa393eb80769f3
parentd3ee3dcd388bcb254477cf88ac542e709fec4122 (diff)
Issue #2851478: Improving comments to explain to developers how to use the symlink_service() method.2851478-move-symlink
-rw-r--r--Provision/Service.php10
1 files changed, 7 insertions, 3 deletions
diff --git a/Provision/Service.php b/Provision/Service.php
index b1ae9c7..ede39ae 100644
--- a/Provision/Service.php
+++ b/Provision/Service.php
@@ -58,9 +58,9 @@ class Provision_Service extends Provision_ChainedState {
/**
* All services have the ability to have an associated restart command and listen port.
*
- * This class also implements a utility function called symlink_service(),
- * which create a symlink like /var/aegir/config/APPLICATION_NAME.conf,
- * you can add it whet you override this function in a sub class.
+ * If services require a fixed path config file, implement the function symlink_service() inside this method.
+ *
+ * @See Provision_Service_http_public::init_server()
*/
function init_server() {
if (!is_null($this->service)) {
@@ -345,6 +345,10 @@ class Provision_Service extends Provision_ChainedState {
/**
* Save symlink for this server from /var/aegir/config/APPLICATION_NAME.conf -> /var/aegir/config/SERVER/APPLICATION_NAME.conf
+ *
+ * If service requires a fixed path config file, implement this function in the init_server() method.
+ *
+ * @See Provision_Service_http_public::init_server()
*/
function symlink_service() {
$file = $this->application_name . '.conf';