List Of CVS Modules, Their Contents, And Text File Naming Conventions

CVS defines the concept of module, which is a top-level directory in a CVS repository.  Although in the repository structure utilized by the ESRG tool set there is some interdependency between modules (for example, the InstallShield Express Windows® installation obtains files from several modules), for the most part modules are separate entities.

On this web page, all CVS modules are enumerated and what they contain is explained.

All but two of the ESRG tool set distribution files are built on a SourceForge *nix machine, and some of those distribution files are designed to be decompressed and used on Windows® machines.  In order to prepare text files that are Windows®-friendly, the unix2dos utility is used to convert line endings.  In order to convert only text files, there must be an easy way to differentiate text files.  The convention adopted is to make sure that every text file has a suffix (binary files may be without suffix), and to recognize text files by the suffix.  Furthermore, it is observed that the suffixes which denote text files may vary from module to module, and so there may be different recognition criteria for each module.  The table below lists the suffixes that cause a file to be recognized as a text file, on a per-module basis.

Module Contents Text File Suffixes
esrgdocs ESRG tool set documents.  This module is presently not populated.

N/A, presently unpopulated.
esrgdstb InstallShield Express project files, graphics, licenses, etc. for preparing both Windows® and *nix distributions of the ESRG tool set.

.htm
.rtf
.txt
esrgdsts Scripts and .BAT files which are used on a *nix or Windows® platform to prepare ESRG tool set file distributions.

N/A, because at this time the files in this module are never prepared for a Windows® machine.
esrgnxpj The *nix version of the ESRG tool set.

N/A, because at this time the files in this module are never prepared for a Windows® machine.
esrgpcpj Source code, MSVC++ project files, graphics, and build .BAT files for compiled Windows® tools.

.c
.cpp
.h
.txt
esrgphpa The PHP script library of the ESRG tool set.

.inc
.php
.txt
esrgpubs ESRG publications (papers, etc.).  Typically this module is checked out on a Windows® platform and some of the publications are packaged into the Windows® installation executable by InstallShield Express.

.htm
.html
.tex
.txt
esrgubka The source code, graphics, and build script for the book in progress, "A Practitioner's Guide ...".

.cls
.htm
.html
.sty
.tcl
.tex
.txt
esrgweba The entire web content of the ESRG tool set SourceForge site.

.c
.cpp
.h
.htm
.html
.inc
.php
.txt

Additional Notes:

  1. The most reliable way to determine whether a file is text or binary is to check the CVS keyword expansion mode, which should in all cases be indicative (any mode other than "b" would indicate a text file).  If there prove to be difficulties with the current approach, then this more powerful approach will be used.
  2. Even if it is indicated above that files in a module are not intended to be used on a Windows® platform, this refers only to the distribution intent, not to the possibility of using the files.  Any text or binary file under CVS can be checked out to a Windows® system.

This web page is maintained by David T. Ashley.
$Header: /cvsroot/esrg/sfesrg/esrgweba/htdocs/devels/cvs_mods_txt_conv/cvs_mods.htm,v 1.2 2003/04/27 21:01:26 dtashley Exp $