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 traverse the repository.

You may also want to checkout these files locally onto your PC:

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

Generating the Documentation

In order to generate the Haiku documentation from the source files, you need to execute the following Doxygen command in the /haiku/trunk/docs/user/ directory:

doxygen

Note: if you are running Doxygen from Windows, it will be unable to create the output directory, if it doesn't already exist, and will fail. Create this directory yourself by running the following command from the /haiku/trunk/docs/user/ directory:

md ..\..\generated\doxygen

(You will only need to do this once).

Doxgen generated source code will thus be placed in the haiku/trunk/generated/doxygen directory. The output directory can however be changed by editing the Doxyfile file and changing the OUTPUT_DIRECTORY entry.

Note: if you do change the Doxyfile output directory location, please ensure that it is excluded from any patches you submit, as we don't want to update it in the Haiku repository.