Dollarg 2009 - Revision history

Jadrian Miles: /* Setting Environment Variables for your User Account */

2009-12-09T18:24:31Z

Setting Environment Variables for your User Account

← Older revision		Revision as of 18:24, 9 December 2009
Line 3:		Line 3:
	== Setting Environment Variables for your User Account ==		== Setting Environment Variables for your User Account ==

	Edit your ~/.~~cshrc~~ file and add the lines:		Edit your ~/.environment file and add the lines:

	<pre>		<pre>
	~~setenv~~ GROOT /map/gfx0		setenvvar GROOT /map/gfx0
	~~source~~ $GROOT/tools/gfxtools-startup-csh		setenvvar CVSROOT /map/gfx0/cvsroot
			</pre>

			If you use C-shell, edit your .cshrc and add somewhere below the <code>sourcefile $HOME/.environment</code> line:

			<pre>
			sourcefile $GROOT/tools/gfxtools-startup-csh
			</pre>

			If you use Bash, edit your .bashrc and add somewhere below the <code>sourcefile $HOME/.environment</code> line:

			<pre>
			sourcefile $GROOT/tools/gfxtools-startup-bash
			</pre>

			Remember that your environment variables will not be updated immediately; only newly-opened shells will get them, so close your current shell and open a new one. You can check that everything worked by entering

	~~setenv CVSROOT /map/gfx0/cvsroot~~		<pre>
			echo $G
	</pre>		</pre>

			If you get non-error output, then you're all set.

	== Checking out a project ==		== Checking out a project ==

2009-01-14T22:24:21Z

← Older revision		Revision as of 22:24, 14 January 2009
Line 61:		Line 61:
	By convention the make target should be named with a prefix, "test" (e.g. testmore).		By convention the make target should be named with a prefix, "test" (e.g. testmore).

	[[Category:$G]][[Category:Software Development]][[Category:IT Tools]]		[[Category:$G]][[Category:Software Development]][[Category:IT Tools]][[Category:$G HOWTO]]

2009-01-14T22:22:50Z

← Older revision		Revision as of 22:22, 14 January 2009
Line 60:		Line 60:
	Projects can include additional tests.		Projects can include additional tests.
	By convention the make target should be named with a prefix, "test" (e.g. testmore).		By convention the make target should be named with a prefix, "test" (e.g. testmore).

			[[Category:$G]][[Category:Software Development]][[Category:IT Tools]]

2009-01-13T20:46:01Z

Checking out a project

← Older revision		Revision as of 20:46, 13 January 2009
Line 14:		Line 14:
	== Checking out a project ==		== Checking out a project ==

	$G uses CVS for source control and you can read more about it [http://www.nongnu.org/cvs/ ~~here~~].		$G uses CVS for source control and you can read more about it [http://www.nongnu.org/cvs/ on its official site] or [[w:Concurrent Versions System\|on Wikipedia]].

	You can work anywhere except under the $G directory.		You can work anywhere except under the $G directory.

2009-01-13T20:42:38Z

← Older revision	Revision as of 20:42, 13 January 2009
(No difference)

2009-01-06T17:32:06Z

Setting Environment Variables for your User Account

← Older revision		Revision as of 17:32, 6 January 2009
Line 6:		Line 6:

	<pre>		<pre>
	setenv GROOT /map/gfx0		setenv GROOT /map/gfx0
	source $GROOT/tools/gfxtools-startup-csh		source $GROOT/tools/gfxtools-startup-csh

	setenv CVSROOT /map/gfx0/cvsroot		setenv CVSROOT /map/gfx0/cvsroot
	</pre>		</pre>

2009-01-06T17:28:18Z

Creating a "test" for a project

← Older revision		Revision as of 17:28, 6 January 2009
Line 49:		Line 49:
	Testing is helpful to find bugs, detect problems discovered by system upgrades, and to help make sure projects are working on a daily basis.		Testing is helpful to find bugs, detect problems discovered by system upgrades, and to help make sure projects are working on a daily basis.

	~~To add~~ a test ~~to your project, create a~~ "test" ~~target in the Makefile~~.		Each project should contain a simple smoke test with the target name "test".
			It should ensure basic functionality and run reasonably fast.
	For example, to run a test for the wrist project you ~~could~~ type:		For example, to run the test for the wrist project you would type:

	<pre>		<pre>
	cd /map/gfx0/users/foo/project/wrist		> cd /map/gfx0/users/foo/project/wrist
	make test		> make test
	</pre>		</pre>

	~~''Note to doc authors: what if~~ a ~~project wants more than one~~ test~~?''~~		Projects can include additional tests.
			By convention the make target should be named with a prefix, "test" (e.g. testmore).

2009-01-06T17:19:09Z

Building a project

← Older revision		Revision as of 17:19, 6 January 2009
Line 39:		Line 39:

	<pre>		<pre>
	cd /map/gfx0/users/foo/project/wrist		> cd /map/gfx0/users/foo/project/wrist
	make all		> make all
	</pre>		</pre>

			By convention simple projects that build a single program or library can be built just by typing "make".

	== Creating a "test" for a project ==		== Creating a "test" for a project ==

2009-01-06T17:14:56Z

Checking out a project

← Older revision		Revision as of 17:14, 6 January 2009
Line 28:		Line 28:
	> mkdir /map/gfx0/users/goo		> mkdir /map/gfx0/users/goo
	> cd /map/gfx0/users/goo		> cd /map/gfx0/users/goo
	> cvs co project/wrist		> cvs co project/wrist # Creates: /map/gfx0/users/goo/project/wrist/...
	</pre>		</pre>

2009-01-06T17:13:21Z

Checking out a project

← Older revision		Revision as of 17:13, 6 January 2009
Line 16:		Line 16:
	$G uses CVS for source control and you can read more about it [http://www.nongnu.org/cvs/ here].		$G uses CVS for source control and you can read more about it [http://www.nongnu.org/cvs/ here].

	You can work anywhere ~~you choose, but a good location is~~:		You can work anywhere except under the $G directory.
			At Brown ample disk space has been allocated here for students:

	<pre>		<pre>
	/map/gfx0/users/~~<your_user_id>~~		/map/gfx0/users/$USER
	</pre>		</pre>

	So, for example, if your user id is "~~foo~~" and you wanted to check out the "wrist" project, you should type:		So, for example, if your user id is "goo" and you wanted to check out the "wrist" project, you should type:

	<pre>		<pre>
	/map/gfx0/users/~~foo~~		> mkdir /map/gfx0/users/goo
	cvs co project/wrist		> cd /map/gfx0/users/goo
			> cvs co project/wrist
	</pre>		</pre>

			Please do not waste space and retain only the files you need.
			When you are done with your account please be sure to delete it.

	== Building a project ==		== Building a project ==