jds-rules.html revision 6955
6550N/A<h2>JDS Rules</h2>
6550N/A
6551N/A<style>
6551N/Ali {padding:3px;}
6551N/A</style>
6551N/A
6550N/A<p>
6550N/AThe following rules apply for hacking on the JDS sources -
6550N/A<p>
6550N/A
6550N/A<ul>
6550N/A <li>
6550N/A All patches that are not branding or vendor specific configuration
6550N/A <b>MUST</b> be submitted upstream to the original community of the
6550N/A component.
6550N/A </li>
6550N/A
6550N/A <li>
6550N/A Patches that are rejected by the upstream community are considered
6550N/A <b>broken</b> and should be reworked where possible. Each patch
6550N/A that remains locally increases the maintenance burden for any
6550N/A future work with that component.
6550N/A </li>
6550N/A
6550N/A <li>
6550N/A <b>FIXIT@THESOURCE</b>: Find the root cause of the problem and
6550N/A either fix it yourself, or collaborate to get it fixed. You should
6550N/A not apply a workaround if at all possible. Temporary workarounds are
6550N/A appropriate in some cases, although not something that should be
6550N/A done long term.
6550N/A </li>
6550N/A
6550N/A <li>
6550N/A Patches should be applied within the Linux spec files and <b>MUST</b>
6550N/A work on <b>both</b> Linux and Solaris.
6550N/A </li>
6550N/A
6550N/A <li>
6955N/A Avoid using <b>%ifos</b>
6550N/A </li>
6550N/A
6550N/A <li>
6550N/A If a patch requires images or other binary files, put those in
6550N/A ext-sources. Remember to use the -kb CVS option when adding
6550N/A binaries. Where possible other files should be merged into
6550N/A a patch.
6550N/A </li>
6550N/A
6550N/A <li>
6550N/A Update %changelog in the spec file for <b>ALL</b> non-trivial
6550N/A changes and make sure you have a ChangeLog entry to accompany
6550N/A this. There is a ChangeLog in the top level directory, and a
6550N/A ChangeLog in the Solaris directory. Use them as appropriate.
6550N/A </li>
6550N/A
6550N/A <li>
6550N/A The commit log message should be the same as what is in the
6550N/A ChangeLog entry. When you go to commit, do not use the -m
6550N/A CVS option, instead wait for the prompt, and cut and paste
6550N/A your ChangeLog entry in it.
6550N/A </li>
6550N/A
6550N/A <li>
6550N/A Follow the spec file templates -
6551N/A <blockquote>
6550N/A <dl>
6550N/A <dt>docs/template.spec</dt>
6550N/A <dd>Linux spec file template</dd>
6550N/A
6550N/A <dt>docs/SUNWtemplate.spec</dt>
6550N/A <dd>Solaris spec file template</dd>
6550N/A </dl>
6551N/A </blockquote>
6550N/A </li>
6550N/A
6550N/A <li>
6550N/A Avoid patching patches.
6550N/A </li>
6550N/A</ul>