Table of Contents

Getting your Patches into Mantis

You have identified a bug in a Mantis, and you have developed a solution to correct the defect. So, how do you submit that solution, for inclusion in Mantis?

By following the guidelines set out below, you will give your solution its best chance of being adopted, in a timely fashion.

Base your work on the most current source code

Please be sure to base your patch upon the most recent code in our CVS. This ensures you will be able to properly test your modifications and provide a cleanly applicable patch.

To get the most current Mantis sources use:

  cvs login
  cvs -z3 co -P mantisbt
  cvs update -dP

Please refer to the Mantis page on sourceforge for more detailed instructions on how to access CVS.

Modify and test sources

Now you are all set-up to make you modifications to sources. Please be sure to:

	$g_show_detailed_errors	= ON;
	$g_display_errors = array(
		E_WARNING => 'halt',
		E_NOTICE => 'halt',
		E_USER_ERROR => 'halt',
		E_USER_WARNING => 'halt',
		E_USER_NOTICE => 'halt'

Generate patch file

Once the modifications are done, you are ready to generate a patch file. This is usually as simple as:

  cvs diff -u > mypatch.patch

from the mantisbt directory (requires an active internet connection)

If your modifications also includes added files, please add the -N option like:

  cvs diff -uN > mypatch.patch

For non trivial patches, it is recommended to create a zip file which includes the patch created above + all modified and created files. Some users also include a readme file if necessary.

Attach to bug report

Now that the patch is prepared, you now do the following:

Since the patch should be reviewed by a Mantis developer, it will help if you also inform the mantisbt-dev mailing list about the available fix.

Posts on that list from non-subscribers are possible through services like GMANE

Thank you for reading this document – we look forward to your patches! :-)