Module Guidelines

(Difference between revisions)
Jump to: navigation, search
m (Generic: tweaks)
m (Generic)
Line 2: Line 2:
  
 
== Generic ==
 
== Generic ==
 
+
These guidelines apply to all of a module's files.
 
* Never use tabs. '''Use spaces''' instead.
 
* 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!).
 
* Use '''72 columns''' as a maximum width whenever possible (but always in the long description in the [[DETAILS]] file!).

Revision as of 17:35, 28 August 2006

Contents


Generic

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.

DETAILS

  • 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.

DEPENDS

  • If dependency B implies dependency A, only add depends B (or optional_depends B ..., depending on the dependency type).

CONFLICTS

  • Remember to add a CONFLICTS to both modules that conflict with each other.

CONFIGURE

PRE_BUILD

BUILD

  • Don't install files after calling devoke_installwatch.

POST_BUILD

  • Don't install any files into the system.

POST_INSTALL

  • Don't install any files into the system.

PRE_REMOVE

POST_REMOVE

Personal tools
Namespaces
Variants
Actions
Wiki Navigation
Project Sites
Toolbox