[LON-CAPA-cvs] cvs: loncom /build readme.html
raeburn
raeburn@source.lon-capa.org
Sun, 09 Jan 2011 19:01:23 -0000
raeburn Sun Jan 9 19:01:23 2011 EDT
Modified files:
/loncom/build readme.html
Log:
- Update information about CVS access.
- xhtml.
- improved guidance for commit logging.
Index: loncom/build/readme.html
diff -u loncom/build/readme.html:1.22 loncom/build/readme.html:1.23
--- loncom/build/readme.html:1.22 Mon Feb 3 18:03:52 2003
+++ loncom/build/readme.html Sun Jan 9 19:01:23 2011
@@ -1,8 +1,8 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- The LearningOnline Network with CAPA -->
-<!-- $Id: readme.html,v 1.22 2003/02/03 18:03:52 harris41 Exp $ -->
-<html>
+<!-- $Id: readme.html,v 1.23 2011/01/09 19:01:23 raeburn Exp $ -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta>
<title>LON-CAPA Software Developer Guide</title>
@@ -10,13 +10,13 @@
<body>
<h1>LON-CAPA Software Developer Guide</h1>
<p>
-January 17, 2001</i>
-<br /><i>Last updated, August 14, 2002</i>
+Created: <i>January 17, 2001</i>
+<br />Last updated: <i>January 9, 2011</i>
</p>
<ol>
<li><a href="#Using_CVS">Using CVS</a>
<ul>
-<li><a href="#cvslog">Logging in and out (cvs login; cvs logout)</a></li>
+<li><a href="#cvslog">Setting up cvs access</a></li>
<li><a href="#cvsupdate">Updating files (cvs update -d)</a></li>
<li><a href="#cvssave">Saving files (cvs commit)</a></li>
<li><a href="#cvsadd">Adding files (cvs add)</a></li>
@@ -44,29 +44,25 @@
terminal.
<ul>
<li><a name="cvslog" />
- <h3>Using CVS: Logging in and out (cvs login; cvs logout)</h3>
+ <h3>Setting up cvs access</h3>
<p>
-In order to log into CVS, CVS needs to be part of your system environment.
+CVS needs to be part of your system environment in order to access the LON-CAPA CVS repository,
You can do this by:
</p>
<p>
<font color="#008800">
-<tt>export CVSROOT=:pserver:USERNAME@install.lon-capa.org:/home/cvs</tt>
+<tt>export CVS_RSH=ssh</tt><br />
+<tt>export CVSROOT=:ext:USERNAME@source.lon-capa.org:/home/cvs</tt>
</font>
</p>
-<p>
-To actually login, you will need to execute the following command:
-</p>
-<p>
-<font color="#008800">
-<tt>cvs login</tt>
-</font>
-</p>
-<p>
-You are then prompted for a password.
-If you do not have a password, or the password is not working, you
-should contact <a href="mailto:helen@lon-capa.org">helen@lon-capa.org</a>.
-</p>
+<br />
+To actually issue CVS commands you will need to:
+<br /><br />
+<ol>
+<li>Have installed the CVS client, e.g., <font color="#008800"><tt>yum install cvs</tt></font></li>
+<li>Have been issued a CVS account, (send a request to the <a href="mailto:helpdesk@loncapa.org">LON-CAPA helpdesk</a>)</li>
+<li>Have generated public and private keys via <font color="#008800"><tt>ssh-keygen -t dsa</tt></font> and sent the public key to the LON-CAPA helpdesk for installation on the CVS server.</li>
+</ol>
<p>
The first time you use CVS, you need to CHECKOUT the repository.
Generally speaking, you need to checkout <tt>loncapa</tt> only once
@@ -80,14 +76,6 @@
<tt>cd loncapa</tt>
</font>
</p>
-<p>After completing work with the CVS repository,
-you can log out:
-</p>
-<p>
-<font color="#008800">
-<tt>cvs logout</tt>
-</font>
-</p>
</li>
<li><a name="cvsupdate" />
<h3>Using CVS: Updating files (cvs update -d)</h3>
@@ -196,10 +184,10 @@
Note that CVS typically invokes the
<a href="http://www.eng.hawaii.edu/Tutor/vi.html">vi</a> editor and solicits
comments about your latest changes to the software. Your comments should be
-both short yet uniquely descriptive. For example:
+descriptive and informative. For example:
</p>
<ul>
-<li><strong>BAD</strong> - "made some changes and am drinking soda"</li>
+<li><strong>BAD</strong> - "saving my work"</li>
<li><strong>GOOD</strong> - "implemented syntax checking of perl scripts
with -c flag"</li>
</ul>