diff options
Diffstat (limited to 'doc/unsorted/development_tips.txt')
| -rw-r--r-- | doc/unsorted/development_tips.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/unsorted/development_tips.txt b/doc/unsorted/development_tips.txt new file mode 100644 index 000000000..29924e645 --- /dev/null +++ b/doc/unsorted/development_tips.txt @@ -0,0 +1,20 @@ +.. -*- mode: rst -*- + +.. _unsorted-development_tips: + +========================== +Tips for Bcfg2 Development +========================== + +#. Focus on either the client or server code. This focuses the development process down the the precise pieces of code that matter for the task at hand. + + * If you are developing a client driver, then write up a small configuration specification that includes the needed characteristics. + * If you are working on the server, run bcfg2-info and use to assess the code + +#. Use the python interpreter. One of python's most appealing features is interactive use of the interpreter. + + * If you are developing for the client-side, run "python -i /usr/sbin/bcfg2" with the appropriate bcfg2 options. This will cause the python interpreter to continue running, leaving all variables intact. This can be used to examine data state in a convenient fashion. + * If you are developing for the server side, use bcfg2-info and the "debug" option. This will leave you at a python interpreter prompt, with the server core loaded in the variable "bcore". + +#. Use pylint obsessively. It raises a lot of style-related warnings which can be ignored, but most all of the errors are legitimate. +#. If you are doing anything with Regular Expressions, [http://kodos.sourceforge.net/ Kodos - The Python Regular Expression Debugger] and [http://re-try.appspot.com/ re-try] are your friends. |