← Back to branch summary

~rvb/maas/bug-1384001-redux-2

« back to all changes in this revision

Viewing changes to HACKING.txt

  • Committer: Gavin Panella
  • Date: 2012-03-15 13:58:32 UTC
  • mto: This revision was merged to the branch mainline in revision 291.
  • Revision ID: gavin.panella@canonical.com-20120315135832-8i2rkbvp6gwdhkzt
Change MaaS to MAAS everywhere.

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING.txt
1
1
************
2
 
Hacking MaaS
 
2
Hacking MAAS
3
3
************
4
4
 
5
5
 
6
6
Coding style
7
7
============
8
8
 
9
 
MaaS follows the `Launchpad Python Style Guide`_, except where it gets
10
 
Launchpad specific, and where it talks about `method naming`_. MaaS
 
9
MAAS follows the `Launchpad Python Style Guide`_, except where it gets
 
10
Launchpad specific, and where it talks about `method naming`_. MAAS
11
11
instead adopts `PEP-8`_ naming in all cases, so method names should
12
12
usually use the ``lowercase_with_underscores`` form.
13
13
 
60
60
First time using buildout?
61
61
==========================
62
62
 
63
 
Buildout is used to develop MaaS. Buildout, if configured so, can
 
63
Buildout is used to develop MAAS. Buildout, if configured so, can
64
64
cache downloaded files and built eggs. If you've not already done
65
65
something similar, the following snippet will massively improve build
66
66
times::
120
120
tests will modify your Cobbler database.
121
121
 
122
122
 
123
 
Development MaaS server setup
 
123
Development MAAS server setup
124
124
=============================
125
125
 
126
126
Access to the database is configured in ``src/maas/development.py``.
177
177
Adding new dependencies
178
178
=======================
179
179
 
180
 
Since MaaS is distributed mainly as Ubuntu package, all runtime dependencies
 
180
Since MAAS is distributed mainly as Ubuntu package, all runtime dependencies
181
181
should be packaged and we should develop with the packaged version if
182
182
possible. You'll need to add the dependency to the
183
183
``allowed-eggs-from-site-packages`` option in the ``buildout.cfg`` file. You
213
213
Acceptance tests
214
214
================
215
215
 
216
 
MaaS uses checkbox manual testing infrastructure to verify features
 
216
MAAS uses checkbox manual testing infrastructure to verify features
217
217
are implemented according to the spec. They can be found in
218
218
the qa/checkbox/ directory.
219
219
 
226
226
    $ checkbox-gtk --config='checkbox/plugins/jobs_info/directories=\
227
227
    /path/to/local/checkbox/jobs/dir' --whitelist-file=
228
228
 
229
 
or run from the root of the MaaS tree::
 
229
or run from the root of the MAAS tree::
230
230
 
231
231
    $ make checkbox