updated documentation
[btb/d2x.git] / cvshowto.txt
1 Adapted from the d1x cvs howto <http://d1x.warpcore.org/cvshowto.txt>\r
2 by Bradley Bell <bradleyb@u.washington.edu>\r
3 \r
4 A quick howto on accessing the d2x source with CVS.\r
5 \r
6 0) if you are using windows, or some other non unix os, and the standard\r
7   command line cvs client, you will need to set your home directory.\r
8   set home=c:\home\\r
9   or something like that.\r
10 \r
11 1) cd <your source dir>\r
12 \r
13 1.5) cvs -d ":pserver:<username>@shelob.classrooms.washington.edu:/var/cvs" login\r
14   Unless you already know your username, you want "anonymous".  When\r
15   prompted for the password just hit return (no password).\r
16 \r
17 2) cvs -d ":pserver:<username>@shelob.classrooms.washington.edu:/var/cvs" checkout d2x\r
18   This will retrieve the source into <current dir>/d2x\r
19   (you may wish to look into the -z flag, ex "-z3" to compress the code for\r
20   faster transmission)\r
21   (note that this should only be done once.  After you already have the code,\r
22   merely do a "cvs update -PAd" from the d2x dir to update to the latest code)\r
23 \r
24 3) Make your changes and stuff.  (Test them too).\r
25 \r
26 4) You will want to do a cvs update before commiting, to make sure your\r
27   changes still work with any other changes that may have been commited while\r
28   you were working.\r
29 \r
30 5) If you have readonly access:\r
31   If you have only modified existing files, this should generate a usable diff:\r
32   cvs -q diff -uRN . > mychanges.patch \r
33   (hopefully you would use a more useful name, and remember to examine the\r
34   result first, to make sure its ok.)\r
35   If you have added files or directories, this won't be as useful since you\r
36   can't use the 'cvs add' command to get cvs to recognize them.  In this case\r
37   you should diff manually, or just zip up the new files.\r
38 \r
39   Once you have the patches/zips made, the best way to get them included is to\r
40   post a message to the descent-source list with the files attached, or an url\r
41   to the files. (see notes below)\r
42   \r
43 -or- if you have full cvs access:\r
44 \r
45   cvs commit -m "summary of changes" <changed file(s)>\r
46   or, if you want to commit all changes (in current, and sub dirs), just:\r
47   cvs commit -m "summary of changes"\r
48   (note, only the files that CVS knows about will be commited.  *.o/*.bak/etc\r
49   will be ignored.  If you want to add a new file, use 'cvs add <file>')\r
50   If you have made several unrelated changes, please commit each file seperatly\r
51   with appropriate log messages, rather than blanketing them all in an\r
52   ambiguous message.\r
53 \r
54 6) Now that you have the source downloaded, you no longer need steps 1-2.\r
55   Merely do a "cvs update" whenever you want to bring your tree up to the\r
56   latest code, and continue from step 3.\r
57 \r
58 Notes:\r
59 It is highly recommend that all developers subscribe to the descent-source\r
60 mailing list.  To signup, send an email to majordomo@warpcore.org with\r
61 "subscribe descent-source your@email.address" in the body.\r
62 \r
63 If some of your changes are too close to other peoples, update or commit may\r
64 cause a "conflict".  You should probably talk with whoevers code it conflicts\r
65 with, unless the solution is obvious.\r
66 \r
67 Of course, this is only a brief overview.  It is recommended you browse the CVS\r
68 documention as well. (info cvs, or equivilant).  If you have questions, or\r
69 think this howto could use some clarification, feel free to ask.\r
70 \r
71       A great book on cvs is available online:\r
72       http://cvsbook.red-bean.com/cvsbook.html\r
73 \r
74 Where to download CVS: http://www.cyclic.com/cyclic-pages/howget.html\r