1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
|
.\" Automatically generated by Pod::Man version 1.02
.\" Wed Nov 28 14:08:02 2001
.\"
.\" Standard preamble:
.\" ======================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
.\" to do unbreakable dashes and therefore won't be available. \*(C` and
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` `
. ds C' '
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
.\" index entries marked with X<> in POD. Of course, you'll have to process
.\" the output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
. .
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it
.\" makes way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
.bd B 3
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ======================================================================
.\"
.IX Title "ic_howto_cvs 8"
.TH ic_howto_cvs 8 "Interchange 4.8.3" "2001-11-28" "Interchange"
.UC
.SH "NAME"
ic_howto_cvs \- Interchange + \s-1CVS\s0 \s-1HOWTO\s0
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "Introduction"
.IX Header "Introduction"
.Sh "Preamble"
.IX Subsection "Preamble"
Copyright 2001 Dan Browning <danpb@mail.com>. This document is freely
redistributable under terms of the \s-1GNU\s0 General Public License.
.Sh "Purpose"
.IX Subsection "Purpose"
The purpose of this document is to help others take advantage of \s-1CVS\s0
and Interchange together to increase the quality of their programming,
whether they are sole developers or part of a large team of
programmers, graphic artists, and \s-1HTML\s0 design gurus. Portions of it
apply to general \s-1CVS\s0 setup and use, but it is geared toward the
average developer using Interchange to implement an e-commerce
website.
.Sh "Audience"
.IX Subsection "Audience"
I intend for this document to be useful to those who are not yet
familiar with \s-1CVS\s0 as well as those who are. If you already know how
to setup a pserver then you might just skim chapter 2 (\*(L"Setup \s-1CVS\s0\*(R"),
or skip it all together.
.PP
In addition, I have tried to write at a technical level that would be
on par with what I percieve to be the average Interchange user that
participates on the interchange-users mailing list. It is assumed
that the reader can and already has setup Interchange and the template
catalog (such as foundation or construct) is working correctly.
.Sh "Contact the author"
.IX Subsection "Contact the author"
If you find any spelling errors, technical slipups, mistakes,
subliminal messages, or if you wish to send feedback, critique,
remarks, comments, or if you wish to contribute examples, instructions
for alternative platforms, chapters, or other material, please do so.
.PP
The preferred method of submitting changes is in the form of a context
diff against the \s-1SDF\s0 source file (ic_cvs.sdf). Please address your
correspondence to:
.PP
Dan Browning \fIdanpb@mail.com\fR
.Sh "The advantages of using \s-1CVS\s0"
.IX Subsection "The advantages of using CVS"
\&\s-1CVS\s0 is a very useful tool and can help you in your development, no
matter if you are one developer or are part of a team of developers.
.Ip "\(bu" 4
What is \s-1CVS\s0 all about?
.Ip "\(bu" 4
What are it's advantages?
.PP
The official \s-1CVS\s0 website (the section on "/www.cvshome.org/new_users.html" in the http: manpage)
has more detailed answers to these questions, but here are some brief
points of interest.
.Ip "\(bu" 4
Checkout \*(L"historic\*(R" points in time or milestones in a project, for
example when an e-commerce site went \*(L"live\*(R" or before a major branch
in the code.
.Ip "\(bu" 4
Revert to older versions of a file, directory, or an entire website.
.Ip "\(bu" 4
Branching releases. Concurrently develop an unstable development
version as well as fix bugs in the stable production version.
.Ip "\(bu" 4
Multiple developers can work on the same catalog and even the same
file at the same time. (For more information about how multiple
simultaneous writes are merged and conflicts resolved, see the cvs
docs in the \fIResources\fR Appendix).
.Ip "\(bu" 4
\&\s-1CVS\s0 is better than ftp for file transfer, because it automatically
downloads only changed files, and even then, only the portion of the
file that has changed (using patches).
.Ip "\(bu" 4
\&\s-1CVS\s0 can automatically merge two simultaneous writes to the same file
by different developers.
.Ip "\(bu" 4
Allows one to keep track of the changes that have been made over time
(many release managers repackage cvs commit logs into \s-1WHATSNEW\s0,
\&\s-1HISTORY\s0, and/or \s-1NEWS\s0 files).
.Sh "How to use this document"
.IX Subsection "How to use this document"
There are many potential uses of \s-1CVS\s0 as it applies to Interchange. In
fact, there are as many unique ways to use \s-1CVS\s0 as there are unique
developers. This document only covers some of the ways, including
basic and useful techniques to get started using \s-1CVS\s0. For the intents
of the average web developer using \s-1IC\s0 for a B2C e-commerce site, I've
identified a few of the possible uses:
.PP
Simple
.Ip "\(bu" 4
One server
.Ip "\(bu" 4
One catalog
.Ip "\(bu" 4
One cvs module
.Ip "\(bu" 4
One branch
.PP
Medium
.Ip "\(bu" 4
One server
.Ip "\(bu" 4
Two catalogs (e.g., one is live, one is development)
.Ip "\(bu" 4
One cvs modules
.Ip "\(bu" 4
Seperate development and live branches
.PP
Complex/Custom
.Ip "\(bu" 4
Multiple servers (e.g., developers' servers, staging servers, and live
servers)
.Ip "\(bu" 4
Multiple catalogs
.Ip "\(bu" 4
Multiple cvs modules
.Ip "\(bu" 4
Multiple branches
.Ip "\(bu" 4
Custom setup
.PP
This document attempts to cover the simple well, and explain many
aspects of the medium. Which will hopefully give you the background
you need if you decide to setup your own complex development
environment.
.SH "Setup CVS"
.IX Header "Setup CVS"
.Sh "Assumptions"
.IX Subsection "Assumptions"
Here are some of the assumptions that I make that apply to various
parts of the rest of this document:
.Ip "\(bu" 4
Red Hat 7.x
.Ip "\(bu" 4
Interchange installed (\s-1RPM\s0 or tarball)
.Ip "\(bu" 4
Default interchange tarball installation directory paths (adjust for
your environment)
.Ip "\(bu" 4
Template catalog setup and working
.PP
\&\fBNote: \fRI will assume \*(L"foundation\*(R" for the catalog name and directory
paths, but it should be just as easy to use this document with the
construct catalog or your own catalog by mentally transposing the
names and paths.
.PP
There shouldn't be any reason why you could not do everything I
mention here on other Linux distributions, unicies or Windows (using
cygwin). However, my statements will reflect Red Hat 7.x.
Additionally, Red Hat 6.x is for the most part the same as 7.x, except
for the difference of using inetd instead of xinetd to setup pserver.
.Sh "Install \s-1CVS\s0"
.IX Subsection "Install CVS"
This is the easy part. For Red Hat systems, download the cvs rpms and
install them. The following \s-1RPM\s0 command will download and install the
Red Hat 7.1 version of cvs from rpmfind.net.
.PP
\&\fBNote: \fRYou need to be root to complete the following tasks
.PP
.Vb 2
\& su - root
\&rpm -Uvh ftp://speakeasy.rpmfind.net/linux/redhat/7.1/en/os/i386/RedHat/RPMS/cvs-1.11-3.i386.rpm
.Ve
Create the user and group that will administrate the interchange
repository. For this document, it will be the interch user, (which
was setup during the installation of Interchange). But if you
understand the mechanics of Unix users/groups, then you can use
whatever username and group scheme you prefer. For example, some
create a cvs user and cvs group, then add the interchange user and
catalog owner to it's group and/or vise-versa. The integration of
interchange and \s-1CVS\s0 in the latter portion of this document will
require that the \s-1CVS\s0 user has some write capability to the catalog
directory.
.Sh "Create the \s-1CVS\s0 repository directory"
.IX Subsection "Create the CVS repository directory"
You will need to create a repository directory such as \fI/rep\fR, which
is used here and in the rest of the document, but it can be any
directory you desire, and must be owned by the cvs user. Many use
\&\fI/var/rep\fR or \fI/home/cvs/rep\fR.
.PP
.Vb 3
\& su - root
\& mkdir /rep
\& chown interch.interch /rep
.Ve
.Sh "Setup environment variables"
.IX Subsection "Setup environment variables"
The \s-1CVSROOT\s0 and \s-1EDITOR\s0 environment variables should be setup for all
users in /etc/profile. Of course, \s-1EDITOR\s0 can be whatever Unix text
editor you prefer, such as \fIvi\fR, \fIemacs\fR, \fIpico\fR, or \fIjoe\fR.
.PP
.Vb 1
\& /etc/profile:
.Ve
export CVSROOT=/rep
export EDITOR=vi
.PP
\&\fBNote: \fRYou will need to logout/login for the profile changes to take
effect.
.Sh "Initialize the repository"
.IX Subsection "Initialize the repository"
Initialize the repository as the \s-1CVS\s0 user, which is interch for
this document.
.PP
.Vb 2
\& su - interch
\& cvs -d /rep init
.Ve
.Sh "\s-1CVS\s0 Authentication"
.IX Subsection "CVS Authentication"
Background
.PP
Authentication is done in \s-1CVS\s0 through the \fI$CVSROOT/CVSROOT/passwd\fR
file. It can be easily manipulated through some of the \s-1CVS\s0
administration tools that are available.
.PP
\&\s-1CVS\s0 administration tools
.Ip "\(bu" 4
the section on "/freshmeat.net/projects/cvsadmin/" in the http: manpage
.Ip "\(bu" 4
the section on "/freshmeat.net/projects/cvspadm/" in the http: manpage
.PP
I recommend cvsadmin, but there are also a variety of manual methods
that can be used in the absence of such tools, one of which involves
copying the system shadow file and modifying it for use by \s-1CVS\s0. For
more information on this manual method, see the RedHat \s-1CVS\s0 pserver
setup guide by Michael Amorose
(the section on "/www.michael-amorose.com/cvs/" in the http: manpage).
.PP
Setup authentication using the cvsadmin tool
.PP
You can find a tarball to install on your system using the above
address, but here is the address of a recent \s-1RPM\s0 package of the
version. This package is intended for mandrake systems, but is
compatible with Red Hat 7.1:
.Ip "\(bu" 4
the section on "/speakeasy.rpmfind.net/linux/Mandrake-devel/contrib/RPMS/cvsadmin-1.0.1-1mdk.i586.rpm" in the ftp: manpage
.PP
After installing, create a password file (\fItouch
\&\f(CI$CVSROOT\fI/CVSROOT/passwd\fR), and execute \f(CW\*(C`cvsadmin add
<usernames>\*(C'\fR.
.Sh "Setup \s-1CVS\s0 modules"
.IX Subsection "Setup CVS modules"
\&\fBNote: \fRFrom this point on, assume that all commands are executed as
the \s-1CVS\s0 user (e.g. interch), unless otherwise specified.
.PP
A module is \s-1CVS\s0 is like the concept of a \*(L"project\*(R", where each module
has its own branches, trees, and other features.
.PP
Add your project to the \fImodules\fR configuration file
.PP
The format of the modules file is explained in detail in the cvs
documentation, here is the simplest way to use it:
.PP
.Vb 1
\& /rep/CVSROOT/modules:
.Ve
<Module name><\s-1TAB\s0><Module Directory>
.PP
The module name can be whatever you want, and the module directory is
what we will create later under /rep. We'll want a module for the
template catalog (foundation). For example:
.PP
.Vb 1
\& foundation foundation
.Ve
Create the module directory
.PP
This is the directory that is referred to in the \fICVSROOT/modules\fR
file we just modified.
.PP
.Vb 1
\& mkdir /rep/foundation
.Ve
.Sh "Setup binary file types"
.IX Subsection "Setup binary file types"
This isn't necessary if you aren't going to manage any binary files
(e.g. if you plan on excluding your /images/ directory). But I
recommend including it. The following is an example including many
binary file types (by extension) used in web development.
.PP
.Vb 1
\& /rep/CVSROOT/cvswrappers:
.Ve
*.avi \-k 'b' \-m '\s-1COPY\s0'
*.doc \-k 'b' \-m '\s-1COPY\s0'
*.exe \-k 'b' \-m '\s-1COPY\s0'
*.gif \-k 'b' \-m '\s-1COPY\s0'
*.gz \-k 'b' \-m '\s-1COPY\s0'
*.hqx \-k 'b' \-m '\s-1COPY\s0'
*.jar \-k 'b' \-m '\s-1COPY\s0'
*.jpeg \-k 'b' \-m '\s-1COPY\s0'
*.jpg \-k 'b' \-m '\s-1COPY\s0'
*.mov \-k 'b' \-m '\s-1COPY\s0'
*.mpg \-k 'b' \-m '\s-1COPY\s0'
*.pdf \-k 'b' \-m '\s-1COPY\s0'
*.png \-k 'b' \-m '\s-1COPY\s0'
*.ppt \-k 'b' \-m '\s-1COPY\s0'
*.sit \-k 'b' \-m '\s-1COPY\s0'
*.swf \-k 'b' \-m '\s-1COPY\s0'
*.tar \-k 'b' \-m '\s-1COPY\s0'
*.tgz \-k 'b' \-m '\s-1COPY\s0'
*.tif \-k 'b' \-m '\s-1COPY\s0'
*.tiff \-k 'b' \-m '\s-1COPY\s0'
*.xbm \-k 'b' \-m '\s-1COPY\s0'
*.xls \-k 'b' \-m '\s-1COPY\s0'
*.zip \-k 'b' \-m '\s-1COPY\s0'
.Sh "Testing your repository"
.IX Subsection "Testing your repository"
At this point, you should have a working (though empty) \s-1CVS\s0
repository. Before we continue with setting up the pserver or
importing source code, try logging in as one of the cvs users listed
in your CVSROOT/passwd and test the checkout.
.PP
.Vb 4
\& #test checkout in home directory of any cvs user
\&mkdir ~/src
\&cd ~/src
\&cvs co foundation
.Ve
This should create \fIfoundation/\fR and \fIfoundation/CVS\fR.
.Sh "Setup the \s-1CVS\s0 pserver"
.IX Subsection "Setup the CVS pserver"
You will likely need to be root to do this, and there are lots of
guides on the internet for setting up a cvs pserver, hopefully you
wont have any trouble doing it on your particular operating system.
See the \fIResources\fR Appendix for more information.
.PP
Setup pserver in Red Hat 7.1 using xinetd.
.PP
For Red Hat 7.x, edit \fI/etc/xinetd.d/cvspserver\fR (create a new one if
none exists). The following works for me, but customization may be
required for your environment (see the next section below for an
inetd-based system example). This also must be done as root.
.PP
.Vb 2
\& su - root
\&/etc/xinetd.d/cvspserver:
.Ve
# default: on
service cvspserver
{
disable = no
socket_type = stream
protocol = tcp
wait = no
user = root
server = /usr/bin/cvs
server_args = \-f \-\-allow-root=/rep pserver
.PP
}
.PP
Also unset the \s-1HOME\s0 variable in xinetd. This was required for my
repository to work correctly, but if anyone has a better suggestion, I
would appreciate a note.
.PP
.Vb 1
\& /etc/xinetd.d/cvspserver:
.Ve
unset \s-1HOME\s0
.PP
Now, restart xinetd for the changes to take effect.
.PP
.Vb 1
\& service xinetd restart
.Ve
Setup pserver in inetd-based systems.
.PP
I haven't tested this (any takers?), but something like the following
needs to be done for inetd-based systems such as Red Hat 6.2. Make
sure that the following files are setup accordingly.
.PP
.Vb 1
\& /etc/services:
.Ve
cvspserver 2401/tcp
N:/etc/inetd.conf:
.PP
cvspserver stream tcp nowait root /usr/sbin/tcpd /usr/local/bin/cvs \-\-allow-root=/usr/local/newrepos pserver
.PP
Testing your pserver
.PP
At this point, you should be able to use a cvs client to use your
pserver and execute all the same commands that you can locally (which
we tested before). You may wish to take advantage of a graphical cvs
client, which can be particularly helpful in leveling the learning
curve.
.PP
See the \fIResources\fR Appendix for links to some graphical \s-1CVS\s0 tools.
.SH "Import your Interchange catalog into CVS"
.IX Header "Import your Interchange catalog into CVS"
.Sh "Configuring your catalog"
.IX Subsection "Configuring your catalog"
Eventually, we will import your catalog into the cvs repository, but
first we need to do some work with a temporary copy of the catalog so
we can get it into shape for importing.
.PP
\&\fBNote: \fRFrom here on, assume the use of the interchange user, such as
interch, unless otherwise noted.
.PP
.Vb 1
\& su - interch
.Ve
If you installed via \s-1RPM:\s0
.PP
.Vb 1
\& service interchange stop
.Ve
If you installed via tarball (default path):
.PP
.Vb 1
\& /usr/local/interchange/bin/interchange --stop
.Ve
.Sh "Remove old \s-1CVS\s0 folders"
.IX Subsection "Remove old CVS folders"
If, for any reason, you already have \s-1CVS/\s0 directories in your
catalog, they must be removed because they might interfere with the
new \s-1CVS\s0 setup. For example, maybe you moved servers and you are
setting up \s-1CVS\s0 again. You might use the following find command,
which will find any folders named \s-1CVS\s0 in the current directory and
remove them. There is probably a better way to deal with old \s-1CVS/\s0
folders, but the following works for me (again, suggestions welcome).
.PP
\&\fBNote: \fRYou should make a backup of the catalog directory before you
do this.
.PP
#Become interchange catalog user
su \- interch
.PP
#backup catalog folder first
tar czf ~/foundation_backup.tgz /var/lib/interchange/foundation
.PP
#get rid of any old \s-1CVS\s0 folders \*(-- (\s-1BE\s0 \s-1CAREFULL\s0!)
cd /var/lib/interchange/foundation
find . \-name \s-1CVS\s0 \-exec rm \-Rf {} \e;
.Sh "Create a working copy of your catalog"
.IX Subsection "Create a working copy of your catalog"
A working copy of your catalog is necessary to get it into shape for
use with \s-1CVS\s0. The following command creates a copy in the /tmp
directory.
.PP
.Vb 2
\& cp -a /var/lib/interchange/foundation /tmp/import_foundation
\&cd /tmp/import_foundation
.Ve
.Sh "Streamline your catalog for \s-1CVS\s0"
.IX Subsection "Streamline your catalog for CVS"
Considerations about what to import into \s-1CVS\s0
.PP
From your working directory (/tmp/import_foundation), decide which
files will be in the \s-1CVS\s0 repository, and which will not. While it is
entirely possible to import the entire catalog into the repository
unchanged, I usually prefer to doctor my directories up before letting
them into my repository because of several reasons:
.Ip "\(bu" 4
Will the file be modified by another source?
.PP
For example, /etc/order.number is modified by interchange when run.
But not everyone will use a local development model that includes
running interchange on a directly checked-out copy of their source.
Which means this specific issue is avoided if you upload every edit
before viewing your changes on a server.
.Ip "\(bu" 4
The likelihood that you will modify the file.
.PP
For example, if I am certain that I wont every want to modify the
session/ files directly, then I probably wouldn't need to manage that
through \s-1CVS\s0, but I do import the empty session/ directory to make it
easier when setting up new catalogs.
.Ip "\(bu" 4
Speed.
.PP
Managing less files in the repository takes away from the amount of
time required for cvs checkout, update, branching, and other cvs
actions. For most, this amount of time is small already, but it is a
consideration for some.
.Ip "\(bu" 4
Ease of use.
.PP
Ease of use is one reason not to remove anything from your catalog
before importing it, because it creates the ability to have a
completely working catalog from just one checkout (much like the \s-1CVS\s0
tree at interchange.redhat.com). Whereas if you leave out other
directories like etc/ session/ orders/, etc., then you must first
combine your checkout with the other working parts of a catalog before
the catalog is viable. But this is slower and will bring up lots of
harmless notification and warning messages (about changed local
versions) if you run interchange on your local source copy (because
interchange will touch etc/ session/ orders/, etc. directly, and then
warn that your local copy has changed from the \s-1CVS\s0 copy). You may be
able to manage some of these notifications and warnings with
\&\fICVSROOT/cvsignore\fR or \f(CW$CVSIGNORE\fR, see the \fIResources\fR appendix
for more details.
.PP
Remove files that aren't needed in \s-1CVS\s0
.PP
Here is an example of some directories to remove. If you do move more
directories, be sure to move them to a directory that you can later
use to re-unite with a checked-out copy for a working catalog. But
here I chose just to move files that are not needed for a template
\&\*(L"skeleton\*(R" catalog.
.PP
The images directory is typically symlinked to
/var/www/html/foundation/images, so I remove this symlink from the
working copy, and replace it with an exact copy which will go into the
\&\s-1CVS\s0 repository.
.PP
.Vb 2
\& cd /tmp/import_foundation
\&mkdir /tmp/import_foundation_nonCVS
.Ve
#Setup images directory
rm images
cp \-a /var/www/html/foundation/images .
.PP
#Remove
mv error.log logs/* orders/* session/* tmp/* upload/* \e
/tmp/import_foundation_nonCVS
.Sh "Import the streamlined catalog"
.IX Subsection "Import the streamlined catalog"
Import the remaining portion of the catalog using the cvs import
command, with \*(L"foundation\*(R" as the module name and repository directory
name. See the \s-1CVS\s0 documentation resources mentioned in Appendix
\&\fIResources\fR for more information.
.PP
When you run the import command, it will launch \f(CW$EDITOR\fR (set to
\&'vi' earlier), and ask for a message to go along with the import
action. Whatever you see fit to write (e.g. \*(L"starting new cvs module
with my foundation catalog...\*(R") is fine.
.PP
This example import command includes renaming the foundation
\&\*(L"working\*(R" directory back to \*(L"foundation\*(R" for the import.
.PP
.Vb 3
\& su - interch
\&cd /tmp/import_foundation
\&cvs import foundation foundation start
.Ve
.Sh "Testing the new \s-1CVS\s0 module"
.IX Subsection "Testing the new CVS module"
Now you should be able to do another test checkout or update using any
\&\s-1CVS\s0 client, which should now download all the files that you have just
imported into \s-1CVS\s0. Additionally, you might test your newly imported
code by making a change to one of your checked-out source files,
saving it, then committing it.
.PP
.Vb 2
\& index.html:
\&<!--this is a test comment at the top of index.html-->
.Ve
Now commit the change
.PP
cvs commit index.html
.PP
Your changed version will now be resident in the repository. There
are a lot of good \s-1CVS\s0 documentation and resources for discovering more
about the checkout/update/commit cycle and other \s-1CVS\s0 aspects in the
\&\fIResources\fR Appendix.
.PP
You'll also notice that even if you start your interchange server, the
change you made did not take effect. The next section will detail the
process of tying \s-1CVS\s0 and Interchange together in a way that this will
happen automatically.
.SH "Integrate CVS and Interchange"
.IX Header "Integrate CVS and Interchange"
The next step is to allow \s-1CVS\s0 to update the directory that Interchange
uses to serve pages.
.Sh "\s-1CVS\s0 checkout into the catalog directory"
.IX Subsection "CVS checkout into the catalog directory"
Now it is the time to replace the directories in your catalog that
have counterparts in \s-1CVS\s0 with fresh checkouts from \s-1CVS\s0 (this is a
preliminary action to allow \s-1CVS\s0 to update your catalog directory when
a change is made to \s-1CVS\s0).
.PP
\&\fBNote: \fRMake sure interchange daemon is stopped and you have a good
backup before continuing.
.PP
tar czf ~/foundation.backup2.tgz /var/lib/interchange/foundation
.PP
Checkout a copy from \s-1CVS\s0 into a different directory (such as
\&\fIfoundation_CVS\fR).
.PP
.Vb 2
\& cd /var/lib/interchange/
\&cvs co -d foundation_CVS foundation
.Ve
This should create the \fIfoundation_CVS/\fR directory for you, so that
it wont conflict with your existing \fIfoundation/\fR directory.
.PP
Add any needed files to checked-out catalog
.PP
If you removed any directories during the streamlining step, we must
first add those back so that the catalog is usable to Interchange. In
this document, we only removed unneeded files and left empty
directories.
.PP
This can also be the time to copy any \*(L"data\*(R" files such as orders/
logs/, etc. that might be needed if it is a live catalog.
.PP
.Vb 3
\& cd /var/lib/interchange/foundation
\&cp -a <NEEDED_FILES> \e
\& /var/lib/interchange/foundation_CVS
.Ve
Install and test the new catalog
.PP
Now lets move the old \fIfoundation\fR out of the way and put the new
\&\fIfoundation_CVS\fR in its place.
.PP
.Vb 3
\& cd /var/lib/interchange/
\&mv foundation foundation_old
\&mv foundation_CVS foundation
.Ve
Now, link up the \s-1CVS\s0 images for use by Apache.
.PP
.Vb 3
\& cd /var/www/html/foundation/
\&mv images images_old
\&ln -s /var/lib/interchange/foundation/images images
.Ve
Now, you should have a working catalog again. To make sure, start up
interchange and test the site with your browser.
.Sh "Testing manual \s-1CVS\s0 updates on Interchange catalogs"
.IX Subsection "Testing manual CVS updates on Interchange catalogs"
Next, lets again update the checkout we made a while back before
importing our catalog. (Alternatively, one could use a visual \s-1CVS\s0
client detailed above).
.PP
.Vb 2
\& cd ~/src
\&cvs -q up -d foundation # -q for quiet, -d for directory prune/update
.Ve
Additionally, you might test making a change to one of your
checked-out source files, saving it, then committing it.
.PP
.Vb 2
\& index.html:
\&<!--this is a test comment at the top of index.html-->
.Ve
Now commit the change
.PP
.Vb 1
\& cvs commit index.html
.Ve
Your changed version will now be resident in the repository. Again,
\&\s-1CVS\s0 documentation is in the \fIResources\fR Appendix.
.PP
This time, we can allow the changes to take effect on the code being
used by interchange to server pages. To do so, one must run a cvs
update on the catalog directory:
.PP
.Vb 2
\& cd /var/lib/interchange/foundation
\&cvs -q up -d #up is the shortened version of "update"
.Ve
That should notify you of the new version it downloaded with something
like:
.PP
U pages/index.html
.PP
You may also get something like the following:
.PP
.Vb 5
\& M catalog.cfg
\&M etc/status.foundation
\&M ...
\&? orders/000001
\&? ...
.Ve
The ? lines in the above example mean that the \s-1CVS\s0 server has never
heard of the listed directories or files (they are in your local
source dir but not in the \s-1CVS\s0 source dir). It is harmless, but
sometimes annoying.
.PP
The M means that sthe file has been modified on your local copy,
and is out of sync with the remote \s-1CVS\s0 version (e.g. when Interchange
runs it updates \fIetc/status.foundation\fR). Normally this is corrected
by uploading your \*(L"modified\*(R" version to the server, but in this case,
the modification was done by Interchange instead of the programmer,
and wasn't meant to be committed back to the \s-1CVS\s0 repository. These
types of messages can be handled with \f(CW$CVSIGNORE\fR and
\&\f(CW$CVSROOT\fR/CVSROOT/cvsignore.
.PP
Now, check to make sure that your change has taken effect by
refreshing the homepage on the site. To see the comment, use
View->Page Source or whatever the relevant command for your
browser is.
.PP
At this point, its obvious that it would be time consuming to manually
run 'cvs up' every time you make a change to the source code, so the
next step is to setup \s-1CVS\s0 to automatically update the catalog whenever
you commit something to \s-1CVS\s0.
.Sh "Automatic updates on commit"
.IX Subsection "Automatic updates on commit"
Start by modifying \f(CW$CVSROOT\fR/CVSROOT/loginfo
.PP
.Vb 1
\& ^foundation (date; cat; (sleep 1; cd /var/lib/interchange/foundation; cvs -q update -d) &) >> $CVSROOT/CVSROOT/updatelog 2>&1
.Ve
The first line tells cvs that for every commit on modules that start
with \*(L"foundation\*(R" (notice the regular expression \*(L"^foundation\*(R"), it
will run cvs update on the given catalog directory in the
background. It is important that it is executed in a forked shell
(notice the \*(L"&\*(R") after sleep'ing for 1 second, because otherwise
you may run into contention issues that can cause file locking
problems. The 1 second timing used above works fine for me, but a
longer pause may be necessary for slower computers (you'll know if you
get errors about \*(L"file locked by user\*(R"). See the \s-1CVS\s0 documentation in
the \fIResources\fR Appendix for more details.
.Sh "Automatic e-mail on commit"
.IX Subsection "Automatic e-mail on commit"
Often it is very helpful to have a commit mailing list that keeps
developers up-to-date on every commit happening to the \s-1CVS\s0. To setup
automatic e-mails on every commit, put the following in
.PP
.Vb 1
\& /rep/CVSROOT/loginfo:
.Ve
\&\s-1ALL\s0 /usr/bin/cvs-log \f(CW$CVSROOT\fR/CVSROOT/commitlog \f(CW$USER\fR \*(L"%{sVv}\*(R"
.PP
This tells \s-1CVS\s0 to pipe the commit output to a shell script, which in
turn updates a log file and e-mails an update (typically to a mailing
list address). Create the shell script at \fI/usr/bin/cvs-log\fR that is
executable by the cvs user (using \*(L"chmod 755 /usr/bin/cvs-log\*(R").
.PP
.Vb 1
\& /usr/bin/cvs-log:
.Ve
#!/bin/sh
(echo \*(L"\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\*(R";
echo \-n \f(CW$2\fR\*(L" \*(R";
date;
echo;
cat) | tee \f(CW$1\fR | /usr/bin/Mail \-s \*(L"[foundation-cvs] \f(CW$3\fR\*(R" foundation-cvs@example.com
.PP
Your commit logs will now be archived in the CVSROOT/commitlog file
and e-mailed to the foundation-cvs@example.com address (which is
especially useful when you have a \fIMailserver for \s-1CVS\s0 updates\fR).
Here is what a sample e-mail looks like:
.PP
.Vb 1
\& Subject: [foundation-cvs] 'directory/subdirectory filename.c,1.7,1.8'
.Ve
\&\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
cvs Fri Mar 16 21:14:09 \s-1PST\s0 2001
Update of directory/subdirectory
In directory cvs.foundationsomething.com:/tmp/cvs-serv7721
Modified Files:
filename.c
Log Message:
test
.PP
Now you have a working \s-1CVS\s0 development system. At this point it may
be valuable to learn more about \s-1CVS\s0 the client tools that you are
using.
.SH "The two track model: development and live catalogs"
.IX Header "The two track model: development and live catalogs"
It is often very valuable to have a two-track development model that
separates the classes of work into separate timing and decision
categories. Some use \*(L"staging\*(R" and \*(L"production\*(R" terminology, others
prefer \*(L"unstable\*(R" and \*(L"stable\*(R", \*(L"beta\*(R" and \*(L"release\*(R", or \*(L"development\*(R"
and \*(L"live\*(R".
.PP
The easiest starting point for two-track development is to just use
two completely separate \s-1CVS\s0 modules and catalogs. This can make a lot
of sense for many situations, for example when the next revision of
the site will be so different that it is for all practical purposes
starting from ground zero.
.PP
A slightly more complicated solution is to use the \s-1CVS\s0 branches
feature. It is more difficult to set up, but can be rewarding when
used correctly.
.Sh "When to branch"
.IX Subsection "When to branch"
The first decision is when to branch the source code. For websites,
this can sometimes be an easy decision like \*(L"first went live\*(R", or
\&\*(L"site-wide overhaul\*(R", etc.
.Sh "Which way to branch"
.IX Subsection "Which way to branch"
There are many different ways to branch source code. What seems to be
the most common method is to use the \*(L"trunk\*(R", which is the \s-1HEAD\s0 tag to
\&\s-1CVS\s0 as the development version, and then make a branch when a stable
release is to be made.
.PP
That model doesn't fit my development style at the current time, so I
use the \s-1HEAD\s0 default branch as my stable live version, and use other
tags (like \s-1DEV1\s0 and \s-1DEV_REALLY_UNSTABLE\s0) for my development branch.
.PP
You may find that you are merging (or \*(L"folding\*(R") most or all of your
development branch back into your stable branch frequently. This is
because unlike traditional programming where products are launched
every two or three years with new features, web sites often have
little fixes and new features added every day or every few weeks, with
new \*(L"releases\*(R" happening more often than traditional software
development (though not all web sites follow that trend). The
flexibility is there to branch the source for quite some time to work
on a very complex feature or complete redesign before bringing it to
the live site, as well as the flexibility for day-to-day updates.
.Sh "Performing the branch"
.IX Subsection "Performing the branch"
To perform the branch use the \f(CW\*(C`cvs tag \-b <BRANCH NAME>\*(C'\fR command.
For example:
.PP
.Vb 1
\& cvs tag -b DEV1
.Ve
Remember that this does not change your locally checked out working
directory to the new tag automatically, it only creates the branch
within the \s-1CVS\s0 repository.
.Sh "Setup the development catalog"
.IX Subsection "Setup the development catalog"
Now we have a branch in \s-1CVS\s0, but we need to tie it to something in the
real world, namely, an Interchange catalog.
.PP
Importing the catalog
.PP
Like we did in \fIIntegrating \s-1CVS\s0 with Interchange\fR, you must make
another copy of your catalog for use as the development version. Some
would like to keep the orders/, logs/, and other directories the same,
but I prefer to start with a clean slate, especially since I don't
plan on having any customers visit the development site. (In fact,
you can restrict who can access the development \s-1URL\s0 using the Apache
\&\f(CW\*(C`<Directory> allow from...\*(C'\fR directive).
.PP
Checkout source code
.PP
.Vb 2
\& cd /var/lib/interchange
\&cvs co -d foundation_dev foundation
.Ve
Copy any other needed directories to complete the catalog
.PP
Depending on how complete your catalog is in \s-1CVS\s0, you may need to
create or copy directories/files.
.PP
.Vb 3
\& cd /var/lib/interchange/foundation
\&cp -a catalog.cfg orders/* \e
\& /var/lib/interchange/foundation_dev
.Ve
\&\fBNote: \fRA lot of the following steps are performed by the
/usr/local/interchange/bin/makecat script, but here is how to do it
manually:
.PP
Setting up a separate database
.PP
Most often, I find it profitable to make use of a second database for
the development catalog, rather than having both catalogs reference
the same database (especially if the first catalog is live).
.PP
Create a second database
.PP
Use the means of your database platform to create a separate database.
For example, PostgreSQL users might do something like:
.PP
createdb foundation_dev
.PP
Populate the database
.PP
You can rely on the catalogs internal products/*.txt data to generate
the database tables and populate them, or you can export another
catalog's database and import it for the development catalog, like the
example below for PostgreSQL users.
.PP
.Vb 2
\& pg_dump foundation > ~/foundation.dump
\&psql foundation_dev < ~/foundation.dump
.Ve
Copy the catalog support files
.PP
.Vb 2
\& #Must be root
\&su - root
.Ve
#Copy \s-1HTML\s0
cd /var/www/html/
cp \-a foundation foundation_dev
.PP
#Copy \s-1CGI\s0
cd /var/www/cgi-bin
cp \-a foundation foundation_dev
.PP
Configure the Interchange daemon
.PP
Perform the necessary modifications to \fIinterchange.cfg\fR. For
example:
.PP
.Vb 3
\& /usr/local/interchange/interchange.cfg:
\&Catalog foundation /var/lib/interchange/foundation /cgi-bin/foundation
\&Catalog foundation_dev /var/lib/interchange/foundation_dev /cgi-bin/foundation_dev
.Ve
Configure the catalog specifics
.PP
The development catalog will differ at least a little bit from the
standard catalog, such as in the \s-1CGI_URL\s0 and database parameters. You
can also modify/add the foundation_dev/variable.txt instead of the
following.
.PP
.Vb 5
\& /var/lib/interchange/catalog.cfg:
\&Variable CGI_URL /cgi-bin/foundation_dev
\&Variable IMAGE_DIR /foundation_dev/images
\&Variable SQLDSN dbi:Pg:dbname=foundation_dev
\&Variable SQLDB foundation_dev
.Ve
Now you can restart interchange to make your changes take effect.
.Sh "Splitting updates on commit by tag"
.IX Subsection "Splitting updates on commit by tag"
Setup \s-1CVS\s0 so that when you commit to the \s-1DEV1\s0 branch, only the
development (foundation_dev) catalog will be updated. And when you
commit with no tags (\s-1HEAD\s0 branch), the live (foundation) catalog
will be updated. Here is an example \fIloginfo\fR. The \f(CW\*(C`\-r <tag>\*(C'\fR
may be used just in case your environment is such that the tags may be
changed by other sources.
.PP
.Vb 3
\& $CVSROOT/CVSROOT/loginfo:
\&^foundation (date; cat; (sleep 1; cd /var/lib/interchange/foundation_dev; cvs -q up -d; cd /var/lib/interchange/foundation; cvs -q up -d) &) >> $CVSROOT/CVSROOT/updatelog 2>&1
\&ALL /usr/bin/cvs-log $CVSROOT/CVSROOT/commitlog $USER "%{sVv}"
.Ve
.Sh "Using new branches"
.IX Subsection "Using new branches"
To use your new branch, checkout a working copy of the source with the
correct tag specified. For example:
.PP
.Vb 1
\& cvs co -P -r DEV1
.Ve
Then make change to one of the files, and commit it. The change
should show on your development catalog, but not your live catalog.
.Sh "Merging"
.IX Subsection "Merging"
When you want to merge a change that you have made on your development
branch into your stable branch, there are many ways that you can do
it. One would be to :
.RS 4
.Ip "\(bu" 8
Make a change in the development branch (\s-1DEV1\s0) and commit it.
.Ip "\(bu" 8
Copy the development-tagged file to a temporary name
.Ip "\(bu" 8
Update to the live version (\s-1HEAD\s0)
.Ip "\(bu" 8
Overwrite the live (\s-1HEAD\s0) version of the file with your temporary one
.Ip "\(bu" 8
Commit the result
.Ip "\(bu" 8
Update back to the development version (\s-1DEV1\s0)
.RE
.RS 4
.RE
.PP
I do the above so often that I have written a \s-1TCL\s0 script for WinCVS
that will automatically perform the above steps. And similar shell
scripts can probably be easily written to match your development
environment.
.PP
The above seems to be the easiest way, to me. However, there are
other alternatives detailed in the \s-1CVS\s0 manual in chapter 5, \*(L"Branching
and merging\*(R", that I highly recommend for reading. One method
involves specifying the last version that has already been merged into
the live branch using a specific version number, date, relative time,
or special purpose tag.
.SH "Tools of the trade"
.IX Header "Tools of the trade"
This is the productivity tips section, which will hopefully help you
to be able to get more done in less time.
.Sh "Workstation interchange installation"
.IX Subsection "Workstation interchange installation"
Not all developers work on Linux workstations, many use Apples
(graphics designers and html gurus tend to, I've found), and many use
Windows. This means that many developers have the extra step of
uploading their changes to a Unix server where Interchange is running
in order to see their changes.
.PP
The remedy to that is to setup an interchange server on your
workstation, or any location that has direct access to the \s-1CVS\s0 source
files. I'll explain:
.PP
The interchange server that runs where the \s-1CVS\s0 server is (that we
setup earlier) can be seen as the gathering point for all the
developers. However, each developer may run as many interchange
daemons as he/she requires in a local context for the purpose of
seeing the changes made before uploading them via \s-1CVS\s0.
.PP
For example, Bob could setup another interchange catalog on the same
server as the \s-1CVS\s0, (e.g. foundation-bob). To get direct access to
those files (rather than \s-1FTP\s0), Bob could use \s-1NFS\s0 mounts (if Bob's
workstation is Linux) or \s-1SMB\s0 mounts using Samba if his workstation is
a Windows variant. Any way that Bob can get direct access to the
files will save him some time (by cutting out the \*(L"upload\*(R" from the
\&\*(L"edit->upload->test\*(R" development cycle). One could even use Vmware to
run a Linux server on your Windows workstation.
.PP
\&\fBNote: \fRYou can now use the cygwin compatibility confirmed in
Interchange versions 4.7.6 and above to run Interchange right on your
Windows workstation.
.PP
The result will be that you can modify the files with your favorite
text editor and see the results immediately through your local
catalog. Setting up the catalog initially is quite easy. Just follow
the same steps used to setup the \s-1CVS\s0 catalog. Which is:
.Ip "\(bu" 4
Stop interchange.
.Ip "\(bu" 4
bin/makecat a new catalog.
.Ip "\(bu" 4
Checkout from \s-1CVS\s0 into a new \s-1CVS\s0 catalog directory and link the
images/ directory.
.Ip "\(bu" 4
Move any needed files back into the \s-1CVS\s0 catalog directory.
.Ip "\(bu" 4
Make modifications to products/variable.txt and catalog.cfg (e.g.
\&\s-1CGI_URL\s0, \s-1HOSTNAME\s0, \s-1DBI_USER\s0, \s-1DBI_PASSWORD\s0).
.Ip "\(bu" 4
Restart interchange.
.PP
One aspect of this local configuration is managing the differences
between the main interchange daemon which runs on the \s-1CVS\s0 server and
the local interchange daemon. The differences are probably hostname,
database information, etc. That will all need to be managed (usually
through catalog.cfg entries) and database exports & imports (i.e. the
postgres pg_dump command).
.PP
Another thing that you might have noticed at this point is all the
files that are modified locally by the interchange daemon will report
? or M when you run an update. This can be handled with
\&\fICVSROOT/cvsignore\fR and \f(CW$CVSIGNORE\fR, which are beyond the scope of
this document.
.Sh "Mailserver for \s-1CVS\s0 updates"
.IX Subsection "Mailserver for CVS updates"
To setup a mailserver for \s-1CVS\s0 updates, first download and install
mailman. For Red Hat systems, the following \s-1RPM\s0 could be used:
.Ip "\(bu" 4
the section on "/speakeasy.rpmfind.net/linux/redhat/7.1/en/powertools/i386/RedHat/RPMS//mailman-2.0.1-2.i386.rpm" in the ftp: manpage
.PP
After installing, read the following information about Mailman and
what needs to be done after installation (taken from the \s-1RPM\s0 meta
data):
.PP
"Mailman is software to help manage email discussion lists, much like
Majordomo and Smartmail. Unlike most similar products, Mailman gives
each mailing list a web page, and allows users to subscribe,
unsubscribe, etc. over the web. Even the list manager can administer
his or her list entirely from the web. Mailman also integrates most
things people want to do with mailing lists, including archiving, mail
<\-> news gateways, and so on.
.PP
When the package has finished installing, you will need to:
.Ip "\(bu" 4
Run \fI/var/mailman/bin/mmsitepass\fR to set the mailman administrator
password.
.Ip "\(bu" 4
Edit \fI/var/mailman/Mailman/mm_cfg.py\fR to customize mailman's
configuration for your site.
.Ip "\(bu" 4
Modify the sendmail configuration to ensure that it is running and
accepting connections from the outside world (to ensure that it runs,
set \*(L"DAEMON=yes\*(R" in /etc/sysconfig/sendmail, ensuring that it accepts
connections from the outside world may require modifying
/etc/mail/sendmail.mc and regenerating sendmail.cf), and
.Ip "\(bu" 4
Add these lines:
.Sp
.Vb 1
\& ScriptAlias /mailman/ /var/mailman/cgi-bin/
.Ve
.PP
to \fI/etc/httpd/conf/httpd.conf\fR to configure your web server.
.PP
Users upgrading from previous releases of this package may need to
move their data or adjust the configuration files to point to the
locations where their data is."
.PP
Then run /var/mailman/bin/newlist and follow the directions from
there.
.Sh "Locally mapped source code for a network \s-1IC\s0 server"
.IX Subsection "Locally mapped source code for a network IC server"
This is useful mostly to Windows users, since Linux users can just as
easily run \s-1IC\s0 daemons on their own workstation as they can a separate
server.
.PP
The idea is to have the \s-1IC\s0 server use its own files and directories
for things that won't be edited and modified locally, but reference a
samba directory or \s-1NFS\s0 directory for things that will (such as
\&\fIpages/\fR, \fItemplates/\fR, etc.).
.PP
Mount the samba or \s-1NFS\s0 directory
.PP
\&\f(CW\*(C`smbmount <...>\*(C'\fR or \f(CW\*(C`mount \-t nfsfs <...>\*(C'\fR
.PP
The following script uses two directories (source and destination) to
create symlinks for the commonly modified source directories of
Interchange.
.PP
.Vb 9
\& export S=/mnt/nfs/foundation
\&export D=/var/lib/interchange/foundation
\&F=db; ln -s $S/$F $D/$F
\&F=dbconf; ln -s $S/$F $D/$F
\&F=etc; ln -s $S/$F $D/$F
\&F=images; ln -s $S/$F $D/$F
\&F=pages; ln -s $S/$F $D/$F
\&F=special_pages; ln -s $S/$F $D/$F
\&F=templates; ln -s $S/$F $D/$F
.Ve
This will leave you with a working catalog that can be quickly
modified (since your editor can access the local copy), while
interchange has to do the work of going over the \s-1SMB\s0 or \s-1NFS\s0
connection.
.Sh "jEdit \- a good editor with Interchange/HTML/perl colorization and \s-1CVS\s0"
.IX Subsection "jEdit - a good editor with Interchange/HTML/perl colorization and CVS"
I have been quite impressed with jEdit (the section on "/www.jedit.org" in the http: manpage, and
open source editor that is written in java and runs on most platforms.
.PP
I use the interchange.xml language definition written by Chris
Jesseman \fIchris@sitemajic.net\fR, which is available from
the section on "/www.sitemajic.net/jedit/" in the http: manpage. With this, jEdit automatically
colors \s-1HTML\s0, perl, \s-1AND\s0 many interchange tags very intelligently.
.PP
Further, jEdit has a \s-1CVS\s0 plugin, written by Ben Sarsgard
\&\fIbsarsgard@vmtllc.com\fR, and available at:
the section on "/www.vmtllc.com/~bsarsgard/jedit.html" in the http: manpage. This plugin allows
you to diff, update, and commit right from the editor.
.Sh "Seperate servers for development and live catalogs"
.IX Subsection "Seperate servers for development and live catalogs"
If you have the luxury of seperate server ardware for the development
and live catalogs, you might find the following utility helpful:
.Ip "\(bu" 4
CVSviaFTP (the section on "/www.cvshome.org/dev/addoncvsftp.html" in the http: manpage) \- from the
\&\s-1CVS\s0 Add-ons page (the section on "/www.cvshome.org/dev/addons.html" in the http: manpage).
.PP
It allows one to have a given \s-1CVS\s0 module automatically publish each
update to an \s-1FTP\s0 server, which could serve as the live server. Or one
could could use it if your \s-1CVS\s0 installation is only local and you
could use it to upload your changes to your production server.
.PP
Credits
.Ip "\(bu" 4
\&\fBJon Jensen\fR: Thanks for helping me get going on the \s-1SDF\s0 format
already used by the Interchange documentation, and fixing some \s-1SDF\s0
syntax errors.
.Ip "\(bu" 4
\&\fBMike Heins & all who have contributed to the success of
Interchange\fR: Thanks for following the Way Of The Source, for quality
programming, and for helping to making \s-1IC\s0 something to write about.
.Ip "\(bu" 4
Thanks to the countless others who have written the \s-1CVS\s0 documentation
that is available online, which was my only source for learning \s-1CVS\s0.
.PP
Document history
.Ip "\(bu" 4
May 2001. Conceived and written by Dan Browning.
.Ip "\(bu" 4
July 19, 2001. First draft complete, first public release.
.PP
Resources
.PP
\&\s-1CVS\s0 Documentation
.PP
Here are some resources for learning more about \s-1CVS\s0. I have ranked
them by the order of usefulness, which is of course, objective.
.Ip "\(bu" 4
Karl Fogel's \s-1CVS\s0 book the section on "/cvsbook.red-bean.com/" in the http: manpage
.Ip "\(bu" 4
The official \s-1CVS\s0 manual the section on "/www.cvshome.org/docs/manual/" in the http: manpage
.Ip "\(bu" 4
The official \s-1CVS\s0 \s-1FAQ\s0 the section on "/faq.cvshome.org/" in the http: manpage
.Ip "\(bu" 4
The official \s-1CVS\s0 homepage the section on "/www.cvshome.org" in the http: manpage
.Ip "\(bu" 4
Info-CVS mailing list the section on "/mail.gnu.org/mailman/listinfo/info-cvs" in the http: manpage
.Ip "\(bu" 4
\&\s-1CVS\s0 \s-1FAQ\s0 2 the section on "/www.cs.utah.edu/dept/old/texinfo/cvs/FAQ.txt" in the http: manpage
.Ip "\(bu" 4
Sean Dreilinger's \s-1CVS\s0 Version Control for Web Site Projects
the section on "/durak.org/cvswebsites/" in the http: manpage
.Ip "\(bu" 4
Pascal Molli's \s-1CVS\s0 reference site
the section on "/www.loria.fr/~molli/cvs-index.html" in the http: manpage
.Ip "\(bu" 4
\&\s-1CVS\s0 Tutorial
the section on "/cellworks.washington.edu/pub/docs/cvs/tutorial/cvs_tutorial_1.html" in the http: manpage
.Ip "\(bu" 4
\&\s-1CVS\s0 Tutorial 2
the section on "/www.csc.calpoly.edu/~dbutler/tutorials/winter96/cvs/" in the http: manpage
.Ip "\(bu" 4
RedHat \s-1CVS\s0 pserver setup guide the section on "/www.michael-amorose.com/cvs/" in the http: manpage
.Ip "\(bu" 4
\&\s-1CVS\s0 Add-ons the section on "/www.cvshome.org/dev/addons.html" in the http: manpage
.PP
\&\s-1CVS\s0 Server Software
.Ip "\(bu" 4
\&\s-1CVS\s0 \s-1RPM\s0 download (Red Hat 7.1)
the section on "/speakeasy.rpmfind.net/linux/redhat/7.1/en/os/i386/RedHat/RPMS/cvs-1.11-3.i386.rpm" in the ftp: manpage
.Ip "\(bu" 4
Source tarballs links can can be found at cvshome.org.
.PP
\&\s-1CVS\s0 Client Software
.PP
There are a variety of client access methods for using cvs on your
development box.
.Ip "\(bu" 4
There are some great graphical clients for Linux, Windows, and Mac at
the section on "/www.cvsgui.org" in the http: manpage. These also give you the same access to all
the command line cvs commands.
.Ip "\(bu" 4
jCVS is a great cross-platform graphical cvs client available at
the section on "/www.jcvs.org" in the http: manpage.
.Ip "\(bu" 4
jEdit is a great cross-platform text editor written in java, which not
only has a \s-1CVS\s0 module that allows you to commit (upload) files
directly from the editor, but also has a interchange markup language
(and perl language) colorizer/parser. It is available from
the section on "/www.jedit.org" in the http: manpage.
.PP
.Vb 1
\& ________________________________________
.Ve
Copyright 2001 Dan Browning <danpb@mail.com>. Freely redistributable
under terms of the \s-1GNU\s0 General Public License.
|