[[TOC]]

= Guidelines =

This page discusses some guidelines about using the !BePorts' Trac site.

== Merging ==

A port should eventually be merged with the original software's main source tree. Many open source projects use the GNU [http://en.wikipedia.org/wiki/GNU_build_system Autotools] in order to be portable on a source level. While the concept is great, [http://www.gnu.org/software/autoconf/ Autoconf] and [http://www.gnu.org/software/automake/ Automake] are quite daunting. It is however worthwhile to learn at least a minimum about the GNU Autotools. The PortingTips contain links to more information about Autoconf and Automake.

== The PortLog ==

When porting an application or library, it is strongly advised you keep a log of:

 * what options are necessary for building on BeOS; and 
 * what problems you run into, and the solutions to them.

This information can be very helpful to others, after all.

When you get stuck and give up (hey, don't feel bad), create a new ticket explaining the problem. Also link to this ticket from within the port's PortLog. Consult TracLinks on how to do that. The tickets should be assigned to the component that corresponds to the port's category. The ticket summary should start with {{{[portname]}}} to indicate the port.

== Platforms ==

Because of the incompatibilities between the various BeOS platforms, a port should be tested on all of them. '''BONE''' binaries however, should be able to run on Dano and Zeta, from what I hear. Correct me (Brecht) if I'm wrong. So that's one target for the three of those. '''R5''' (5.0.3) and '''Haiku''' are very different from BONE and are therefor two other targets.

The status of a port is described by the following keywords:

 * ''untested'': not tested on this platform
 * ''broken'': doesn't build
 * ''unstable'': builds, but fails tests or has obvious flaws
 * ''stable'': passes tests and seems to be working as it should

== Layout ==

It would be nice if the layout of the portlogs would be consistent. Unfortunately, (currently) there is no way of enforcing this. Please use the following template:

{{{
[[TOC]]

= PortLog: [wiki:category]/port =

http://www.url-to-package-lib-page.org

== version 1.0 ==

||R5||status||
||BONE||status||
||Haiku||status||

dependencies:

 * [wiki:category/port-] >= version
 * [wiki:category/port-] >= version

=== revision 1 (your username) - [tested platforms] ===

your comments
}}}

For an example, see [wiki:sys-devel/m4].

Don't remove old versions or revisions from the portlog, the information can still be valuable.