Add a new project: Difference between revisions

From VrlWiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
Line 17: Line 17:
You should also include some simple tests.  See [[Software tests|Create and automate software tests]] for details.
You should also include some simple tests.  See [[Software tests|Create and automate software tests]] for details.


== Write a Test ==
It is also a good idea to provide one or more quick tests that can be included in the test suite we run each night.  Tests need to run in batch mode and simply return a zero status if successful and non-zero if they fail.
Ideally in the top level directory you should declare a make target to run the test.  Typically if there is only one test the target name is '''"test"'''.  When there are several each target name should use the prefix '''"test."''' plus include a composite target to run all of them with the name '''"alltest"'''.  This way they can all be run when you type '''"make  alltest"'''.
After you've checked in the code, check it out into a test directory and verify that it builds and runs.  If there are files unintentionally checked in be sure to remove them from the CVS repository.


== Check In the Project ==
== Check In the Project ==


Once you are ready you can check in your project.  You will probably have files in your directory that do not belong in CVS.  Only the source code, make files, and files essential for building an running the project should be checked in.
Once you are ready you can check in your project.  You will probably have files in your directory that do not belong in CVS.  Only the source code, make files, and files essential for building an running the project should be checked in.

Revision as of 15:45, 21 April 2010

Write and Build Project Code

Projects can be added to CVS under either the common/ directory (shared code) or the project/ directory (project specific code). Your code should be in a subdirectory of these in your sandbox. The following command examples are for Linux. 

> mkdir -p  /map/gfx0/users/$USER/project/<my_project>


Each directory in your project will need it's own Makefile. If your project has several directories it is a convention to create a top level Makefile to build all of them. The G Build system is invoked from your make files to provide a common simple build mechanism. Sample make files and instructions on how to use the G Build system are here: 

http://sourceforge.net/apps/mediawiki/vrg3d/index.php?title=Writing_Make_Files


If you want to inspect the build files they are in:
common/build/make


You should also include some simple tests. See Create and automate software tests for details.


Check In the Project

Once you are ready you can check in your project. You will probably have files in your directory that do not belong in CVS. Only the source code, make files, and files essential for building an running the project should be checked in.

Retrieved from "http://vrl.cs.brown.edu/wiki/index.php?title=Add_a_new_project&oldid=4212"