← Back to branch summary

~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to configs/README.txt

  • Committer: Curtis Hovey
  • Date: 2008-08-07 21:38:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6819.
  • Revision ID: curtis.hovey@canonical.com-20080807213827-bs3cntxpba7fwdk3
README revisions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
configs/README.txt
175
175
    lib/canonical/lazr/doc/config.txt
176
176
 
177
177
 
178
 
=== schema template and optional sections===
 
178
=== schema template and optional sections ===
179
179
 
180
180
The schema can contain [<category>.template] sections that define a
181
 
common set of keys and value for category of sections. For example:
 
181
common set of keys and default value for category of sections.
 
182
For example:
182
183
 
183
184
    [vhost.template]
184
185
    # Host name of this virtual host.
202
203
    rooturl: none
203
204
 
204
205
The [vhost.template] defines the keys and default values of a vhost.
205
 
[vhost.answers] is an empty section in the schema, yet it has all the
206
 
keys and values defined in the [vhosts.template].
 
206
"vhost" is a category, any section whose name is prefixed "vhost" will
 
207
inherit the keys and default values of the [vhost.template].
 
208
 
 
209
[vhost.answers] is an empty section in the schema...
 
210
 
 
211
    [vhost.answers]
 
212
 
 
213
...and lpnet-lazr.conf defines this:
 
214
 
 
215
    [vhost.answers]
 
216
    hostname: answers.launchpad.net
 
217
 
 
218
./lpnet1/launchpad-lazr.conf does not define anything for
 
219
[vhost.answers], yet when it is loaded, it has the all the keys and
 
220
default values of [vhost.template] from the schema, with the hostname
 
221
change defined in lpnet-lazr.conf:
 
222
 
 
223
    [vhost.answers]
 
224
    althostnames: None
 
225
    hostname: answers.launchpad.net
 
226
    rooturl: None
207
227
 
208
228
The schema may contain [<section>.optional] to define a section
209
229
that may declared in a conf, but is not automatically
216
236
is defined in the schema. It has the default keys and values defined
217
237
in [vhost.template]. The [vhost.xmlrpc_private] is not visible in
218
238
most confs because they do not declare that they use the section.
219
 
The lpnet.conf file does though, by including [vhost.xmlrpc] section:
 
239
The production-xmlrpc-private/launchpad-lazr.conf file does though,
 
240
by including [vhost.xmlrpc_private] section:
220
241
 
221
 
    [vhost.xmlrpc]
222
 
    hostname: xmlrpc.launchpad.net
 
242
    [vhost.xmlrpc_private]
 
243
    hostname: xmlrpc.lp.internal
223
244
    rooturl: https://launchpad.net/
224
245
 
225
 
Including just the section ([vhost.xmlrpc]) will suffice. In this case,
226
 
the two keys were redefined.
 
246
Including just the section ([vhost.xmlrpc_private]) will suffice. In
 
247
this case, the two keys were redefined.
227
248
 
228
249
 
229
250
=== Implicit typing ===
232
253
need to coerce the config values:
233
254
 
234
255
    Integers: any value that is only made up of numbers, optionally
235
 
        prefixed with +/- is cast as an int: 0, 2001, -55, +404 100.
 
256
        prefixed with +/- is cast as an int: 0, 2001, -55, +404, 100.
236
257
 
237
258
    True, False, or None: any value that matches the boolean and None
238
259
        keywords is treated as the prescribed type. The match is
239
 
        case-insensative: none, nOne, true, and False are all matched.
 
260
        case-insensitive: none, nOne, true, and False are all matched.
240
261
 
241
262
    Strings: any value that is not an int, bool, or None is treated as
242
263
        a str. Multi-line strings can be included by indenting the