sft_new_cvs_module - add a new module to SourceForge.net CVS

Description:

This is a program to add a new module to your project's SourceForge.net CVS. It will import the contents of an existing module directory into your CVS tree at SourceForge.net. After performing the CVS import, it will perform the initial CVS checkout.

Usage:

        sft_new_cvs_module -h | --help | -m module

Options:

        -h, --help      Display this help message and exit.
        -m  module      module name

Examples:

        sft_new_cvs_module -m my_module

This example creates a new CVS tree for the module "my_module". The files in the /home/your_name/your_project/modules/my_module directory will be imported into your project's CVS account at SourceForge.net. After the files are imported, an initial checkout is performed to give you new working copies of your files. After your module is checked out, you may work on them as you wish. Since the checkout creates a new directory for the working copies, the previous directory, in our example "my_module", is renamed to "my_module.bak" prior to the initial checkout.

This script should be run only once per module. If a directory named "CVS" is found inside the module directory, sft_new_cvs_module will terminate with an error. Presence of a CVS directory indicates that the module is already in CVS. If the script performs the import but fails during the initial checkout, DO NOT run the script again. Perform the initial checkout *manually*. Please see the documentation on SourceForge.net regarding CVS for guidance. This script implements the methods described in the SourceForge.net CVS HOW-TO.

Installation and Configuration:

sft_cvs_module is self-contained. Put it wherever is handy. You must have a working ssh and CVS.

To configure sft_new_cvs_module, set the PROJECT_NAME and SF_USER constants as needed. You must also set the environment variable CVS_RSH. It must contain the value "ssh" to work with CVS at SourceForge.net. See the SourceForge.net CVS HOW-TO for details.

All the tools in the sf-tools package expect a project to organized as described in the sf-tools.README file.

Tested With:

Tested with Red Hat 6.2. An ancestor of the script created the modules for the linuxcommand.org project after I choked doing one manually.

Copyright:

Copyright 2001-2002, William Shotts <bshotts@users.sourceforge.net>

This software is part of the LinuxCommand.org project, a site for Linux education and advocacy devoted to helping users of legacy operating systems migrate into the future.

You may contact the LinuxCommand.org project at:

        http://www.linuxcommand.org

License:

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

SourceForge.net is a trademark of VA Software, Inc.

$Id: sft_new_cvs_module.README,v 1.3 2002/03/09 16:50:43 bshotts Exp $