Module Guidelines
(Difference between revisions)
(→DETAILS) |
|||
| Line 10: | Line 10: | ||
* Always use a SHA1 checksum instead of a MD5 checksum for SOURCE_VFY values. | * Always use a SHA1 checksum instead of a MD5 checksum for SOURCE_VFY values. | ||
| − | **The SHA1 algorithm has been [http://news.com.com/Crypto | + | **The SHA1 algorithm has been [http://news.com.com/Crypto researchers abuzz over flaws/2100-1002_3-5313655.html shown] to be less prone to key clashes than the MD5 algorithm. |
* Don't insert your eMail address into the MAINTAINER field unless you are a Lunar developer. | * 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. | * Prefer '''tar.bz2''' over '''tar.gz''' tarballs (as it saves space/traffic) and prefer '''tar.gz''' over '''zip''' (or '''rar''') packages. | ||
* Avoid using the module's name in the SHORT field. | * Avoid using the module's name in the SHORT field. | ||
** e.g. instead of <code>SHORT="MyModle is an application designed to take over the world."</code> you should use <code>SHORT="an application designed to take over the world"</code> | ** e.g. instead of <code>SHORT="MyModle is an application designed to take over the world."</code> you should use <code>SHORT="an application designed to take over the world"</code> | ||
| − | ** You are encouraged however to start the long description off with the modules name. So in the example above the long description might be "MyModule is a GTK | + | ** You are encouraged however to start the long description off with the modules name. So in the example above the long description might be "MyModule is a GTK -2 application designed to take over the world. It features mind-control and cute, fuzzy kittens." (wrapped to 72 characters characters of course.) This way the output of [[lvu what]] is presented nicely to the user. |
* Always align the equal signs (=) vertially within the file. "=" should be at character position 17, as this allows for the (optional) variable <code>SOURCE_DIRECTORY=</code> to be added later if needed and have it still be lined up with the rest of the content already in the file. | * Always align the equal signs (=) vertially within the file. "=" should be at character position 17, as this allows for the (optional) variable <code>SOURCE_DIRECTORY=</code> to be added later if needed and have it still be lined up with the rest of the content already in the file. | ||
* Make sure to check whether a module is '''PSAFE''' or not. A lot of programs fail to build with parallel makes. | * Make sure to check whether a module is '''PSAFE''' or not. A lot of programs fail to build with parallel makes. | ||
| Line 26: | Line 26: | ||
* If possible, always provide the means to disable support for an optional dependency, even if that optional module is installed. | * If possible, always provide the means to disable support for an optional dependency, even if that optional module is installed. | ||
** That means if the application's ./configure script allows for a --disable-my-optional-depends you should include that switch when building your optional_depends line. This allows you to not compile in support for certain features, even if your computer has the necessary application/library installed to support that feature. Remember, choice is good. | ** That means if the application's ./configure script allows for a --disable-my-optional-depends you should include that switch when building your optional_depends line. This allows you to not compile in support for certain features, even if your computer has the necessary application/library installed to support that feature. Remember, choice is good. | ||
| − | * Always flow up each depends and optional_depends call with a | + | * Always flow up each depends and optional_depends call with a |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Revision as of 10:39, 11 April 2007
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
- Always use a SHA1 checksum instead of a MD5 checksum for SOURCE_VFY values.
- The SHA1 algorithm has been researchers abuzz over flaws/2100-1002_3-5313655.html shown to be less prone to key clashes than the MD5 algorithm.
- 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.
- Avoid using the module's name in the SHORT field.
- e.g. instead of
SHORT="MyModle is an application designed to take over the world."you should useSHORT="an application designed to take over the world" - You are encouraged however to start the long description off with the modules name. So in the example above the long description might be "MyModule is a GTK -2 application designed to take over the world. It features mind-control and cute, fuzzy kittens." (wrapped to 72 characters characters of course.) This way the output of lvu what is presented nicely to the user.
- e.g. instead of
- Always align the equal signs (=) vertially within the file. "=" should be at character position 17, as this allows for the (optional) variable
SOURCE_DIRECTORY=to be added later if needed and have it still be lined up with the rest of the content already in the file. - Make sure to check whether a module is PSAFE or not. A lot of programs fail to build with parallel makes.
DEPENDS
- 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 (non-optionally) "libY," you should only add "libX" as a dependency to your module. This is because "libY" will automatically come along with "libX."
- Never put logic into this file. The only things that can exist in this file are function calls to depends and/or optional_depends.
- Putting logic into DEPENDS, while it might seem clever, is a sure way to mess up Lunar's internal dependency handling mechanisms and commands such as lvu leert.
- If possible, always provide the means to disable support for an optional dependency, even if that optional module is installed.
- That means if the application's ./configure script allows for a --disable-my-optional-depends you should include that switch when building your optional_depends line. This allows you to not compile in support for certain features, even if your computer has the necessary application/library installed to support that feature. Remember, choice is good.
- Always flow up each depends and optional_depends call with a
