CUPS Configuration Management Plan
CUPS-CMP-1.1
Easy Software Products
Copyright 1997-2004, All Rights Reserved
This configuration management plan document provides the guidelines for development and maintenance of the Common UNIX Printing System ("CUPS") Version 1.1 software.
CUPS provides a portable printing layer for UNIX®-based operating systems. It has been developed by Easy Software Products to promote a standard printing solution for all UNIX vendors and users. CUPS provides the System V and Berkeley command-line interfaces.
CUPS uses the Internet Printing Protocol ("IPP") as the basis for managing print jobs and queues. The Line Printer Daemon ("LPD") Server Message Block ("SMB"), and AppSocket (a.k.a. JetDirect) protocols are also supported with reduced functionality. CUPS adds network printer browsing and PostScript Printer Description ("PPD") based printing options to support real-world printing under UNIX.
CUPS includes an image file RIP that supports printing of image files to non-PostScript printers. A customized version of GNU Ghostscript 7.05 for CUPS called ESP Ghostscript is available separately to support printing of PostScript files within the CUPS driver framework. Sample drivers for Dymo, EPSON, HP, and OKIDATA printers are included that use these filters.
Drivers for thousands of printers are provided with our ESP Print Pro software, available at:
http://www.easysw.com/printpro/
CUPS is licensed under the GNU General Public License and GNU Library General Public License. Please contact Easy Software Products for commercial support and "binary distribution" rights.
This configuration management document is organized into the following sections:
The following CUPS documentation is referenced by this document:
The following non-CUPS documents are referenced by this document:
Each source file shall be placed a sub-directory corresponding to the software sub-system it belongs to ("scheduler", "cups", etc.) To remain compatible with older UNIX filesystems, directory names shall not exceed 16 characters in length.
Source files shall be documented and formatted as described in Appendix B, Coding Requirements. To remain compatible with older UNIX filesystems, source file names shall not exceed 16 characters in length.
Source files shall be placed under the control of the Concurrent Versions System ("CVS") software. Source files shall be "checked in" with each change so that modifications can be tracked.
Documentation on the CVS software is included with the whitepaper, "CVS II: Parallelizing Software Development".
A Software Trouble Report ("STR") shall be submitted every time a user or vendor experiences a problem with the CUPS software. Trouble reports are maintained in a database with one of the following states:
Trouble reports shall be processed using the following steps.
When a trouble report is received it must be classified at one of the following priority levels:
Level 4 and 5 trouble reports must be resolved in the next software release. Level 1 to 3 trouble reports are scheduled for resolution in a specific release at the discretion of the release coordinator.
The scope of the problem should also be determined as:
Once the level and scope of the trouble report is determined the software sub-system(s) involved with the problem are determined. This may involve additional communication with the user or vendor to isolate the problem to a specific cause.
When the sub-system(s) involved have been identified, an engineer will then determine the change(s) needed and estimate the time required for the change(s).
Corrections are scheduled based upon the severity and complexity of the problem. Once all changes have been made, documented, and tested successfully a new software release snapshot is generated. Additional tests are added as necessary for proper testing of the changes.
The user or vendor is notified when the fix is available or if the problem was caused by user error.
CUPS uses a three-part version number separated by periods to represent the major, minor, and patch release numbers:
MAJOR.MINOR.PATCH
1.1.0
Beta-test releases are indentified by appending the letter B followed by the build number:
MAJOR.MINOR.PATCHbBUILD
1.1.0b1
Release candidates are indentified by appending the letters RC followed by the build number:
MAJOR.MINOR.PATCHrcBUILD
1.1.0rc1
A CVS snapshot is generated for every beta and final release and uses the version number preceded by the letter "v" and with the decimal points replaced by underscores:
v1_1_0b1
v1_1_0rc1
v1_1_0
Each change that corrects a fault in a software sub-system increments the patch release number. If a change affects the overall software design of CUPS then the minor release number will be incremented and the patch release number reset to 0. If CUPS is completely redesigned the major release number will be incremented and the minor and patch release numbers reset to 0:
1.1.0b1 First beta release
1.1.0b2 Second beta release
1.1.0rc1 First release candidate
1.1.0rc2 Second release candidate
1.1.0 First production release
1.1.1b1 First beta of 1.1.1
1.1.1rc1 First release candidate of 1.1.1
1.1.1 Production release of 1.1.1
1.1.2b1 First beta of 1.1.2
1.1.2rc1 First release candidate of 1.1.2
1.1.2 Production release of 1.1.2
2.0.0b1 First beta of 2.0.0
2.0.0rc1 First release candidate of 2.0.0
2.0.0 Production release of 2.0.0
Software releases shall be generated for each successfully completed software trouble report. All object and executable files shall be deleted prior to performing a full build to ensure that source files are recompiled.
Software testing shall be conducted according to the CUPS Software Test Plan, CUPS-STP-1.1. Failed tests cause STRs to be generated to correct the problems found.
When testing has been completed successfully a new distribution image is created from the current CVS code "snapshot". No release shall contain software that has not passed the appropriate software tests. Three types of releases are used, beta, release candidate, and production, and are released using the following basic schedule:
| Week | Version | Description |
|---|---|---|
| T-6 weeks | 1.1.0b1 | First beta |
| T-5 weeks | 1.1.0b2 | Second beta |
| T-4 weeks | 1.1.0b3 | Third beta |
| T-3 weeks | 1.1.0rc1 | First release candidate |
| T-2 weeks | 1.1.0rc2 | Second release candidate |
| T-0 weeks | 1.1.0 | Production |
Beta releases are typically used prior to new major and minor version releases. At least one release candidate is generated prior to each production release.
Beta releases are generated when substantial changes have been made that may affect the reliability of the software. Beta releases may cause loss of data, functionality, or services and are provided for testing by qualified individuals.
Beta releases are an OPTIONAL part of the release process and are generated as deemed appropriate by the release coordinator. Functional changes may be included in subsequent beta releases until the first release candidate.
Release candidates are generated at least two weeks prior to a production release. Release candidates are targeted for end-users that wish to test new functionality or bug fixes prior to the production release. While release candidates are intended to be substantially bug-free, they may still contain defects and/or not compile on specific platforms.
At least one release candidate is REQUIRED prior to any production release. The distribution of a release candidate marks the end of any functional improvements. Release candidates are generated at weekly intervals until all level 4/5 trouble reports are resolved.
Production releases are generated after a successful release candidate and represent a stable release of the software suitable for all users.
These coding requirements provide detailed information on source file formatting and documentation content. These guidelines shall be applied to all C and C++ source files provided with CUPS. Source code for other languages should conform to these requirements as allowed by the language.
All source files names shall be 16 characters or less in length to ensure compatibility with older UNIX filesystems. Source files containing functions shall have an extension of ".c" for ANSI C and ".cxx" for C++ source files. All other "include" files shall have an extension of ".h".
The top of each source file shall contain a header giving the name of the file, the purpose or nature of the source file, the copyright and licensing notice, and the functions contained in the file. The file name and revision information is provided by the CVS "$Id$" tag:
/*
* "$Id$"
*
* Description of file contents.
*
* Copyright 1997-2004 by Easy Software Products, all rights
* reserved.
*
* These coded instructions, statements, and computer programs are
* the property of Easy Software Products and are protected by
* Federal copyright law. Distribution and use rights are outlined
* in the file "LICENSE.txt" which should have been included with
* this file. If this file is missing or damaged please contact
* Easy Software Products at:
*
* Attn: CUPS Licensing Information
* Easy Software Products
* 44141 Airport View Drive, Suite 204
* Hollywood, Maryland 20636-3111 USA
*
* Voice: (301) 373-9600
* EMail: cups-info@cups.org
* WWW: http://www.cups.org
*
* Contents:
*
* function1() - Description 1.
* function2() - Description 2.
* function3() - Description 3.
*/
For source files that are subject to the Apple OS-Developed Software exception, the following additional comment should appear after the contact information:
* This file is subject to the Apple OS-Developed Software exception.
The bottom of each source file shall contain a trailer giving the name of the file using the CVS "$Id$" tag. The primary purpose of this is to mark the end of a source file; if the trailer is missing it is possible that code has been lost near the end of the file:
/*
* End of "$Id$".
*/
Functions with a global scope shall be capitalized ("DoThis", "DoThat", "DoSomethingElse", etc.) The only exception to this rule shall be the CUPS interface library functions which may begin with a prefix word in lowercase ("cupsDoThis", "cupsDoThat", etc.)
Functions with a local scope shall be declared "static" and be lowercase with underscores between words ("do_this", "do_that", "do_something_else", etc.)
Each function shall begin with a comment header describing what the function does, the possible input limits (if any), and the possible output values (if any), and any special information needed:
/*
* 'do_this()' - Compute y = this(x).
*
* Notes: none.
*/
static float /* O - Inverse power value, 0.0 <= y <= 1.1 */
do_this(float x) /* I - Power value (0.0 <= x <= 1.1) */
{
...
return (y);
}
Return/output values are indicated using an "O" prefix, input values are indicated using the "I" prefix, and values that are both input and output use the "IO" prefix for the corresponding in-line comment.
Methods shall be in lowercase with underscores between words ("do_this", "do_that", "do_something_else", etc.)
Each method shall begin with a comment header describing what the method does, the possible input limits (if any), and the possible output values (if any), and any special information needed:
/*
* 'class::do_this()' - Compute y = this(x).
*
* Notes: none.
*/
float /* O - Inverse power value, 0.0 <= y <= 1.0 */
class::do_this(float x) /* I - Power value (0.0 <= x <= 1.0) */
{
...
return (y);
}
Return/output values are indicated using an "O" prefix, input values are indicated using the "I" prefix, and values that are both input and output use the "IO" prefix for the corresponding in-line comment.
Variables with a global scope shall be capitalized ("ThisVariable", "ThatVariable", "ThisStateVariable", etc.) The only exception to this rule shall be the CUPS interface library global variables which must begin with the prefix "cups" ("cupsThisVariable", "cupsThatVariable", etc.) Global variables shall be replaced by function arguments whenever possible.
Variables with a local scope shall be lowercase with underscores between words ("this_variable", "that_variable", etc.) Any local variables shared by functions within a source file shall be declared "static".
Each variable shall be declared on a separate line and shall be immediately followed by a comment block describing the variable:
int this_variable; /* The current state of this */
int that_variable; /* The current state of that */
All type names shall be lowercase with underscores between words and "_t" appended to the end of the name ("this_type_t", "that_type_t", etc.)
Each type shall have a comment block immediately before the typedef:
/*
* This type is for CUPS foobar options.
*/
typedef int cups_this_type_t;
All structure names shall be lowercase with underscores between words and "_str" appended to the end of the name ("this_struct_str", "that_struct_str", etc.)
Each structure shall have a comment block immediately before the struct and each member shall be documented in accordance with the variable naming policy above:
/*
* This structure is for CUPS foobar options.
*/
struct cups_this_struct_str
{
int this_member; /* Current state for this */
int that_member; /* Current state for that */
};
All class names shall be lowercase with underscores between words ("this_class", "that_class", etc.)
Each class shall have a comment block immediately before the class and each member shall be documented in accordance with the variable naming policy above:
/*
* This class is for CUPS foobar options.
*/
class cups_this_class
{
int this_member; /* Current state for this */
int that_member; /* Current state for that */
};
All constant names shall be uppercase with underscored between words ("THIS_CONSTANT", "THAT_CONSTANT", etc.) Constants defined for the CUPS interface library must begin with an uppercase prefix ("CUPS_THIS_CONSTANT", "CUPS_THAT_CONSTANT", etc.)
Typed enumerations shall be used whenever possible to allow for type checking by the compiler.
Comment blocks shall immediately follow each constant:
enum
{
CUPS_THIS_TRAY, /* This tray */
CUPS_THAT_TRAY /* That tray */
};
All source code shall utilize block comments within functions to describe the operations being performed by a group of statements:
/*
* Clear the state array before we begin...
*/
for (i = 0; i < (sizeof(array) / sizeof(sizeof(array[0])); i ++)
array[i] = STATE_IDLE;
/*
* Wait for state changes...
*/
do
{
for (i = 0; i < (sizeof(array) / sizeof(sizeof(array[0])); i ++)
if (array[i] != STATE_IDLE)
break;
if (i == (sizeof(array) / sizeof(array[0])))
sleep(1);
} while (i == (sizeof(array) / sizeof(array[0])));
All code blocks enclosed by brackets shall begin with the opening brace on a new line. The code then follows starting on a new line after the brace and is indented 2 spaces. The closing brace is then placed on a new line following the code at the original indentation:
{
int i; /* Looping var */
/*
* Process foobar values from 0 to 999...
*/
for (i = 0; i < 1000; i ++)
{
do_this(i);
do_that(i);
}
}
Single-line statements following "do", "else", "for", "if", and "while" shall be indented 2 spaces as well. Blocks of code in a "switch" block shall be indented 4 spaces after each "case" and "default" case:
switch (array[i])
{
case STATE_IDLE :
do_this(i);
do_that(i);
break;
default :
do_nothing(i);
break;
}
A space shall follow each reserved word ("if", "while", etc.) Spaces shall not be inserted between a function name and the arguments in parenthesis.
Parenthesis shall surround values returned from a function using "return":
return (STATE_IDLE);
Whenever convenient loops should count downward to zero to improve program performance:
for (i = sizeof(array) / sizeof(array[0]) - 1; i >= 0; i --)
array[i] = STATE_IDLE;
| Summary of Problem: | _____________________________________________ | |
|---|---|---|
| Problem Severity: | __1 | Request for enhancement, e.g. asking for a feature |
| __2 | Low, e.g. a documentation error or undocumented side-effect | |
| __3 | Moderate, e.g. unable to print a file or unable to compile the software | |
| __4 | High, e.g. unable to print to a printer or key functionality not working | |
| __5 | Critical, e.g. unable to print at all | |
| Problem Scope: | __1 | Machine or printer |
| __2 | Operating System | |
| __3 | All machines, printers, or operating systems | |
| Detailed Description of Problem: | _____________________________________________
_____________________________________________ _____________________________________________ _____________________________________________ _____________________________________________ | |