Difference between revisions of "Non Product Build"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Orignal was correct. Changed back.)
 
(15 intermediate revisions by 8 users not shown)
Line 1: Line 1:
A so-called Non-Product Build of OpenOffice.org is one that contains a lot of additional diagnostics and debug code, which is available in this special mode only. Such a build is usually larger (and slower :) than an ordinary Product Build (which basically means: every build you ever downloaded from OpenOffice.org), but is very useful for developers.
+
A so-called '''Non-Product Build''' of [[OpenOffice.org|Apache OpenOffice]] contains a lot of additional diagnostics and [[Debugging|debug]] code, which is available in this special mode only. Such a build is usually larger and slower than an ordinary '''Product Build''' (which basically means: every build you ever downloaded from OpenOffice.org), but is very useful for developers.
  
Currently, Non-Product Builds are probably rarely used outside the Hamburg development team (which might be because the facilities are widely unknown).
+
By default a Product Build is created, i.e. it is ready for release after completion. Non-Product Builds are created using the <code>--enable-dbgutil</code> switch during <code>configure</code>, which makes creation a non-product build simple. The debug options window lets you control your level of annoyance. At least the assertions raised are interesting for developers.
  
Non-Product Builds are created using a [[Debugging#How_do_I_use_the_debug_console_.3F|special configure switch]], namely <code>--enable-dbgutil</code>.
+
The most visible feature of Non-Product Builds are so-called assertions - Basically message boxes popping up and saying that something went not the way the developer expected it to go. Such assertions are interesting for developers and are considered bugs. As such they should be [http://qa.openoffice.org/issue_handling/pre_submission.html reported in IssueZilla], with the summary starting with "ASSERT:" or "ERROR:" (since ERROR: is used by most of the assertion message boxes themself).
  
 +
To use (or do QA for) the additional debug features: just run AOO, and when it's in full-flow, press <Alt>-<Shift>-<Control>-'D' in that order; this should popup a  debugging options window:
  
The most visible feature of Non-Product Builds are so-called assertions - Basically message boxes popping up, and saying that something went not the way the developer expected it to go. Such assertions are considered bugs, and as such should be [http://qa.openoffice.org/issue_handling/pre_submission.html reported in IssueZilla], with the summary starting with "ASSERT:" or "ERROR:" (since ERROR: is used by most of the assertion message boxes themself).
 
  
To use (or do QA for) the additional debug features: just run OO.o, and when it's in full-flow, press <Alt>-<Shift>-<Control> 'D' in that order; this should popup a [[http://go-oo.org/images/debug-window.png debugging options window]]. The debugging options are subsequently saved to the .dbgsv.init file for the next run; you can control the location of that with: export DBGSV_INIT=$(HOME)/.dbgsv.init eg. it is (unfortunately) a binary file.
+
[[Image:Vcl_debug_options.png]]
Try the help integrated into the debugging options window to see what it offers.
+
 
 +
 
 +
The debugging options are subsequently saved to the .dbgsv.ini file for the next run (you can control the location of that with e.g. <code>export DBGSV_INIT=$(HOME)/.dbgsv.init</code>).
 +
 
 +
Try the help integrated into the debugging options window to see what features it offers.
 +
 
 +
For available tools in non-product builds, have a look at the various <code>DBG_foo</code> macros in <code>tools/inc/tools/debug.hxx</code>, or, if you already are knowledgeable about this, let others participate by writing your knowledge down here.
 +
 
 +
[[Category:Build_System]]
 +
[[Category:Debugging]]

Latest revision as of 23:13, 27 January 2015

A so-called Non-Product Build of Apache OpenOffice contains a lot of additional diagnostics and debug code, which is available in this special mode only. Such a build is usually larger and slower than an ordinary Product Build (which basically means: every build you ever downloaded from OpenOffice.org), but is very useful for developers.

By default a Product Build is created, i.e. it is ready for release after completion. Non-Product Builds are created using the --enable-dbgutil switch during configure, which makes creation a non-product build simple. The debug options window lets you control your level of annoyance. At least the assertions raised are interesting for developers.

The most visible feature of Non-Product Builds are so-called assertions - Basically message boxes popping up and saying that something went not the way the developer expected it to go. Such assertions are interesting for developers and are considered bugs. As such they should be reported in IssueZilla, with the summary starting with "ASSERT:" or "ERROR:" (since ERROR: is used by most of the assertion message boxes themself).

To use (or do QA for) the additional debug features: just run AOO, and when it's in full-flow, press <Alt>-<Shift>-<Control>-'D' in that order; this should popup a debugging options window:


Vcl debug options.png


The debugging options are subsequently saved to the .dbgsv.ini file for the next run (you can control the location of that with e.g. export DBGSV_INIT=$(HOME)/.dbgsv.init).

Try the help integrated into the debugging options window to see what features it offers.

For available tools in non-product builds, have a look at the various DBG_foo macros in tools/inc/tools/debug.hxx, or, if you already are knowledgeable about this, let others participate by writing your knowledge down here.

Personal tools