Build Status Quick Reference

 

 

CodeBench Toolbar

The Build Window shows the progress while creating the finished program from the project. The builder program, in the case of our example program, Make shows its output in this window. This allows us to see if there are any errors or at what stage the build process is at. This process runs asynchronously from CodeBench meaning you do not have to wait for the build to complete before continuing on with your work, they can both happen at the same time.

You can also specify to create a log of the build process, and this will be saved into the location you specify in the project settings.

 

back to the top

Buttons

  • Build BUtton Build the project. Functionally the same as the Toolbar Build button.

  • Build All Button Force the builder program to remake the whole project from scratch.

  • Build Options Button Allow the user to pass options to the builder program.

 

  • Run Target BUtton Run the compiled program. Functionally the same as the Toolbar Run button.

  • Debug Button Debug the compiled program. Functionally the same as the Toolbar Debug button.

 

  • Stop Build Button Stop the build process. See notes below.

    Some of the above buttons may not be available depending on the type of project currently being worked on.

back to the top

 

 

Overview

Once the build process has been started, it runs asynchronously to the main CodeBench program. This has various benefits, the most important being that the user can compile projects and continue to work in the editor, there is no need for the build process to finish before continuing. It also means you can switch to another loaded project while building another.

Building Errors The window will show whatever output the builder program generates, including errors and warnings. By double-clicking on the line in the build window that shows an error or warning, you can be taken directly to that place in the appropriate source file and be ready to correct it straight away.

editor_showingerrors

The cursor will be placed on the line that raised the error or warning, and this will be shown in the editor by the line being marked by an icon and also by being coloured accordingly. If your source code has a lot of errors, you can get the exact error text that caused the build to stop by hovering the mouse over the icon in the info column, and this will show you the error for that line.
You will notice that there is more text than just the error in the example above. This is because the error dictionary has found a match for the particular error on this line, and is offering some extended help on that error. These errors come from the error dictionary which is maintained from the project settings. The same extended help is also used in the help hint for the build window. Just hover the mouse over the build window above the line with the error to see if there is any further help available.

Once you have corrected the mistakes, these icons and line colourings are cleared automatically when you build the project again.

You can configure the colours of these lines in the Colours preferences panel.

 

 

Build Process Stopped Also, having the build process running separately to the main interface means that you can click an error and work to fix it while the build completes, and that means more productivity and less side-tracking. This asynchronous system does mean however that the Stop button may not react instantly, be prepared to wait as child processes complete.

For example, the AmigaOS4SDK project type uses the Make program, which delegates out its tasks to separate processes, so when the user selects the Stop button, not only will there be a waiting period while Make itself stops, but all its child processes too. This is not an error in CodeBench, simply a side-effect of having things happen at the same time.

back to the top

 

 

Build Options

Build Options The Build Options requester allows you to supply extra information to the build process. In the case of a C/C++ (like our example above) this can be any of the " rules" from the makefile. A rule is a way to tell the builder program how a particular piece of the project is to be compiled.

Makefiles can also contain instructions for various other uses, and typically allow a "clean" option which creates the project from scratch by deleting all previously compiled parts. There may also be a rule to increase the version number of the finished program automatically, or creating a distribution archive.

Any rules that exist in the makefile can be supplied as an option by entering its name in the string gadget. Alternatively, there is a pull-down menu to the right of the string gadget, and this contains all the rules that have been found in the current makefile. You may select whichever one you want, and it will be inserted as an option into the string gadget for you.

back to the top

 

Build Window Search function

The search system runs in different ways depending on which window it was launched from, and the Build Window will tell the search system to search the entire project for your required criteria. More information about all the functions of the search system can be found here.

back to the top

 

Valid XHTML 1.0 Transitional This is a W3C checked and compliant webpage.