[docs] docs - danb modified 3 files
docs@interchange.redhat.com
docs@interchange.redhat.com
Sat Jun 8 15:16:00 2002
User: danb
Date: 2002-06-08 19:15:41 GMT
Modified: . ic_howto_cvs.sdf icfaq.sdf ictags.sdf
Log:
Documentation updates:
* Tags:
- 2 example code typos
- 'fortune' tag documented.
* FAQ: New FAQ's added:
- 'make not found'
- 'What does the mv_pc variable mean?'
* IC + CVS HOWTO:
- Switching from soft word-wrap to hard word-wrap (@ 80 chars) for easier reading of diffs.
- E-mail update
- Bring up to date with 2002.
- Path fixes.
- Other minor updates.
Revision Changes Path
1.10 +489 -180 docs/ic_howto_cvs.sdf
rev 1.10, prev_rev 1.9
Index: ic_howto_cvs.sdf
===================================================================
RCS file: /var/cvs/docs/ic_howto_cvs.sdf,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ic_howto_cvs.sdf 12 Apr 2002 22:53:18 -0000 1.9
+++ ic_howto_cvs.sdf 8 Jun 2002 19:15:41 -0000 1.10
@@ -1,67 +1,101 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: ic_howto_cvs.sdf,v 1.9 2002/04/12 22:53:18 jon Exp $
+# $Id: ic_howto_cvs.sdf,v 1.10 2002/06/08 19:15:41 danb Exp $
!define DOC_NAME "Interchange + CVS HOWTO"
!define DOC_TYPE ""
!define DOC_CODE "ic_howto_cvs"
-!define DOC_VERSION substr('$Revision: 1.9 $', 11, -2)
+!define DOC_VERSION substr('$Revision: 1.10 $', 11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
-!define DOC_URL "http://interchange.redhat.com/doc/ic_howto_cvs.html"
-!define DOC_OWNER "2001 Dan Browning E<lt>{{EMAIL:danpb@mail.com}}E<gt>"
+!define DOC_URL "http://www.icdevgroup.org/doc-4.8/ic_howto_cvs.html"
+!define DOC_OWNER "2001 Dan Browning E<lt>{{EMAIL:dan.browning@kavod.com}}E<gt>"
!build_title
H1:Introduction
H2:Preamble
-N:Copyright 2001 Dan Browning <danpb@mail.com>. This document is freely redistributable under terms of the GNU General Public License.
+N:Copyright 2001,2002 Dan Browning <dan.browning@kavod.com>. This document is
+freely redistributable under terms of the GNU General Public License.
H2:Purpose
-N:The purpose of this document is to help others take advantage of CVS 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 HTML design gurus. Portions of it apply to general CVS setup and use, but it is geared toward the average developer using Interchange to implement an e-commerce website.
+N:The purpose of this document is to help others take advantage of CVS 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 HTML design gurus. Portions of it apply to general CVS setup and use, but
+it is geared toward the average developer using Interchange to implement an
+e-commerce website.
H2:Audience
-N:I intend for this document to be useful to those who are not yet familiar with CVS as well as those who are. If you already know how to setup a pserver then you might just skim chapter 2 ("Setup CVS"), or skip it all together.
-
-N:In addition, I have tried to write at a technical level that would be on par with what I perceive 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.
+N:I intend for this document to be useful to those who are not yet familiar
+with CVS as well as those who are. If you already know how to setup a pserver
+then you might just skim chapter 2 ("Setup CVS"), or skip it all together.
+
+N:In addition, I have tried to write at a technical level that would be on par
+with what I perceive 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 (e.g. Foundation) is
+working correctly.
H2:Contact the author
-N:If you find any spelling errors, technical slip-ups, 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.
-
-N:The preferred method of submitting changes is in the form of a context diff against the SDF source file (ic_cvs.sdf). Please address your correspondence to:
+N:If you find any spelling errors, technical slip-ups, 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.
+
+N:The preferred method of submitting changes is in the form of a context diff
+against the SDF source file (ic_cvs.sdf). Please address your correspondence
+to:
-N:Dan Browning {{EMAIL:danpb@mail.com}}
+N:Dan Browning {{EMAIL:dan.browning@kavod.com}}
H2:The advantages of using CVS
-N:CVS 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.
+N:CVS 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.
*What is CVS all about?
*What are its advantages?
-N:The official CVS website ({{URL:http://www.cvshome.org/new_users.html}}) has more detailed answers to these questions, but here are some brief points of interest.
+N:The official CVS website ({{URL:http://www.cvshome.org/new_users.html}}) has
+more detailed answers to these questions, but here are some brief points of
+interest.
-*Checkout "historic" points in time or milestones in a project, for example when an e-commerce site went "live" or before a major branch in the code.
+*Checkout "historic" points in time or milestones in a project, for example
+when an e-commerce site went "live" or before a major branch in the code.
*Revert to older versions of a file, directory, or an entire website.
-*Branching releases. Concurrently develop an unstable development version as well as fix bugs in the stable production version.
-
-*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 {{SECT:Resources}} Appendix).
-
-*CVS 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).
-
-*CVS can automatically merge two simultaneous writes to the same file by different developers.
+*Branching releases. Concurrently develop an unstable development version as
+well as fix bugs in the stable production version.
-*Allows one to keep track of the changes that have been made over time (many release managers repackage CVS commit logs into WHATSNEW, HISTORY, and/or NEWS files).
+*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 {{SECT:Resources}}
+Appendix).
+
+*CVS 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).
+
+*CVS can automatically merge two simultaneous writes to the same file by
+different developers.
+
+*Allows one to keep track of the changes that have been made over time (many
+release managers repackage CVS commit logs into WHATSNEW, HISTORY, and/or NEWS
+files).
H2:How to use this document
-N:There are many potential uses of CVS as it applies to Interchange. In fact, there are as many unique ways to use CVS as there are unique developers. This document only covers some of the ways, including basic and useful techniques to get started using CVS. For the intents of the average web developer using IC for a B2C e-commerce site, I've identified a few of the possible uses:
+N:There are many potential uses of CVS as it applies to Interchange. In fact,
+there are as many unique ways to use CVS as there are unique developers. This
+document only covers some of the ways, including basic and useful techniques to
+get started using CVS. For the intents of the average web developer using IC
+for a B2C e-commerce site, I've identified a few of the possible uses:
N:Simple
*One server
@@ -74,44 +108,60 @@
*Two CVS modules
*Separate development and live branches
N:Complex/Custom
- *Multiple servers (e.g., developers' servers, staging servers, and live servers)
+ *Multiple servers (e.g., developers' servers, staging servers, and live
+ servers)
*Multiple catalogs
*Multiple CVS modules
*Multiple branches
*Custom setup
-N: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.
+N:This document attempts to cover the simple well, explain many aspects of the
+medium, and hopefully give you the background you need if you decide to setup
+your own complex development environment.
H1:Setup CVS
H2:Assumptions
-N:Here are some of the assumptions that I make that apply to various parts of the rest of this document:
+N:Here are some of the assumptions that I make that apply to various parts of
+the rest of this document:
*Red Hat Linux 7.x
*Interchange installed (RPM or tarball)
-*Default Interchange tarball installation directory paths (adjust for your environment)
+*Default Interchange tarball installation directory paths (adjust for your
+environment)
*Template catalog setup and working
-Note:I will assume "foundation" 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.
-
-N:There shouldn't be any reason why you could not do everything I mention here on other Linux distributions, Unices or Windows (using cygwin). However, my statements will reflect Red Hat Linux 7.x. Additionally, Red Hat Linux 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.
+Note:I will assume "foundation" for the catalog name and directory paths, but
+it should be just as easy to use this document with your own catalog by
+mentally transposing the names and paths.
+
+N:There shouldn't be any reason why you could not do everything I mention here
+on other Linux distributions, Unices or Windows (using cygwin). However, my
+statements will reflect Red Hat Linux 7.x. Additionally, Red Hat Linux 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.
H2:Install CVS
-N:This is the easy part. For Red Hat Linux systems, download the CVS rpms and install them. The following RPM command will download and install the Red Hat 7.1 version of CVS from rpmfind.net.
-
-Note:You need to be root to complete the following tasks
-
-!block example;
-su - root
-rpm -Uvh ftp://speakeasy.rpmfind.net/linux/redhat/7.1/en/os/i386/RedHat/RPMS/cvs-1.11-3.i386.rpm
-!endblock
-
-N: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 its group or vice-versa. The integration of Interchange and CVS in the latter portion of this document will require that the CVS user can write to the catalog directory.
+N:This is the easy part. For Red Hat Linux systems, download the CVS rpms and
+install them. You can search for rpms for your system using
+{{URL:http://www.rpmfind.net}}.
+
+N: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 its group or vice-versa. The integration of
+Interchange and CVS in the latter portion of this document will require that
+the CVS user can write to the catalog directory.
H2:Create the CVS repository directory
-N:You will need to create a repository directory such as {{F:/rep}}, 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 {{F:/var/rep}} or {{F:/home/cvs/rep}}.
+N:You will need to create a repository directory such as {{F:/rep}}, 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 {{F:/var/rep}} or
+{{F:/home/cvs/rep}}.
!block example;
su - root
@@ -121,7 +171,9 @@
H2:Setup environment variables
-N:The CVSROOT and EDITOR environment variables should be setup for all users in /etc/profile. Of course, EDITOR can be whatever Unix text editor you prefer, such as {{F:vi}}, {{F:emacs}}, {{F:pico}}, or {{F:joe}}.
+N:The CVSROOT and EDITOR environment variables should be setup for all users in
+/etc/profile. Of course, EDITOR can be whatever Unix text editor you prefer,
+such as {{F:vi}}, {{F:emacs}}, {{F:pico}}, or {{F:joe}}.
!block example;
{{B:/etc/profile:}}
@@ -134,7 +186,8 @@
H2:Initialize the repository
-N:Initialize the repository as the CVS user, which is {{EX:interch}} for this document.
+N:Initialize the repository as the CVS user, which is {{EX:interch}} for this
+document.
!block example;
su - interch
@@ -145,32 +198,44 @@
H3:Background
-N:Authentication is done in CVS through the {{F:$CVSROOT/CVSROOT/passwd}} file. It can be easily manipulated through some of the CVS administration tools that are available.
+N:Authentication is done in CVS through the {{F:$CVSROOT/CVSROOT/passwd}} file.
+It can be easily manipulated through some of the CVS administration tools that
+are available.
H3:CVS administration tools
*{{URL:http://freshmeat.net/projects/cvsadmin/}}
*{{URL:http://freshmeat.net/projects/cvspadm/}}
-N: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 CVS. For more information on this manual method, see the Red Hat CVS pserver setup guide by Michael Amorose ({{URL:http://www.michael-amorose.com/cvs/}}).
+N: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 CVS. For more information on this
+manual method, see the Red Hat CVS pserver setup guide by Michael Amorose
+({{URL:http://www.michael-amorose.com/cvs/}}).
H3:Setup authentication using the cvsadmin tool
-N:You can find a tarball to install on your system using the above address, but here is the address of a recent RPM package of the version. This package is intended for Mandrake systems, but is compatible with Red Hat Linux 7.1:
+N:You can find a tarball to install on your system using the above address, but
+here is the address of a recent RPM package of the version. This package is
+intended for Mandrake systems, but is compatible with Red Hat Linux 7.1:
*{{URL:ftp://speakeasy.rpmfind.net/linux/Mandrake-devel/contrib/RPMS/cvsadmin-1.0.1-1mdk.i586.rpm}}
-N:After installing, create a password file ({{touch $CVSROOT/CVSROOT/passwd}}), and execute {{EX:cvsadmin add <usernames>}}.
+N:After installing, create a password file ({{touch $CVSROOT/CVSROOT/passwd}}),
+and execute {{EX:cvsadmin add <usernames>}}.
H2:Setup CVS modules
-Note:From this point on, assume that all commands are executed as the CVS user (e.g. interch), unless otherwise specified.
+Note:From this point on, assume that all commands are executed as the CVS user
+(e.g. interch), unless otherwise specified.
-N:A module is CVS is like the concept of a "project", where each module has its own branches, trees, and other features.
+N:A module is CVS is like the concept of a "project", where each module has its
+own branches, trees, and other features.
H3:Add your project to the {{F:modules}} configuration file
-N:The format of the modules file is explained in detail in the CVS documentation, here is the simplest way to use it:
+N:The format of the modules file is explained in detail in the CVS
+documentation, here is the simplest way to use it:
!block example;
{{B:/rep/CVSROOT/modules:}}
@@ -178,19 +243,25 @@
<Module name><TAB><Module Directory>
!endblock
-N: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:
+N: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:
E:foundation foundation
H3:Create the module directory
-N: This is the directory that is referred to in the {{F:CVSROOT/modules}} file we just modified.
+N: This is the directory that is referred to in the {{F:CVSROOT/modules}} file
+we just modified.
E:mkdir /rep/foundation
H2:Setup binary file types
-N: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.
+N: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.
!block example;
{{B:/rep/CVSROOT/cvswrappers:}}
@@ -222,7 +293,10 @@
H2:Testing your repository
-N:At this point, you should have a working (though empty) CVS 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.
+N:At this point, you should have a working (though empty) CVS 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.
!block example;
#test checkout in home directory of any cvs user
@@ -235,11 +309,17 @@
H2:Setup the CVS pserver
-N: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 {{SECT:Resources}} Appendix for more information.
+N: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 {{SECT:Resources}}
+Appendix for more information.
H3:Setup pserver in Red Hat Linux 7.1 using xinetd.
-N:For Red Hat Linux 7.x, edit {{F:/etc/xinetd.d/cvspserver}} (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.
+N:For Red Hat Linux 7.x, edit {{F:/etc/xinetd.d/cvspserver}} (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.
!block example;
su - root
@@ -255,11 +335,12 @@
user = root
server = /usr/bin/cvs
server_args = -f --allow-root=/rep pserver
-
}
!endblock
-N:Also unset the HOME variable in xinetd. This was required for my repository to work correctly, but if anyone has a better suggestion, I would appreciate a note.
+N:Also unset the HOME variable in xinetd. This was required for my repository
+to work correctly, but if anyone has a better suggestion, I would appreciate a
+note.
!block example;
{{B:/etc/xinetd.d/cvspserver:}}
@@ -273,7 +354,8 @@
H3:Setup pserver in inetd-based systems.
-N:For inetd-based systems such as Red Hat Linux 6.2, make sure that the following files are setup accordingly.
+N:For inetd-based systems such as Red Hat Linux 6.2, make sure that the
+following files are setup accordingly.
!block example;
{{B:/etc/services:}}
@@ -284,12 +366,15 @@
!block example;
N:{{B:/etc/inetd.conf:}}
-cvspserver stream tcp nowait root /usr/sbin/tcpd /usr/local/bin/cvs --allow-root=/usr/local/newrepos pserver
+cvspserver stream tcp nowait root /usr/sbin/tcpd /usr/bin/cvs --allow-root=/rep pserver
!endblock
H3:Testing your pserver
-N: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.
+N: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.
N:See the {{SECT:Resources}} Appendix for links to some graphical CVS tools.
@@ -297,9 +382,12 @@
H2:Configuring your catalog
-N: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.
+N: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.
-Note:From here on, assume the use of the Interchange user, such as {{EX:interch}}, unless otherwise noted.
+Note:From here on, assume the use of the Interchange user, such as
+{{EX:interch}}, unless otherwise noted.
E:su - interch
@@ -313,7 +401,13 @@
H2:Remove old CVS folders
-N:If, for any reason, you already have {{EX:CVS/}} directories in your catalog, they must be removed because they might interfere with the new CVS setup. For example, maybe you moved servers and you are setting up CVS again. You might use the following {{EX:find}} command, which will find any folders named {{EX:CVS}} in the current directory and remove them. There is probably a better way to deal with old {{EX:CVS/}} folders, but the following works for me (again, suggestions welcome).
+N:If, for any reason, you already have {{EX:CVS/}} directories in your catalog,
+they must be removed because they might interfere with the new CVS setup. For
+example, maybe you moved servers and you are setting up CVS again. You might
+use the following {{EX:find}} command, which will find any folders named
+{{EX:CVS}} in the current directory and remove them. There is probably a
+better way to deal with old {{EX:CVS/}} folders, but the following works for me
+(again, suggestions welcome).
Note:You should make a backup of the catalog directory before you do this.
@@ -332,7 +426,8 @@
H2:Create a working copy of your catalog
-N:A working copy of your catalog is necessary to get it into shape for use with CVS. The following command creates a copy in the {{EX:/tmp}} directory.
+N:A working copy of your catalog is necessary to get it into shape for use with
+CVS. The following command creates a copy in the {{EX:/tmp}} directory.
!block example;
cp -a /var/lib/interchange/foundation /tmp/import_foundation
@@ -343,31 +438,61 @@
H3:Considerations about what to import into CVS
-N:From your working directory ({{EX:/tmp/import_foundation}}), decide which files will be in the CVS 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:
+N:From your working directory ({{EX:/tmp/import_foundation}}), decide which
+files will be in the CVS 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:
*Will the file be modified by another source?
-N:For example, {{EX:/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.
+N:For example, {{EX:/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.
*The likelihood that you will modify the file.
-N: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 CVS, but I do import the empty session/ directory to make it easier when setting up new catalogs.
+N: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 CVS, but I
+do import the empty session/ directory to make it easier when setting up new
+catalogs.
*Speed.
-N: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.
+N: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.
*Ease of use.
-N: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 CVS 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 CVS copy). You may be able to manage some of these notifications and warnings with {{F:CVSROOT/cvsignore}} or {{EX:$CVSIGNORE}}, see the {{SECT:Resources}} appendix for more details.
+N: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 CVS 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 CVS copy). You may be able to
+manage some of these notifications and warnings with {{F:CVSROOT/cvsignore}} or
+{{EX:$CVSIGNORE}}, see the {{SECT:Resources}} appendix for more details.
+
#TODO:CVSIGNORE
H3:Remove files that aren't needed in CVS
-N: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 "skeleton" catalog.
-
-N: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 CVS repository.
+N: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 "skeleton" catalog.
+
+N: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 CVS repository.
!block example;
cd /tmp/import_foundation
@@ -384,11 +509,18 @@
H2:Import the streamlined catalog
-N:Import the remaining portion of the catalog using the {{EX:cvs import}} command, with "foundation" as the module name and repository directory name. See the CVS documentation resources mentioned in Appendix {{SECT:Resources}} for more information.
-
-N:When you run the import command, it will launch $EDITOR (set to {{EX:'vi'}} earlier), and ask for a message to go along with the import action. Whatever you see fit to write (e.g. "starting new CVS module with my foundation catalog...") is fine.
+N:Import the remaining portion of the catalog using the {{EX:cvs import}}
+command, with "foundation" as the module name and repository directory name.
+See the CVS documentation resources mentioned in Appendix {{SECT:Resources}}
+for more information.
+
+N:When you run the import command, it will launch $EDITOR (set to {{EX:'vi'}}
+earlier), and ask for a message to go along with the import action. Whatever
+you see fit to write (e.g. "starting new CVS module with my foundation
+catalog...") is fine.
-N:This example {{EX:import}} command includes renaming the foundation "working" directory back to "foundation" for the import.
+N:This example {{EX:import}} command includes renaming the foundation "working"
+directory back to "foundation" for the import.
!block example;
su - interch
@@ -398,7 +530,11 @@
H2:Testing the new CVS module
-N:Now you should be able to do another test checkout or update using any CVS client, which should now download all the files that you have just imported into CVS. 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.
+N:Now you should be able to do another test checkout or update using any CVS
+client, which should now download all the files that you have just imported
+into CVS. 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.
+
!block example;
{{B:index.html:}}
<!--this is a test comment at the top of index.html-->
@@ -408,38 +544,54 @@
{{EX:cvs commit index.html}}
-N:Your changed version will now be resident in the repository. There are a lot of good CVS documentation and resources for discovering more about the checkout/update/commit cycle and other CVS aspects in the {{SECT:Resources}} Appendix.
-
-N: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 CVS and Interchange together in a way that this will happen automatically.
+N:Your changed version will now be resident in the repository. There are a lot
+of good CVS documentation and resources for discovering more about the
+checkout/update/commit cycle and other CVS aspects in the {{SECT:Resources}}
+Appendix
+
+N: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 CVS and Interchange together in a way that this will happen automatically.
H1:Integrate CVS and Interchange
-N:The next step is to allow CVS to update the directory that Interchange uses to serve pages.
+N:The next step is to allow CVS to update the directory that Interchange uses
+to serve pages.
H2:CVS checkout into the catalog directory
-N:Now it is the time to replace the directories in your catalog that have counterparts in CVS with fresh checkouts from CVS (this is a preliminary action to allow CVS to update your catalog directory when a change is made to CVS).
+N:Now it is the time to replace the directories in your catalog that have
+counterparts in CVS with fresh checkouts from CVS (this is a preliminary action
+to allow CVS to update your catalog directory when a change is made to CVS).
-Note:Make sure interchange daemon is stopped and you have a good backup before continuing.
+Note:Make sure interchange daemon is stopped and you have a good backup before
+continuing.
{{EX:tar czf ~/foundation.backup2.tgz /var/lib/interchange/foundation}}
-N:Checkout a copy from CVS into a different directory (such as {{F:foundation_CVS}}).
+N:Checkout a copy from CVS into a different directory (such as
+{{F:foundation_CVS}}).
!block example;
cd /var/lib/interchange/
cvs co -d foundation_CVS foundation
!endblock
-N:This should create the {{F:foundation_CVS/}} directory for you, so that it wont conflict with your existing {{F:foundation/}} directory.
+N:This should create the {{F:foundation_CVS/}} directory for you, so that it
+wont conflict with your existing {{F:foundation/}} directory.
H3:Add any needed files to checked-out catalog
-Note that empty directories are pruned, so they will need something in them for them to show up with a -P checkout. Often a zero-byte file called '.empty' is used.
-
-N: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.
+Note that empty directories are pruned, so they will need something in them for
+them to show up with a -P checkout. Often a zero-byte file called '.empty' is
+used.
+
+N: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.
-N:This can also be the time to copy any "data" files such as orders/ logs/, etc. that might be needed if it is a live catalog.
+N:This can also be the time to copy any "data" files such as orders/ logs/,
+etc. that might be needed if it is a live catalog.
!block example;
cd /var/lib/interchange/foundation
@@ -449,7 +601,8 @@
H3:Install and test the new catalog
-N:Now lets move the old {{F:foundation}} out of the way and put the new {{F:foundation_CVS}} in its place.
+N:Now lets move the old {{F:foundation}} out of the way and put the new
+{{F:foundation_CVS}} in its place.
!block example;
cd /var/lib/interchange/
@@ -465,18 +618,21 @@
ln -s /var/lib/interchange/foundation/images images
!endblock
-N:Now, you should have a working catalog again. To make sure, start up Interchange and test the site with your browser.
+N:Now, you should have a working catalog again. To make sure, start up
+Interchange and test the site with your browser.
H2:Testing manual CVS updates on Interchange catalogs
-N:Next, lets again update the checkout we made a while back before importing our catalog. (Alternatively, one could use a visual CVS client detailed above).
+N:Next, lets again update the checkout we made a while back before importing
+our catalog. (Alternatively, one could use a visual CVS client detailed above).
!block example;
cd ~/src
cvs -q up -d foundation # -q for quiet, -d for directory prune/update
!endblock
-N:Additionally, you might test making a change to one of your checked-out source files, saving it, then committing it.
+N:Additionally, you might test making a change to one of your checked-out
+source files, saving it, then committing it.
!block example;
{{B:index.html:}}
<!--this is a test comment at the top of index.html-->
@@ -486,9 +642,12 @@
E:cvs commit index.html
-N:Your changed version will now be resident in the repository. Again, CVS documentation is in the {{SECT:Resources}} Appendix.
-
-N:This time, we can allow the changes to take effect on the code being used by Interchange to serve pages. To do so, one must run a {{EX:cvs update}} on the catalog directory:
+N:Your changed version will now be resident in the repository. Again, CVS
+documentation is in the {{SECT:Resources}} Appendix.
+
+N:This time, we can allow the changes to take effect on the code being used by
+Interchange to serve pages. To do so, one must run a {{EX:cvs update}} on the
+catalog directory:
!block example;
cd /var/lib/interchange/foundation
@@ -509,15 +668,29 @@
? ...
!endblock
-N:The {{EX:?}} lines in the above example mean that the CVS server has never heard of the listed directories or files (they are in your local source dir but not in the CVS source dir). It is harmless, but sometimes annoying.
-
-N:The {{EX:M}} means that the file has been modified on your local copy, and is out of sync with the remote CVS version (e.g. when Interchange runs it updates {{F:etc/status.foundation}}). Normally this is corrected by uploading your "modified" 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 CVS repository. These types of messages can be handled with {{EX:$CVSIGNORE}} and {{EX:$CVSROOT/CVSROOT/cvsignore}}.
+N:The {{EX:?}} lines in the above example mean that the CVS server has never
+heard of the listed directories or files (they are in your local source dir but
+not in the CVS source dir). It is harmless, but sometimes annoying, and can be
+taken care of with CVSIGNORE.
+
+N:The {{EX:M}} means that the file has been modified on your local copy, and is
+out of sync with the remote CVS version (e.g. when Interchange runs it updates
+{{F:etc/status.foundation}}). Normally this is corrected by uploading your
+"modified" 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 CVS repository. These types of messages can be handled with
+{{EX:$CVSIGNORE}} and {{EX:$CVSROOT/CVSROOT/cvsignore}}.
#TODO: CVSIGNORE
-N:Now, check to make sure that your change has taken effect by refreshing the homepage on the site. To see the comment, use {{EX:View->Page Source}} or whatever the relevant command for your browser is.
-
-N: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 CVS to automatically update the catalog whenever you commit something to CVS.
+N:Now, check to make sure that your change has taken effect by refreshing the
+homepage on the site. To see the comment, use {{EX:View->Page Source}} or
+whatever the relevant command for your browser is.
+
+N: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 CVS to automatically update the catalog whenever you commit something
+to CVS.
H2:Automatic updates on commit
@@ -527,18 +700,31 @@
^foundation (date; cat; (sleep 1; cd /var/lib/interchange/foundation; cvs -q update -d) &) >> $CVSROOT/CVSROOT/updatelog 2>&1
!endblock
-N:The first line tells CVS that for every commit on modules that start with "foundation" (notice the regular expression {{EX:"^foundation"}}), it will run {{EX:cvs update}} on the given catalog directory in the background. It is important that it is executed in a forked shell (notice the {{EX:"&"}}) after {{EX: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 "file locked by user"). See the CVS documentation in the {{SECT:Resources}} Appendix for more details.
+N:The first line tells CVS that for every commit on modules that start with
+"foundation" (notice the regular expression {{EX:"^foundation"}}), it will run
+{{EX:cvs update}} on the given catalog directory in the background. It is
+important that it is executed in a forked shell (notice the {{EX:"&"}}) after
+{{EX: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 "file locked by user"). See the CVS
+documentation in the {{SECT:Resources}} Appendix for more details.
H2:Automatic e-mail on commit
-N:Often it is very helpful to have a commit mailing list that keeps developers up-to-date on every commit happening to the CVS. To setup automatic e-mails on every commit, put the following in
+N:Often it is very helpful to have a commit mailing list that keeps developers
+up-to-date on every commit happening to the CVS. To setup automatic e-mails on
+every commit, put the following in
!block example;
{{B:/rep/CVSROOT/loginfo:}}
ALL /usr/bin/cvs-log $CVSROOT/CVSROOT/commitlog $USER "%{sVv}"
!endblock
-This tells CVS 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 {{F:/usr/bin/cvs-log}} that is executable by the cvs user (using {{EX:"chmod 755 /usr/bin/cvs-log"}}).
+This tells CVS 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 {{F:/usr/bin/cvs-log}} that is executable by the cvs
+user (using {{EX:"chmod 755 /usr/bin/cvs-log"}}).
!block example;
{{B:/usr/bin/cvs-log:}}
@@ -551,7 +737,10 @@
cat) | tee -a $1 | /usr/bin/Mail -s "[foundation-cvs] $3" foundation-cvs@example.com
!endblock
-N: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 {{SECT:Mailserver for CVS updates}}). Here is what a sample e-mail looks like:
+N: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 {{SECT:Mailserver for CVS updates}}). Here is what a sample
+e-mail looks like:
!block example;
Subject: [foundation-cvs] 'directory/subdirectory filename.c,1.7,1.8'
@@ -567,45 +756,77 @@
test
!endblock
-N:Now you have a working CVS development system. At this point it may be valuable to learn more about CVS the client tools that you are using.
+N:Now you have a working CVS development system. At this point it may be
+valuable to learn more about CVS the client tools that you are using.
H1:The two track model: development and live catalogs
-N: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 "staging" and "production" terminology, others prefer "unstable" and "stable", "beta" and "release", or "development" and "live".
-
-N:The easiest starting point for two-track development is to just use two completely separate CVS 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.
+N: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
+"staging" and "production" terminology, others prefer "unstable" and "stable",
+"beta" and "release", or "development" and "live".
+
+N:The easiest starting point for two-track development is to just use two
+completely separate CVS 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.
-N:A slightly more complicated solution is to use the CVS branches feature. It is more difficult to set up, but can be rewarding when used correctly.
+N:A slightly more complicated solution is to use the CVS branches feature. It
+is more difficult to set up, but can be rewarding when used correctly.
H2:When to branch
-N:The first decision is when to branch the source code. For websites, this can sometimes be an easy decision like "first went live", or "site-wide overhaul", etc.
+N:The first decision is when to branch the source code. For websites, this can
+sometimes be an easy decision like "first went live", or "site-wide overhaul",
+etc.
H2:Which way to branch
-N:There are many different ways to branch source code. What seems to be the most common method is to use the "trunk", which is the HEAD tag to CVS as the development version, and then make a branch when a stable release is to be made.
-
-N:That model doesn't fit my development style at the current time, so I use the HEAD default branch as my stable live version, and use other tags (like DEV1 and DEV_REALLY_UNSTABLE) for my development branch.
-
-N:You may find that you are merging (or "folding") 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 "releases" 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.
+N:There are many different ways to branch source code. What seems to be the
+most common method is to use the "trunk", which is the HEAD tag to CVS as the
+development version, and then make a branch when a stable release is to be made.
+
+N:That model doesn't fit my development style at the current time, so I use the
+HEAD default branch as my stable live version, and use other tags (like DEV1
+and DEV_REALLY_UNSTABLE) for my development branch.
+
+N:You may find that you are merging (or "folding") most or all of your
+development ranch 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 "releases" 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.
H2:Performing the branch
-N:To perform the branch use the {{EX:cvs tag -b <BRANCH NAME>}} command. For example:
+N:To perform the branch use the {{EX:cvs tag -b <BRANCH NAME>}} command. For
+example:
!block example;
cvs tag -b DEV1
!endblock
-N:Remember that this does not change your locally checked out working directory to the new tag automatically, it only creates the branch within the CVS repository.
+N:Remember that this does not change your locally checked out working directory
+to the new tag automatically, it only creates the branch within the CVS
+repository.
H2:Setup the development catalog
-N:Now we have a branch in CVS, but we need to tie it to something in the real world, namely, an Interchange catalog.
+N:Now we have a branch in CVS, but we need to tie it to something in the real
+world, namely, an Interchange catalog.
H3:Importing the catalog
-N:Like we did in {{SECT:Integrating CVS with Interchange}}, 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 URL using the Apache {{EX:<Directory> allow from...}} directive).
+N:Like we did in {{SECT:Integrating CVS with Interchange}}, 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 URL using the Apache {{EX:<Directory> allow from...}}
+directive).
H4:Checkout source code
@@ -616,7 +837,8 @@
H4:Copy any other needed directories to complete the catalog
-N:Depending on how complete your catalog is in CVS, you may need to create or copy directories/files.
+N:Depending on how complete your catalog is in CVS, you may need to create or
+copy directories/files.
!block example;
cd /var/lib/interchange/foundation
@@ -624,21 +846,28 @@
/var/lib/interchange/foundation_dev
!endblock
-Note:A lot of the following steps are performed by the /usr/local/interchange/bin/makecat script, but here is how to do it manually:
+Note:A lot of the following steps are performed by the
+/usr/local/interchange/bin/makecat script, but here is how to do it manually:
H3:Setting up a separate database
-N: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).
+N: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).
H4:Create a second database
-N:Use the means of your database platform to create a separate database. For example, PostgreSQL users might do something like:
+N:Use the means of your database platform to create a separate database. For
+example, PostgreSQL users might do something like:
{{EX:createdb foundation_dev}}
H4:Populate the database
-N: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.
+N: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.
!block example;
pg_dump foundation > ~/foundation.dump
@@ -672,7 +901,9 @@
H3:Configure the catalog specifics
-N:The development catalog will differ at least a little bit from the standard catalog, such as in the CGI_URL and database parameters. You can also modify/add the foundation_dev/variable.txt instead of the following.
+N:The development catalog will differ at least a little bit from the standard
+catalog, such as in the CGI_URL and database parameters. You can also
+modify/add the foundation_dev/variable.txt instead of the following.
!block example;
{{B:/var/lib/interchange/catalog.cfg:}}
@@ -686,7 +917,11 @@
H2:Splitting updates on commit by tag
-N:Setup CVS so that when you commit to the DEV1 branch, only the development ({{EX:foundation_dev}}) catalog will be updated. And when you commit with no tags (HEAD branch), the live ({{EX:foundation}}) catalog will be updated. Here is an example {{F:loginfo}}. The {{EX:-r <tag>}} may be used just in case your environment is such that the tags may be changed by other sources.
+N:Setup CVS so that when you commit to the DEV1 branch, only the development
+({{EX:foundation_dev}}) catalog will be updated. And when you commit with no
+tags (HEAD branch), the live ({{EX:foundation}}) catalog will be updated. Here
+is an example {{F:loginfo}}. The {{EX:-r <tag>}} may be used just in case your
+environment is such that the tags may be changed by other sources.
!block example;
{{B:$CVSROOT/CVSROOT/loginfo:}}
@@ -696,17 +931,21 @@
H2:Using new branches
-N:To use your new branch, checkout a working copy of the source with the correct tag specified. For example:
+N:To use your new branch, checkout a working copy of the source with the
+correct tag specified. For example:
!block example;
cvs co -P -r DEV1
!endblock
-N:Then make change to one of the files, and commit it. The change should show on your development catalog, but not your live catalog.
+N:Then make change to one of the files, and commit it. The change should show
+on your development catalog, but not your live catalog.
H2:Merging
-N: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 :
+N: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 :
- Make a change in the development branch (DEV1) and commit it.
- Copy the development-tagged file to a temporary name
@@ -715,51 +954,88 @@
- Commit the result
- Update back to the development version (DEV1)
-N:I do the above so often that I have written a Tcl script for WinCVS that will automatically perform the above steps. And similar shell scripts can probably be easily written to match your development environment.
-
-N:The above seems to be the easiest way, to me. However, there are other alternatives detailed in the CVS manual in chapter 5, "Branching and merging", 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.
+N:I do the above so often that I have written a Tcl script for WinCVS that will
+automatically perform the above steps. And similar shell scripts can probably
+be easily written to match your development environment.
+
+N:The above seems to be the easiest way, to me. However, there are other
+alternatives detailed in the CVS manual in chapter 5, "Branching and merging",
+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.
H1:Tools of the trade
-N:This is the productivity tips section, which will hopefully help you to be able to get more done in less time.
+N:This is the productivity tips section, which will hopefully help you to be
+able to get more done in less time.
H2:Workstation Interchange installation
-N: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.
-
-N:The remedy to that is to setup an Interchange server on your workstation, or any location that has direct access to the CVS source files. I'll explain:
-
-N:The Interchange server that runs where the CVS 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 CVS.
-
-N:For example, Bob could setup another Interchange catalog on the same server as the CVS, (e.g. foundation-bob). To get direct access to those files (rather than FTP), Bob could use NFS mounts (if Bob's workstation is Linux) or SMB 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 "upload" from the "edit->upload->test" development cycle). One could even use VMware to run a Linux server on your Windows workstation.
-
-Note: You can now use the cygwin compatibility confirmed in Interchange versions 4.7.6 and above to run Interchange right on your Windows workstation.
-
-N: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 CVS catalog. Which is:
+N: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.
+
+N:The remedy to that is to setup an Interchange server on your workstation, or
+any location that has direct access to the CVS source files. I'll explain:
+
+N:The Interchange server that runs where the CVS 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
+CVS.
+
+N:For example, Bob could setup another Interchange catalog on the same server as
+ the CVS, (e.g. foundation-bob). To get direct access to those files (rather
+ than FTP), Bob could use NFS mounts (if Bob's workstation is Linux) or SMB
+ 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
+ "upload" from the "edit->upload->test" development cycle). One could even use
+ VMware to run a Linux server on your Windows workstation.
+
+Note: You can now use the cygwin compatibility confirmed in Interchange
+versions 4.7.6 and above to run Interchange right on your Windows workstation.
+
+N: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 CVS catalog. Which is:
*Stop Interchange.
*bin/makecat a new catalog.
-*Checkout from CVS into a new CVS catalog directory and link the images/ directory.
+*Checkout from CVS into a new CVS catalog directory and link the images/
+directory.
*Move any needed files back into the CVS catalog directory.
-*Make modifications to products/variable.txt and catalog.cfg (e.g. CGI_URL, HOSTNAME, DBI_USER, DBI_PASSWORD).
+*Make modifications to products/variable.txt and catalog.cfg (e.g. CGI_URL,
+HOSTNAME, DBI_USER, DBI_PASSWORD).
*Restart Interchange.
-N:One aspect of this local configuration is managing the differences between the main Interchange daemon which runs on the CVS 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).
-
-N: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 {{F:CVSROOT/cvsignore}} and {{EX:$CVSIGNORE}}, which are beyond the scope of this document.
+N:One aspect of this local configuration is managing the differences between
+the main Interchange daemon which runs on the CVS 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).
+
+N: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 {{F:CVSROOT/cvsignore}} and
+{{EX:$CVSIGNORE}}, which are beyond the scope of this document.
#CVSIGNORE update
H2:Mailserver for CVS updates
-N:To setup a mailserver for CVS updates, first download and install Mailman. For RPM-based systems, check on rpmfind.net for a precompiled binary package.
+N:To setup a mailserver for CVS updates, first download and install Mailman.
+For RPM-based systems, check on rpmfind.net for a precompiled binary package.
-N:After installing, read the following information about Mailman and what needs to be done after installation (taken from the RPM meta data):
+N:After installing, read the following information about Mailman and what needs
+to be done after installation (taken from the RPM meta data):
N:"Mailman is software to help manage email discussion lists, much like
Majordomo and Smartmail. Unlike most similar products, Mailman gives
@@ -798,15 +1074,20 @@
H2:Locally mapped source code for a network IC server
-N:This is useful mostly to Windows users, since Linux users can just as easily run IC daemons on their own workstation as they can a separate server.
+N:This is useful mostly to Windows users, since Linux users can just as easily
+run IC daemons on their own workstation as they can a separate server.
-N:The idea is to have the IC server use its own files and directories for things that won't be edited and modified locally, but reference a Samba directory or NFS directory for things that will (such as {{F:pages/}}, {{F:templates/}}, etc.).
+N:The idea is to have the IC server use its own files and directories for things
+ that won't be edited and modified locally, but reference a Samba directory or
+ NFS directory for things that will (such as {{F:pages/}}, {{F:templates/}},
+ etc.).
H3:Mount the Samba or NFS directory
N:{{EX:smbmount <...>}} or {{EX:mount -t nfsfs <...>}}
-N:The following script uses two directories (source and destination) to create symlinks for the commonly modified source directories of Interchange.
+N:The following script uses two directories (source and destination) to create
+symlinks for the commonly modified source directories of Interchange.
!block example;
export S=/mnt/nfs/foundation
@@ -820,41 +1101,61 @@
F=templates; ln -s $S/$F $D/$F
!endblock
-N: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 SMB or NFS connection.
+N: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 SMB or NFS connection.
H2:jEdit - a good editor with Interchange/HTML/Perl colorization and CVS
-N:I have been quite impressed with jEdit ({{URL:http://www.jedit.org}}, and open source editor that is written in Java and runs on most platforms.
-
-N:I use the interchange.xml language definition written by Chris Jesseman {{EMAIL:chris@sitemajic.net}}, which is available from {{URL:http://www.sitemajic.net/jedit/}}. With this, jEdit automatically colors HTML, Perl, AND many Interchange tags very intelligently.
+N:I have been quite impressed with jEdit ({{URL:http://www.jedit.org}}, and open
+ source editor that is written in Java and runs on most platforms.
-N:Further, jEdit has a CVS plugin, written by Ben Sarsgard {{EMAIL:bsarsgard@vmtllc.com}}, and available at: {{URL:http://www.vmtllc.com/~bsarsgard/jedit.html}}. This plugin allows you to diff, update, and commit right from the editor.
+N:I use the interchange.xml language definition written by Chris Jesseman
+{{EMAIL:chris@sitemajic.net}}, which is available from
+{{URL:http://www.sitemajic.net/jedit/}}. With this, jEdit automatically colors
+HTML, Perl, AND many Interchange tags very intelligently.
+
+N:Further, jEdit has a CVS plugin, written by Ben Sarsgard
+{{EMAIL:bsarsgard@vmtllc.com}}, and available at:
+{{URL:http://www.vmtllc.com/~bsarsgard/jedit.html}}. This plugin allows you to
+diff, update, and commit right from the editor.
H2:Separate servers for development and live catalogs
-N:If you have the luxury of separate server hardware for the development and live catalogs, you might find the following utility helpful:
+N:If you have the luxury of separate server hardware for the development and
+live catalogs, you might find the following utility helpful:
-*CVSviaFTP ({{URL:http://www.cvshome.org/dev/addoncvsftp.html}}) - from the CVS Add-ons page ({{URL:http://www.cvshome.org/dev/addons.html}}).
+*CVSviaFTP ({{URL:http://www.cvshome.org/dev/addoncvsftp.html}}) - from the CVS
+Add-ons page ({{URL:http://www.cvshome.org/dev/addons.html}}).
-N:It allows one to have a given CVS module automatically publish each update to an FTP server, which could serve as the live server. Or one could could use it if your CVS installation is only local and you could use it to upload your changes to your production server.
+N:It allows one to have a given CVS module automatically publish each update to
+an FTP server, which could serve as the live server. Or one could could use it
+if your CVS installation is only local and you could use it to upload your
+changes to your production server.
A1:Credits
-*{{B:Jon Jensen}}: Thanks for helping me get going on the SDF format already used by the Interchange documentation, and fixing some SDF syntax errors.
-*{{B:Mike Heins & all who have contributed to the success of Interchange}}: Thanks for following the Way Of The Source, for quality programming, and for helping to making IC something to write about.
-*Thanks to the countless others who have written the CVS documentation that is available online, which was my only source for learning CVS.
+*{{B:Jon Jensen}}: Thanks for helping me get going on the SDF format already
+used by the Interchange documentation, and fixing some SDF syntax errors.
+*{{B:Mike Heins & all who have contributed to the success of Interchange}}:
+Thanks for following the Way Of The Source, for quality programming, and for
+helping to making IC something to write about.
+*Thanks to the countless others who have written the CVS documentation that is
+available online, which was my only source for learning CVS.
A1:Document history
*May 2001. Conceived and written by Dan Browning.
*July 19, 2001. First draft complete, first public release.
-*12 April 2002. Minor typographical edit.
+*April 12, 2002. Minor typographical edit.
+*June 8, 2002. Minor updates.
A1:Resources
A2:CVS Documentation
-N:Here are some resources for learning more about CVS. I have ranked them by the order of usefulness, which is of course, objective.
+N:Here are some resources for learning more about CVS. I have ranked them by
+the order of usefulness, which is of course, objective.
*Karl Fogel's CVS book {{URL:http://cvsbook.red-bean.com/}}
*The official CVS manual {{URL:http://www.cvshome.org/docs/manual/}}
@@ -873,18 +1174,26 @@
*CVS RPM download (Red Hat Linux 7.1) {{URL:ftp://speakeasy.rpmfind.net/linux/redhat/7.1/en/os/i386/RedHat/RPMS/cvs-1.11-3.i386.rpm}}
-*Source tarball links can can be found at cvshome.org.
+*Links to source tarball links can can be found at cvshome.org.
A2:CVS Client Software
-N:There is a variety of client access methods for using CVS on your development box.
-
-*There are some great graphical clients for Linux, Windows, and Mac at {{URL:http://www.cvsgui.org}}. These also give you the same access to all the command line cvs commands.
-
-*jCVS is a great cross-platform graphical CVS client available at {{URL:http://www.jcvs.org}}.
+N:There is a variety of client access methods for using CVS on your development
+box.
-*jEdit is a great cross-platform text editor written in java, which not only has a CVS module that allows you to commit (upload) files directly from the editor, but also has a Interchange Tag Language (and Perl language) colorizer/parser. It is available from {{URL:http://www.jedit.org}}.
+*CVSGUI is a great project that brings graphical clients to Linux, Windows, and
+Mac at {{URL:http://www.cvsgui.org}}. These also give you the same access to
+all the command line cvs commands.
+
+*jCVS is a great cross-platform graphical CVS client available at
+{{URL:http://www.jcvs.org}}.
+
+*jEdit is a great cross-platform text editor written in java, which not only
+has a CVS module that allows you to commit (upload) files directly from the
+editor, but also has a Interchange Tag Language (and Perl language)
+colorizer/parser. It is available from {{URL:http://www.jedit.org}}.
Line:
-N:Copyright 2001 Dan Browning <danpb@mail.com>. Freely redistributable under terms of the GNU General Public License.
+N:Copyright 2001,2002 Dan Browning <dan.browning@kavod.com>. Freely
+redistributable under terms of the GNU General Public License.
1.11 +12 -2 docs/icfaq.sdf
rev 1.11, prev_rev 1.10
Index: icfaq.sdf
===================================================================
RCS file: /var/cvs/docs/icfaq.sdf,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- icfaq.sdf 6 Jun 2002 02:01:51 -0000 1.10
+++ icfaq.sdf 8 Jun 2002 19:15:41 -0000 1.11
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: icfaq.sdf,v 1.10 2002/06/06 02:01:51 jon Exp $
+# $Id: icfaq.sdf,v 1.11 2002/06/08 19:15:41 danb Exp $
!define DOC_NAME "Frequently Asked Questions"
!define DOC_TYPE ""
!define DOC_CODE "icfaq"
-!define DOC_VERSION substr('$Revision: 1.10 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.11 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/icfaq.html"
@@ -292,6 +292,10 @@
catalog on a Windows system; if you do get it working you should only use
for catalog development.
+H2: Error -- 'make: command not found'
+
+The error is caused when the system you are installing on does not have the program called "make". It is recommended that you install make as well as a C compiler ("cc" or "gcc") for the installation of Interchange. If you are unsure of how to do this for your operating system, it may help to ask a mailing list related to your operating system.
+
H1: SSL problems
H2: Shopping cart is dropped when using SSL.
@@ -1778,6 +1782,12 @@
Use the same basic steps for any module not properly installed by using perl -MCPAN -e 'install Bundle::Interchange'
Now, install Interchange as normal.
+
+H1: Other / Miscellaneous Questions
+
+H2: What does the "mv_pc" variabled added to every URL mean?
+
+Its purpose is to make each link unique so that users behind a proxy (e.g. AOL) will not have dynamic content cached.
Line:
1.86 +23 -5 docs/ictags.sdf
rev 1.86, prev_rev 1.85
Index: ictags.sdf
===================================================================
RCS file: /var/cvs/docs/ictags.sdf,v
retrieving revision 1.85
retrieving revision 1.86
diff -u -r1.85 -r1.86
--- ictags.sdf 8 Jun 2002 01:06:06 -0000 1.85
+++ ictags.sdf 8 Jun 2002 19:15:41 -0000 1.86
@@ -1,10 +1,10 @@
!init OPT_LOOK="akopia"; OPT_STYLE="manual"
-# $Id: ictags.sdf,v 1.85 2002/06/08 01:06:06 jon Exp $
+# $Id: ictags.sdf,v 1.86 2002/06/08 19:15:41 danb Exp $
!define DOC_NAME "Interchange Tags Reference"
!define DOC_TYPE ""
!define DOC_CODE "ictags"
-!define DOC_VERSION substr('$Revision: 1.85 $', 11, -2)
+!define DOC_VERSION substr('$Revision: 1.86 $', 11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/ictags.html"
@@ -4939,9 +4939,9 @@
via the global variable MV_ERROR_STD_LABEL with
the default being:
-> <FONT COLOR=RED>label_str<SMALL><I>(%s)</I></SMALL></FONT>
+> <FONT COLOR=RED>{LABEL}<SMALL><I>(%s)</I></SMALL></FONT>
-where <label_str> is what you set std_label to and %s
+where {LABEL} is what you set std_label to and %s
is substituted with the error message. This option
can not be used with the text= option.
@@ -14903,7 +14903,7 @@
B<ASP-like Perl call:>
!block example; lang="Perl"
- $Tag->convert_date( { day => 1 } );
+ $Tag->convert_date( { days => 1 } );
$Tag->convert_date( { body => "2001-05-19 15:35",
format => "%d-%m-%Y %H:%M", } );
@@ -15237,6 +15237,24 @@
H2: formel
+
+H2: fortune
+
+This tag uses the {{EX:fortune(1)}} command to display a random saying.
+
+!block example
+Options:
+
+ short=yes|no* Select only short (< 160 chars) fortunes
+ a=1 Select from all fortunes, even potentially offensive ones.
+ o=1 Select only from potentially offensive fortunes.
+ raw=1 Don't do any HTML formatting
+
+Example:
+
+ [fortune short=yes]
+
+!endblock
H2: get-url