Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / packaging / sources / reclass / refs/heads/gh-pages / . / hacking.html
blob: f21bab455ce03825de3f6c337ef21ee7a73d57f2 [file] [log] [blame]
martin f. krafft3cd2a332014-10-28 15:58:23 +0100[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
9 <title>Hacking on reclass &mdash; reclass 1.4.1 documentation</title>
10
11 <link rel="stylesheet" href="_static/default.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: './',
17 VERSION: '1.4.1',
18 COLLAPSE_INDEX: false,
19 FILE_SUFFIX: '.html',
20 HAS_SOURCE: true
21 };
22 </script>
23 <script type="text/javascript" src="_static/jquery.js"></script>
24 <script type="text/javascript" src="_static/underscore.js"></script>
25 <script type="text/javascript" src="_static/doctools.js"></script>
26 <link rel="top" title="reclass 1.4.1 documentation" href="index.html" />
27 <link rel="next" title="reclass to-do list" href="todo.html" />
28 <link rel="prev" title="Using reclass with Puppet" href="puppet.html" />
29 </head>
30 <body>
31 <div class="related">
32 <h3>Navigation</h3>
33 <ul>
34 <li class="right" style="margin-right: 10px">
35 <a href="genindex.html" title="General Index"
36 accesskey="I">index</a></li>
37 <li class="right" >
38 <a href="todo.html" title="reclass to-do list"
39 accesskey="N">next</a> |</li>
40 <li class="right" >
41 <a href="puppet.html" title="Using reclass with Puppet"
42 accesskey="P">previous</a> |</li>
43 <li><a href="index.html">reclass</a> &raquo;</li>
44 </ul>
45 </div>
46
47 <div class="document">
48 <div class="documentwrapper">
49 <div class="bodywrapper">
50 <div class="body">
51
52 <div class="section" id="hacking-on-reclass">
53<h1>Hacking on reclass<a class="headerlink" href="#hacking-on-reclass" title="Permalink to this headline"></a></h1>
54<div class="section" id="installation">
55<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
56<p>If you just want to run <strong>reclass</strong> from source, e.g. because you are going to be
57making and testing changes, install it in &#8220;development mode&#8221;:</p>
58<div class="highlight-python"><div class="highlight"><pre>python setup.py develop
59</pre></div>
60</div>
61<p>Now the <tt class="docutils literal"><span class="pre">reclass</span></tt> script, as well as the adapters, will be available in
62<tt class="docutils literal"><span class="pre">/usr/local/bin</span></tt>, and you can also invoke them directly from the source
63tree.</p>
64<p>To uninstall:</p>
65<div class="highlight-python"><div class="highlight"><pre>python setup.py develop --uninstall
66</pre></div>
67</div>
68</div>
69<div class="section" id="discussing-reclass">
70<h2>Discussing reclass<a class="headerlink" href="#discussing-reclass" title="Permalink to this headline"></a></h2>
71<p>If you want to talk about <strong>reclass</strong>, use the <a class="reference external" href="http://lists.pantsfullofunix.net/listinfo/reclass">mailing list</a> or to find me on
72IRC, in <tt class="docutils literal"><span class="pre">#reclass</span></tt> on <tt class="docutils literal"><span class="pre">irc.oftc.net</span></tt>.</p>
73</div>
74<div class="section" id="contributing-to-reclass">
75<h2>Contributing to reclass<a class="headerlink" href="#contributing-to-reclass" title="Permalink to this headline"></a></h2>
76<p><strong>reclass</strong> is currently maintained <a class="reference external" href="http://github.com/madduck/reclass">on Github</a>.</p>
77<p>Conttributions to <strong>reclass</strong> are very welcome. Since I prefer to keep a somewhat
78clean history, I will not just merge pull request.</p>
79<p>You can submit pull requests, of course, and I&#8217;ll rebase them onto <tt class="docutils literal"><span class="pre">HEAD</span></tt>
80before merging. Or send your patches using <tt class="docutils literal"><span class="pre">git-format-patch</span></tt> and
81<tt class="docutils literal"><span class="pre">git-send-e-mail</span></tt> to <a class="reference external" href="mailto:reclass&#37;&#52;&#48;lists&#46;pantsfullofunix&#46;net">the mailing list</a>.</p>
82<p>I have added rudimentary unit tests, and it would be nice if you could submit
83your changes with appropriate changes to the tests. To run tests, invoke</p>
84<div class="highlight-python"><div class="highlight"><pre>$ make tests
85</pre></div>
86</div>
87<p>in the top-level checkout directory. The tests are rather inconsistent, some
88using mock objects, and only the datatypes-related code is covered. If you are
89a testing expert, I could certainly use some help here to improve the
90consistency of the existing tests, as well as their coverage.</p>
91<p>Also, there is a Makefile giving access to PyLint and <tt class="docutils literal"><span class="pre">coverage.py</span></tt> (running
92tests). If you run that, you can see there is a lot of work to be done
93cleaning up the code. If this is the sort of stuff you want to do — by all
94means — be my guest! ;)</p>
95<p>There are a number of items on the <a class="reference internal" href="todo.html"><em>to-do list</em></a>, so if you are
96bored…</p>
97<p>If you have larger ideas, I&#8217;ll be looking forward to discuss them with you.</p>
98</div>
99</div>
100
101
102 </div>
103 </div>
104 </div>
105 <div class="sphinxsidebar">
106 <div class="sphinxsidebarwrapper">
107 <h3><a href="index.html">Table Of Contents</a></h3>
108 <ul>
109<li><a class="reference internal" href="#">Hacking on reclass</a><ul>
110<li><a class="reference internal" href="#installation">Installation</a></li>
111<li><a class="reference internal" href="#discussing-reclass">Discussing reclass</a></li>
112<li><a class="reference internal" href="#contributing-to-reclass">Contributing to reclass</a></li>
113</ul>
114</li>
115</ul>
116
117 <h4>Previous topic</h4>
118 <p class="topless"><a href="puppet.html"
119 title="previous chapter">Using reclass with Puppet</a></p>
120 <h4>Next topic</h4>
121 <p class="topless"><a href="todo.html"
122 title="next chapter">reclass to-do list</a></p>
123<div id="searchbox" style="display: none">
124 <h3>Quick search</h3>
125 <form class="search" action="search.html" method="get">
126 <input type="text" name="q" />
127 <input type="submit" value="Go" />
128 <input type="hidden" name="check_keywords" value="yes" />
129 <input type="hidden" name="area" value="default" />
130 </form>
131 <p class="searchtip" style="font-size: 90%">
132 Enter search terms or a module, class or function name.
133 </p>
134</div>
135<script type="text/javascript">$('#searchbox').show(0);</script>
136 </div>
137 </div>
138 <div class="clearer"></div>
139 </div>
140 <div class="related">
141 <h3>Navigation</h3>
142 <ul>
143 <li class="right" style="margin-right: 10px">
144 <a href="genindex.html" title="General Index"
145 >index</a></li>
146 <li class="right" >
147 <a href="todo.html" title="reclass to-do list"
148 >next</a> |</li>
149 <li class="right" >
150 <a href="puppet.html" title="Using reclass with Puppet"
151 >previous</a> |</li>
152 <li><a href="index.html">reclass</a> &raquo;</li>
153 </ul>
154 </div>
155 <div class="footer">
156 &copy; Copyright 2013, martin f. krafft.
157 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
158 </div>
159 </body>
160</html>