1: <H1>LON-CAPA Software Developer Instructions</H1>
2:
3: <OL>
4: <LI><A HREF="#Using_CVS">Using CVS</A>
5: <UL>
6: <LI><A HREF="#cvslog">Logging in and out (cvs login; cvs logout)</A>
7: <LI><A HREF="#cvsget">Getting files (cvs update -d)</A>
8: <LI><A HREF="#cvsupdate">Updating files (cvs update -d)</A>
9: <LI><A HREF="#cvssave">Saving files (cvs commit)</A>
10: <LI><A HREF="#cvsadd">Adding files (cvs add)</A>
11: <LI><A HREF="#cvsadddir">Adding directories (cvs add/import)</A>
12: <LI><A HREF="#cvsnotsure">What to do when you're not sure about your files (cvs update)</A>
13: </UL>
14: <LI><A HREF="#makeHTML">Viewing the software (make HTML)</A>
15: <LI><A HREF="#makebuild">Compiling the software (make build)</A>
16: <LI><A HREF="#loncapafiles">Adding/removing files from the LON-CAPA installation (doc/loncapafiles/loncapafiles.html)</A>
17: <LI><A HREF="#configversusnonconfig">Configurable files versus non-configurable files</A>
18: <LI><A HREF="#makeinstall">Updating the non-configurable files on your machine (make install)</A>
19: <LI><A HREF="#makeconfiginstall">Updating the configurable files on your machine (make configinstall)</A>
20: <LI><A HREF="#makeRPM">Building RPMs (make RPM)</A>
21: </OL>
22:
23: <OL>
24: <A NAME="Using_CVS">
25: <LI><H2>Using CVS</H2>
26: <UL>
27: <LI><A NAME="cvslog">
28: <H3>Using CVS: Logging in and out (cvs login; cvs logout)</H3>
29: <LI><A NAME="cvsget">
30: <H3>Using CVS: Getting files (cvs update -d)</H3>
31: <LI><A NAME="cvsupdate">
32: <H3>Using CVS: Updating files (cvs update -d)</H3>
33: <LI><A NAME="cvssave">
34: <H3>Using CVS: Saving files (cvs commit)</H3>
35: <LI><A NAME="cvsadd">
36: <H3>Using CVS: Adding files (cvs add)</H3>
37: <LI><A NAME="cvsadddir">
38: <H3>Using CVS: Adding directories (cvs add/import)</H3>
39: <LI><A NAME="cvsnotsure">
40: <H3>Using CVS: What to do when you're not sure about your files (cvs update)</H3>
41: </UL>
42: <LI><A NAME="makeHTML">
43: <H2>Viewing the software (make HTML)</H2>
44: <STRONG>Commands</STRONG>
45: <FONT COLOR="#008800">
46: <PRE>
47: cd loncom/build
48: rm -Rf HTML
49: make HTML
50: cd HTML
51: <I>(look at the index.html file with a web browser such as Netscape)</I>
52: </PRE>
53: </FONT>
54: <STRONG>General description of what happens</STRONG>
55: <P>
56: This is the actual make target code.
57: <FONT COLOR="#880000">
58: <PRE>
59: <!-- LONCAPA MAKETARGET=HTML START -->
60: HTML:
61: install -d HTML
62: cp ../../doc/loncapafiles/*.gif HTML
63: perl parse.pl ../../doc/loncapafiles/loncapafiles.html HTML > HTML/index.html
64: <!-- LONCAPA MAKETARGET=HTML END -->
65: </PRE>
66: </FONT>
67: What basically happens is that specially marked-up data in the LON-CAPA
68: cvs repository file <TT>doc/loncapafiles.html</TT> is parsed into a more
69: viewable format by <TT>loncom/build/parse.pl</TT>. The resulting
70: file gives a very well organized view of all the files, directories,
71: links, ownerships, permissions, and brief documentation of what each
72: file does.
73: </P>
74: <LI><A NAME="makebuild">
75: <H2>Compiling the software (make build)</H2>
76: <LI><A NAME="loncapafiles">
77: <H2>Adding/removing files from the LON-CAPA installation (doc/loncapafiles/loncapafiles.html)</H2>
78: <LI><A NAME="configversusnonconfig">
79: <H2>Configurable files versus non-configurable files</H2>
80: <LI><A NAME="makeinstall">
81: <H2>Updating the non-configurable files on your machine (make install)</H2>
82: <LI><A NAME="makeconfiginstall">
83: <H2>Updating the configurable files on your machine (make configinstall)</H2>
84: <LI><A NAME="makeRPM">
85: <H2>Building RPMs (make RPM)</H2>
86: </OL>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>