mahara-contributors team mailing list archive

[Mahara Bot <1185297@xxxxxxxxxxxxxxxxxx>]

Reviewed:  https://reviews.mahara.org/2473
Committed: http://gitorious.org/mahara/mahara/commit/042715c1b2c1d8e47533ca8aaa8c4eab7658d774
Submitter: Aaron Wells (aaronw@xxxxxxxxxxxxxxx)
Branch:    master

commit 042715c1b2c1d8e47533ca8aaa8c4eab7658d774
Author: Aaron Wells <aaronw@xxxxxxxxxxxxxxx>
Date:   Wed Sep 4 13:59:10 2013 +1200

Clean up config-defaults.php and config-dist.php

Bug1185297 In order to set apart the sample code from the commentary, I'm putting all the commentary
into phpdocs style /** ... */ blocks, which trendy IDE's will highlight in a different color

Also putting a line in the top of config-dist.php to tell users about the existence of
config-defaults.php

Change-Id: I3e587cf441ed14808a24d148e969df5d08041254

-- 
You received this bug notification because you are a member of Mahara
Contributors, which is subscribed to Mahara.
Matching subscriptions: Subscription for all Mahara Contributors -- please ask on #mahara-dev or mahara.org forum before editing or unsubscribing it!
https://bugs.launchpad.net/bugs/1185297

Title:
  Document more $cfg options

Status in Mahara ePortfolio:
  Triaged

Bug description:
  I think it would be a great idea if we went through the code, found as
  many of the config options as we can (by searching for $CFG and
  get_config()), and made sure they were properly documented in one of
  three ways:

  1. If it's a setting that should be hard-coded and most users will
  want/need to set it, put it in config-dist.php

  2. If it's a setting that should be hard-coded but is experimental,
  advanced, or less likely to be used, put it in lib/config-defaults.php

  3. Or give it a UI front-end setting on the Admin pages. But keep in
  mind possible security implications -- anything settable by the UI can
  be abused by XSS, so for instance filesystem paths should not be set
  in the UI because that makes a handy escalation from XSS to
  filesystem.

To manage notifications about this bug go to:
https://bugs.launchpad.net/mahara/+bug/1185297/+subscriptions