Haiku Documentation Team How-To

Article contributed by ajsmale on Tue, 2007-04-24 23:58

This how-to describes getting started with contributing to the Haiku documentation and the software you will need. The documentation team has a mailing list that can be found here:

Your feedback is welcome. Please send comments using this contact form (login required).

Required Software

Subversion

Source code and documentation for the Haiku project is stored in a Subversion repository on the BerliOS server (berlios.de). Subversion is an open source revision control system. You can obtain the Subversion binaries for Windows/Linux from the Subversion official site:

Binaries for BeOS

Doxygen

The documentation in Haiku is produced using the open source Doxygen document generator. You can obtain the Doxygen binaries for Windows/Linux from the Doxygen official site:

Binaries for BeOS

Retrieving Documentation

To retrieve the current Haiku documentation from the Haiku repository and put it into the /haiku/trunk/docs/user/ directory on your current drive:

svn checkout http://svn.haiku-os.org/haiku/haiku/trunk/docs/user/ 
/haiku/trunk/docs/user/

To view the Haiku source code files on the BerliOS server, paste the following URL into the address bar of your favourite web browser:

http://svn.haiku-os.org/haiku/haiku/trunk/src/kits/

This will give you access to the various Haiku kits source code.

http://svn.haiku-os.org/haiku/haiku/trunk/headers/

This will give you access to the various Haiku headers. You can use the links within the browser to travers