Module Guidelines

(Difference between revisions)

Jump to: navigation, search

Revision as of 20:49, 28 August 2006

These guidelines apply to all of a module's files.

Never use tabs. Use spaces instead.
Use 72 columns as a maximum width whenever possible (but always in the long description in the DETAILS file!).
Respect the MAINTAINER value. Don't modify maintained modules unless you first consult the listed maintainer.

Use sha1: instead of md5: for SOURCE_VFY values.
Don't insert your eMail address into the MAINTAINER field unless you are a Lunar developer.
Prefer tar.bz2 over tar.gz tarballs (as it saves space/traffic) and prefer tar.gz over zip (or rar) packages.

Only list unique dependencies.
- That means that if the module you are building requires both "libX" and "libY" to properly compile/run but "libX" itself already requires "libY," you should only add "libX" as a dependency to your module. This is because "libY" will automatically come along with "libX."

@@ Line 14: / Line 14: @@
 == DEPENDS ==
+* Only list unique dependencies.
-* If dependency ''B'' implies dependency ''A'', only add '''depends B''' (or '''optional_depends B ...''', depending on the dependency type).
+**That means that if the module you are building requires both "libX" and "libY" to properly compile/run but "libX" itself already requires "libY," you should only add "libX" as a dependency to your module.  This is because "libY" will automatically come along with "libX."
 == CONFLICTS ==