Add a new project - Revision history

Brad Berg at 16:31, 19 November 2010

2010-11-19T16:31:21Z

← Older revision		Revision as of 16:31, 19 November 2010
Line 8:		Line 8:
	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:		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~~		*[[Writing Make Files]]

Brad Berg at 15:02, 30 April 2010

2010-04-30T15:02:14Z

← Older revision		Revision as of 15:02, 30 April 2010
Line 14:		Line 14:
	'''common/build/make'''		'''common/build/make'''

	~~Here is an example showing~~ how to [[Build a Trivial Program]].		These examples show how to [[Build a Trivial Program]] and [[Build a Trivial Library]].


	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.

Brad Berg at 14:27, 30 April 2010

2010-04-30T14:27:55Z

← Older revision		Revision as of 14:27, 30 April 2010
Line 13:		Line 13:
	If you want to inspect the build files they are in:<br>		If you want to inspect the build files they are in:<br>
	'''common/build/make'''		'''common/build/make'''

			Here is an example showing how to [[Build a Trivial Program]].

Brad Berg: /* Check In the Project */

2010-04-23T13:30:00Z

Check In the Project

← Older revision		Revision as of 13:30, 23 April 2010
Line 20:		Line 20:
	== 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 and running the project should be checked in.

	Some essential CVS commands for checking new code into the repository are:		Some essential CVS commands for checking new code into the repository are:

Brad Berg: /* Check In the Project */

2010-04-23T13:29:22Z

Check In the Project

← Older revision		Revision as of 13:29, 23 April 2010
Line 28:		Line 28:
	> cvs add -m "<comment>" <file> ... # Add new files.		> cvs add -m "<comment>" <file> ... # Add new files.
	> cvs commit -m "<comment>" <file> ...		> cvs commit -m "<comment>" <file> ...


			The repository is primarily for source code, but in some cases binary files need to be checked in. These should be reasonably small. Large datasets are stored in '''/map/gfx0/data/''' directory.

			> cvs add -kb -m "<comment>" <file> ... # Add new binary files.
			> cvs commit -m "<comment>" <file> ...

Brad Berg: /* Check In the Project */

2010-04-23T12:44:23Z

Check In the Project

← Older revision		Revision as of 12:44, 23 April 2010
Line 21:		Line 21:

	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.

			Some essential CVS commands for checking new code into the repository are:

			> cvs add -m "<comment>" <directory> # Create a new directory.

			> cvs add -m "<comment>" <file> ... # Add new files.
			> cvs commit -m "<comment>" <file> ...

Brad Berg at 15:45, 21 April 2010

2010-04-21T15:45:12Z

← Older revision		Revision as of 15:45, 21 April 2010
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.

Brad Berg: /* Write and Build Project Code */

2010-04-21T15:43:40Z

Write and Build Project Code

← Older revision		Revision as of 15:43, 21 April 2010
Line 14:		Line 14:
	'''common/build/make'''		'''common/build/make'''


			You should also include some simple tests. See [[Software tests\|Create and automate software tests]] for details.

	== Write a Test ==		== Write a Test ==

Brad Berg: /* Write a Test */

2010-04-21T15:26:22Z

Write a Test

← Older revision		Revision as of 15:26, 21 April 2010
Line 21:		Line 21:
	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"'''.		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.

Brad Berg: /* Check In the Project */

2010-04-21T15:23:55Z

Check In the Project

← Older revision		Revision as of 15:23, 21 April 2010
Line 24:		Line 24:
	== Check In the Project ==		== Check In the Project ==

	Once you		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.