[Avida-cvs] [avida-svn] r885 - development/documentation
brysonda at myxo.css.msu.edu
brysonda at myxo.css.msu.edu
Tue Aug 22 15:17:55 PDT 2006
Author: brysonda
Date: 2006-08-22 18:17:55 -0400 (Tue, 22 Aug 2006)
New Revision: 885
Added:
development/documentation/svn.html
Removed:
development/documentation/cvs.html
Modified:
development/documentation/index.html
Log:
Update documentation in regards to Subversion (rather heavily modify the CVS documentation to refer to subversion instead)
Deleted: development/documentation/cvs.html
===================================================================
--- development/documentation/cvs.html 2006-08-22 21:39:09 UTC (rev 884)
+++ development/documentation/cvs.html 2006-08-22 22:17:55 UTC (rev 885)
@@ -1,187 +0,0 @@
-<html>
-<title>Setting up the CVS</title>
-<body
- bgcolor="#FFFFFF"
- text="#000000"
- link="#0000AA"
- alink="#0000FF"
- vlink="#000044">
-
-<h2 align=center>Setting up the CVS</h2>
-
-<p>
-Since we have multiple people doing programming on avida, we are using
-<a href="http://www.sourceforge.net">SourceForge</a> to keep the project
-organized. The developmental version of avida is maintained there using
-a program called the "Concurrent Versions System" or CVS. This document will
-tell you how to setup your account so that you will be able to use the CVS.
-I'll also give you some instruction on how the CVS works, but you can skip
-that if you want, and the next document will tell you what you need to type
-if all you want to do is pull avida out of the CVS. Click
-<a href="http://sourceforge.net/projects/avida/">here<a> if you want to go
-directly to the Avida project page on SourceForge (this is not needed to
-download the source).
-
-<h3>Configuring the CVS</h3>
-
-<p>
-The CVS software now comes with virtually all flavors of Unix and Linux. If
-you are using a system that does not have it, you may need to look into
-downloading it first. The rest of this document assumes that you do have
-CVS available to you.
-
-<p>
-The first thing you need to do is determine what kind of "shell" you are
-using. The shell determines how your command line works, and how you
-configure "environment variables" that let programs know where things are.
-In this case, you are going to need to set an environment variable to let
-CVS know where the software repository is, and what protocol to use to
-access it. To begin with, type "<tt>echo $SHELL</tt>" on the command line.
-
-<p>
-If the response is /bin/tcsh, you should:
-<p>
-<ol>
-<li>In your home directory, open the file .cshrc in a text editor.
-<p>
-<li>Move to the end of the file, and add in the lines:
-<p>
-<tt>
- setenv CVSROOT anonymous at cvs.avida.sourceforge.net:/cvsroot/avida<br>
- setenv CVS_RSH ssh
-</tt>
-<p>
-This will set the needed environment variables. To be able to make changes
-to the Avida sourcecode directly, you need to get an account on SourceForge,
-and then substitute your account name for "anonymous" above. You then need
-to be added as a developer on the project, so make sure to talk with one of
-the project admin's first.
-<p>
-<li>Save the document and exit your text editor.
-<p>
-<li>One the command line, type "<tt>source .cshrc</tt>" to update the
- environment variables for the shell that you're currently logged into.
- All new shells that you open in the future will automatically read this
- file.
-</ol>
-
-<p>
-If your shell is /bin/bash, you should:
-<p>
-<ol>
-<li>In your home directory, open the file .bashrc in a text editor.
-<p>
-<li>Move to the end of the file, and add in the lines:
-<p>
-<tt>
- CVSROOT="anonymous at cvs.avida.sourceforge.net:/cvsroot/avida"<br>
- CVS_RSH=ssh<br>
- export CVSROOT<br>
- export CVS_RSH<br>
-</tt>
-<p>
-Where you replace username with your own account name from myxo. This will
-set the needed environment variables.
-<p>
-<li>Save the document and exit your text editor.
-<p>
-<li>One the command line, type "<tt>source .bashrc</tt>" to update the
-environment
-variables for the shell that you're currently logged into. All new shells
-that you open in the future will automatically read this file.
-</ol>
-
-<p>
-I'm not as familiar with other shells, so if you are using another one,
-you're on your own.
-
-<p>
-Test to make sure this worked. Type "<tt>echo $CVSROOT</tt>" on the
-command line, and make sure the result is the one you entered above.
-Do the same for "<tt>echo $CVS_RSH</tt>".
-
-
-<h3>How to use a CVS</h3>
-
-<p>
-Once you have your environment variables straight, the CVS is very easy to
-use. The way you send a command to the CVS is by typing
-"<tt>cvs <i>command</i></tt>" where you replace <i>command</i> by the command
-you wish to issue. To get a brand new project called "ecoli_racing" out of
-the CVS, you would type "<tt>cvs get ecoli_racing</tt>". It would pull all
-of the files from the CVS, and place them in your current directory.
-
-<p>
-When a project is downloaded from the CVS, it will also create a new
-sub-directory inside of each project-directory, called CVS/. This lets
-future CVS commands know the status of all your files and what project they
-are part of, so you should never need to tell it again.
-
-<p>
-Here are some of other commands that you can execute inside of a project
-that you have retrieved from the CVS:
-
-<table cellpadding=5>
-<tr><td valign=top><b><tt>cvs update</tt></b>
- <td>This command will incorporate all changes anyone else has made in
- the project since last time you downloaded it. If you have made any
- changes to the project yourself, it will merge those changes
- (discussed more below).
-<tr><td valign=top><b><tt>cvs status</tt></b>
- <td>This command will tell you the status of each file in the CVS. It
- will let you know if you have made changes to it ("locally modified"),
- if someone else has made changes ("needs update"), or both ("needs
- merge").
-<tr><td valign=top><b><tt>cvs commit</tt></b>
- <td>You would use this command to commit all of the changes you have
- made to the sourcecode so that everyone else can use them. Do not
- do this lightly!!! Remember, that any bugs that are introduced into
- the code this way will now affect everyone. Fortunately, the CVS
- has a logging system that will allow us to back out of any problematic
- changes, but as long as everyone is careful, that shouldn't be
- necessary.
-<tr><td valign=top><b><tt>cvs diff <filename></tt></b>
- <td>This command will show you any differences between the file that
- you have and the current version of the file in the CVS.
-
-<tr><td valign=top><b><tt>cvs help</tt></b>
- <td>Prints a list of all available CVS commands, with a brief description
- of each.
-</table>
-
-<p>
-If you are just using the CVS in order to have the most up-to-date version
-of avida, than you should never have any problems with it. An occasional
-"<tt>cvs update</tt>" when you need a newly implemented feature should do
-the trick. However, if you are going to edit the code (even if you never
-plan to commit your changes) there are some other things you need to worry
-about.
-
-<p>
-In particular, what happens if both you and someone else edit the source
-code at the same time? Well, in fact the CVS is very good at handling this.
-If they are two different files, then there is no problem at all. If they
-are even the <i>same</i> file, but different sections of it, this isn't a
-problem either -- the CVS will typically merge the changes smoothly and
-correctly. The real problem is when two people edit the same part of the
-same file.
-
-<p>
-When this happens and you try to update, the CVS will say "Warning: conflicts
-have occured". As the individual files scoll by, it will let you know which
-ones need to be manually merged. After the update, when you edit the file,
-you will see that there will be a ">>>>>>>>>>" on one line in the file,
-followed by your edits, then a "===========" and the other persons edits,
-and finally a "<<<<<<<<<<<" to indicate the end of the other persons edits.
-It is now your job to merge your edits with theirs. In the case of avida,
-I'd be happy to help with this if it ever ends up being a problem. Most of
-the time this is caused by two people trying to fix the same bug, and you can
-just choose one edit or the other and either will work just fine.
-
-<p>
-For more information on the CVS, see this
-<a href="http://wwwinfo.cern.ch/asd/cvs/tutorial/cvs_tutorial_toc.html">tutorial</a>
-<br><hr>
-Project hosted by:<br>
-<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=46761&type=2" width="125" height="37" border="0" alt="SourceForge.net"/></a>
-
\ No newline at end of file
Modified: development/documentation/index.html
===================================================================
--- development/documentation/index.html 2006-08-22 21:39:09 UTC (rev 884)
+++ development/documentation/index.html 2006-08-22 22:17:55 UTC (rev 885)
@@ -1,19 +1,27 @@
-<title>Index of Avida Documentation</title>
+<html>
+<head>
+ <title>Index of Avida Documentation</title>
+</head>
+<body>
-<h1 align=center>Index of Avida Documentation</h1>
+<div align="center">
+<h1>Index of Avida Documentation</h1>
+</div>
This file catalogs the available documentation about the avida system.
-<h3>General Information</h3>
+<h2>General Information</h2>
<p>
<a href="cpu_tour.html">A Guided Tour of an Avida Ancestor and its Hardware</a><br>
<a href="devel.html">Retriving the Developmental Version of Avida</a><br>
<a href="structure.html">The Directory and File Structure of Avida</a><br>
<a href="level_map.html">A levelization Map of the Avida Source Code</a><br>
+<a href="svn.html">Using Subversion to Obtain Avida</a><br>
-<h3>Configuration Files</h3>
+<h2>Configuration Files</h2>
+
<p>
<a href="genesis.html">Setting up the Genesis File</a><br>
<a href="inst_set.html">Setting up the Instruction Set</a><br>
@@ -22,7 +30,7 @@
<a href="analyze_mode.html">Guidelines to Analyze Mode</a><br>
<a href="analyze_samples.html">Sample Analyze Programs</a><br>
-<h3>Guides to Modifying the Avida Source Code</h3>
+<h2>Guides to Modifying the Avida Source Code</h2>
<p>
<a href="code_c++_intro.html">Introduction to C++ Coding in Avida</a><br>
@@ -37,13 +45,10 @@
<a href="code_environment.html">The Environment Source Code</a><br>
-<h3>Other Tools</h3>
+<h2>Other Tools</h2>
<p>
-<a href="cvs.html">CVS - Concurrent Versions System</a><br>
<a href="screen.html">The "screen" Virtual Terminal</a><br>
-<br><hr>
-Project hosted by:<br>
-<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=46761&type=2" width="125" height="37" border="0" alt="SourceForge.net"/></a>
-
\ No newline at end of file
+</body>
+</html>
Copied: development/documentation/svn.html (from rev 884, development/documentation/cvs.html)
===================================================================
--- development/documentation/cvs.html 2006-08-22 21:39:09 UTC (rev 884)
+++ development/documentation/svn.html 2006-08-22 22:17:55 UTC (rev 885)
@@ -0,0 +1,109 @@
+<html>
+<head>
+ <title>Using Subversion to Obtain Avida</title>
+</head>
+<body>
+
+<p><a href="index.html">Return to the Index</a></p>
+<hr />
+
+<div align="center">
+<h1>Using Subversion to Obtain Avida</h1>
+</div>
+
+<p>
+Avida is a collaborative project developed and maintained by developers
+and researchers around the world. In order to manage the changes from
+concurrent development, the Avida source code is maintained within
+repository software called Subversion or SVN. This document provides
+directions for obtaining the current source code via anonymous SVN
+Web-DAV checkout.
+</p>
+
+<p>
+Subversion client software can be obtained from Tigris.org at
+<a href="http://subversion.tigris.org/">http://subversion.tigris.org/</a>.
+</p>
+
+<h2>Using Subversion</h2>
+
+<p>
+Under Unix platforms (Linux, Solaris, OS X), Subversion is used via the
+command line. You issue commands by typing "<tt>svn <i>command</i></tt>"
+where you replace <i>command</i> with the command you wish to issue.
+</p>
+
+<p>
+To download the Avida project, issue the 'checkout' command with the path
+to the Avida repository. The following two command lines show how this
+command should look and provide the repository paths. The first line is
+the preferred path. The second can be used in instances where outbound
+firewalls have blocked access to non-standard web ports.
+</p>
+
+<pre>
+svn checkout http://myxo.css.msu.edu:7632/avida/trunk
+svn checkout http://myxo.css.msu.edu:443/avida/trunk
+</pre>
+
+
+<p>
+When a project is downloaded from the Subversion, it will also create a new
+sub-directory inside of each project-directory, called .svn/. This lets
+future SVN commands know the status of all your files and what project they
+are part of, so you should never need to tell it again.
+<p>
+
+<p>
+Here are some of other commands that you can execute inside of a project
+that you have retrieved from the Subversion:
+</p>
+<dl>
+<dt>svn update</dt>
+<dd>This command will incorporate all changes anyone else has made in
+ the project since last time you downloaded it. If you have made any
+ changes to the project yourself, it will merge those changes.</dd>
+<dt>svn status</dt>
+<dd>This command will tell you the status of each file in the within your
+ working copy. Supplying the option --show-updates will show you updates
+ that have occurred within the repository.</dd>
+<dt>cvs diff <filename></dt>
+<dd>This command will show you any changes that you have made to the file
+ since it was last updated.</dd>
+<dt>svn help</tt></b>
+<dd>Prints a list of all available commands, with a brief description of each.</dd>
+</dl>
+
+
+<p>
+If you are just using the SVN in order to have the most up-to-date version
+of avida, than you should never have any problems with it. An occasional
+"<tt>svn update</tt>" when you need a newly implemented feature should do
+the trick. However, if you are going to edit the code (even if you never
+plan to commit your changes) there are some other things you need to worry
+about.
+</p>
+<p>
+In particular, what happens if both you and someone else edit the source
+code at the same time? Well, in fact the SVN is very good at handling this.
+If they are two different files, then there is no problem at all. If they
+are even the <i>same</i> file, but different sections of it, this generally
+isn't a problem either -- the SVN will merge the changes smoothly and
+correctly. The real problem is when two people edit the same part of the
+same file.
+</p>
+<p>
+When this happens and you try to update, the Subversion will list files
+in the update messages with a C in the first column. After the update, when
+you edit the file, you will see that there will be a ">>>>>>>>>>" on one line in the file,
+followed by your edits, then a "===========" and the other persons edits,
+and finally a "<<<<<<<<<<" to indicate the end of the other persons edits.
+It is now your job to merge your edits with theirs. Most of
+the time this is caused by two people trying to fix the same bug, and you can
+just choose one edit or the other and either will work just fine.
+
+<hr />
+<p><a href="index.html">Return to the Index</a></p>
+
+</body>
+</html>
\ No newline at end of file
More information about the Avida-cvs
mailing list