<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><htmlxmlns="http://www.w3.org/1999/xhtml"><head><metahttp-equiv="Content-Type"content="text/html; charset=UTF-8"/><title>cdist-hacker(7)</title><linkrel="stylesheet"type="text/css"href="docbook-xsl.css"/><metaname="generator"content="DocBook XSL Stylesheets V1.78.1"/></head><body><divxml:lang="en"class="article"lang="en"><divclass="titlepage"><div><div><h2class="title"><aid="idm139928837461168"></a>cdist-hacker(7)</h2></div><div><divclass="author"><h3class="author"><spanclass="firstname">Nico</span><spanclass="surname">Schottelius</span></h3><codeclass="email"><<aclass="email"href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr/></div><divclass="toc"><p><strong>Table of Contents</strong></p><dlclass="toc"><dt><spanclass="section"><ahref="#_name">1. NAME</a></span></dt><dt><spanclass="section"><ahref="#_welcome">2. WELCOME</a></span></dt><dt><spanclass="section"><ahref="#_reporting_bugs">3. REPORTING BUGS</a></span></dt><dt><spanclass="section"><ahref="#_coding_conventions_everywhere">4. CODING CONVENTIONS (EVERYWHERE)</a></span></dt><dt><spanclass="section"><ahref="#_how_to_submit_stuff_for_inclusion_into_upstream_cdist">5. HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST</a></span></dt><dt><spanclass="section"><ahref="#_how_to_submit_a_new_type">6. HOW TO SUBMIT A NEW TYPE</a></span></dt><dt><spanclass="section"><ahref="#_see_also">7. SEE ALSO</a></span></dt><dt><spanclass="section"><ahref="#_copying">8. COPYING</a></span></dt></dl></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_name"></a>1.NAME</h2></div></div></div><p>cdist-hacker - How to get (stuff) into cdist</p></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_welcome"></a>2.WELCOME</h2></div></div></div><p>Welcome dear hacker! I invite you to a tour of pointers to
get into the usable configuration mangament system, cdist.</p><p>The first thing to know is probably that cdist is brought to
you by people who care about how code looks like and who think
twice before merging or implementing a feature: Less features
with good usability are far better than the opposite.</p></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_reporting_bugs"></a>3.REPORTING BUGS</h2></div></div></div><p>If you believe you’ve found a bug and verified that it is
in the latest version, drop a mail to the cdist mailing list,
subject prefixed with "[BUG] " or create an issue on github.</p></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_coding_conventions_everywhere"></a>4.CODING CONVENTIONS (EVERYWHERE)</h2></div></div></div><p>If something should be better done or needs to fixed, add the word FIXME
nearby, so grepping for FIXME gives all positions that need to be fixed.</p><p>Indention is 4 spaces (welcome to the python world).</p></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_how_to_submit_stuff_for_inclusion_into_upstream_cdist"></a>5.HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST</h2></div></div></div><p>If you did some cool changes to cdist, which you value as a benefit for
everybody using cdist, you’re welcome to propose inclusion into upstream.</p><p>There are though some requirements to ensure your changes don’t break others
work nor kill the authors brain:</p><divclass="itemizedlist"><ulclass="itemizedlist"style="list-style-type: disc; "><liclass="listitem">
All files should contain the usual header (Author, Copying, etc.)
</li><liclass="listitem">
Code submission must be done via git
</li><liclass="listitem">
Do not add cdist/conf/manifest/init - This file should only be touched in your
private branch!
</li><liclass="listitem">
Code to be included should be branched of the upstream "master" branch
</li><liclass="listitem">
Exception: Bugfixes to a version branch
</li><liclass="listitem">
On a merge request, always name the branch I should pull from
</li><liclass="listitem">
Always ensure <spanclass="strong"><strong>all</strong></span> manpages build. Use <spanclass="strong"><strong>./build man</strong></span> to test.
</li><liclass="listitem">
If you developed more than <spanclass="strong"><strong>one</strong></span> feature, consider submitting them in
separate branches. This way one feature can already be included, even if
the other needs to be improved.
</li></ul></div><p>As soon as your work meets these requirements, write a mail
for inclusion to the mailinglist <spanclass="strong"><strong>cdist at cdist—at—l.schottelius.org</strong></span>
or open a pull request at <aclass="ulink"href="http://github.com/telmich/cdist"target="_top">http://github.com/telmich/cdist</a>.</p></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_how_to_submit_a_new_type"></a>6.HOW TO SUBMIT A NEW TYPE</h2></div></div></div><p>For detailled information about types, see cdist-type(7).</p><p>Submitting a type works as described above, with the additional requirement
that a corresponding manpage named man.text in asciidoc format with
the manpage-name "cdist-type__NAME" is included in the type directory
AND asciidoc is able to compile it (i.e. do NOT have to many "=" in the second
line).</p><p>Warning: Submitting "exec" or "run" types that simply echo their parameter in
gencode* will not be accepted, because they are of no use. Every type can output
code and thus such a type introduces redundant functionality that is given by
</li></ul></div></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_copying"></a>8.COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
