perl-begin / src / conventions.html.wml

#include '../template.wml'

<latemp_subject "Coding Conventions" />

<ul>
<li>
The packages that can be used to compile and install kernel modules and
entire packages can assume that a GNU system is present. Namely that 
GNU make, GNU install, gawk, gcc, etc. are present and at the appropriate
places. It cannot assume that Perl is installed though.
</li>
<li>
The CLAN code and the Module packager will be written in pure Perl 5, and
can depend on whatever publicly available CPAN modules that are known to 
be portable and common enough. Eventually, a CPAN bundle will be prepared
to install everything including CLAN.
</li>
<li>
Generally, maintaining a simple CLAN module will be possible without too deep a
knowledge of Perl, but such knowledge may prove useful for advanced use.
</li>
<li>
I'll try to avoid using Autoconf and friends for the modules for as long as 
I can. If we assume a GNU system, we can make a lot of simplifying assumptions.
</li>
<li>
Packages can be prepared along with a list of patches. They can be defined
inside the package or the package can be built while specifying them.
</li>
<li>
A kernel module package will contain an RPM Spec, Debianization file and other
native distribution packaging systems.
</li>
<li>
There should be planning but no over-engineering. I believe we can build
the functionality incrementally without re-writing the entire code from scratch
at a certain point. 
</li>
</ul>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.