<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
-<TITLE> CUPS Configuration Management Plan</TITLE>
+<TITLE>CUPS Configuration Management Plan</TITLE>
<META NAME="author" CONTENT="Easy Software Products">
<META NAME="copyright" CONTENT="Copyright 1997-2001, All Rights Reserved">
<META NAME="docnumber" CONTENT="CUPS-CMP-1.1">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-8859-1">
<STYLE TYPE="text/css"><!--
-BODY { font-family: serif; font-size: 11.0pt }
-H1 { font-family: sans-serif; font-size: 20.0pt }
-H2 { font-family: sans-serif; font-size: 17.0pt }
-H3 { font-family: sans-serif; font-size: 14.0pt }
-H4 { font-family: sans-serif; font-size: 11.0pt }
-H5 { font-family: sans-serif; font-size: 9.0pt }
-H6 { font-family: sans-serif; font-size: 8.0pt }
-SUB { font-size: 8.0pt }
-SUP { font-size: 8.0pt }
-PRE { font-size: 9.0pt }
+BODY { font-family: serif }
+H1 { font-family: sans-serif }
+H2 { font-family: sans-serif }
+H3 { font-family: sans-serif }
+H4 { font-family: sans-serif }
+H5 { font-family: sans-serif }
+H6 { font-family: sans-serif }
+SUB { font-size: smaller }
+SUP { font-size: smaller }
+PRE { font-family: monospace }
--></STYLE>
</HEAD>
<BODY>
-<CENTER><A HREF="#CONTENTS"><IMG SRC="images/cups-large.gif" BORDER="0" WIDTH="100%"><BR>
-<H1> CUPS Configuration Management Plan</H1></A><BR>
+<CENTER><A HREF="#CONTENTS"><IMG SRC="images/cups-large.gif" BORDER="0" WIDTH="431" HEIGHT="511"><BR>
+<H1>CUPS Configuration Management Plan</H1></A><BR>
CUPS-CMP-1.1<BR>
Easy Software Products<BR>
Copyright 1997-2001, All Rights Reserved<BR>
<B><A HREF="#8">C Software Trouble Report Form</A></B><HR>
<H1><A NAME="1">1 Scope</A></H1>
<H2><A NAME="1_1">1.1 Identification</A></H2>
- This configuration management plan document provides the guidelines
-for development and maintenance of the Common UNIX Printing System
-("CUPS") Version 1.1 software.
+ This configuration management plan document provides the guidelines for
+ development and maintenance of the Common UNIX Printing System ("CUPS")
+ Version 1.1 software.
<H2><A NAME="1_2">1.2 System Overview</A></H2>
-<P>CUPS provides a portable printing layer for UNIX®-based operating
-systems. It has been developed by <A HREF="http://www.easysw.com">Easy
-Software Products</A> to promote a standard printing solution for all
-UNIX vendors and users. CUPS provides the System V and Berkeley
-command-line interfaces. </P>
-<P>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. </P>
-<P>CUPS also includes a customized version of GNU Ghostscript
-(currently based off GNU Ghostscript 5.50) and an image file RIP that
-are used to support non-PostScript printers. Sample drivers for HP and
-EPSON printers are included that use these filters. </P>
+<P>CUPS provides a portable printing layer for UNIX®-based operating
+ systems. It has been developed by<A HREF="http://www.easysw.com"> Easy
+ Software Products</A> to promote a standard printing solution for all
+ UNIX vendors and users. CUPS provides the System V and Berkeley
+ command-line interfaces.</P>
+<P>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.</P>
+<P>CUPS also includes a customized version of GNU Ghostscript (currently
+ based off GNU Ghostscript 5.50) and an image file RIP that are used to
+ support non-PostScript printers. Sample drivers for HP and EPSON
+ printers are included that use these filters.</P>
<H2><A NAME="1_3">1.3 Document Overview</A></H2>
- This configuration management document is organized into the following
-sections:
+ This configuration management document is organized into the following
+ sections:
<UL>
<LI>1 - Scope</LI>
<LI>2 - References</LI>
</UL>
<H1><A NAME="2">2 References</A></H1>
<H2><A NAME="2_1">2.1 CUPS Documentation</A></H2>
-<P>The following CUPS documentation is referenced by this document: </P>
-<UL>
-<LI>CUPS-CMP-1.1: CUPS Configuration Management Plan </LI>
-<LI>CUPS-IDD-1.1: CUPS System Interface Design Description </LI>
-<LI>CUPS-IPP-1.1: CUPS Implementation of IPP </LI>
-<LI>CUPS-SAM-1.1.x: CUPS Software Administrators Manual </LI>
-<LI>CUPS-SDD-1.1: CUPS Software Design Description </LI>
-<LI>CUPS-SPM-1.1.x: CUPS Software Programming Manual </LI>
-<LI>CUPS-SSR-1.1: CUPS Software Security Report </LI>
-<LI>CUPS-STP-1.1: CUPS Software Test Plan </LI>
-<LI>CUPS-SUM-1.1.x: CUPS Software Users Manual </LI>
-<LI>CUPS-SVD-1.1: CUPS Software Version Description </LI>
+<P>The following CUPS documentation is referenced by this document:</P>
+<UL>
+<LI>CUPS-CMP-1.1: CUPS Configuration Management Plan</LI>
+<LI>CUPS-IDD-1.1: CUPS System Interface Design Description</LI>
+<LI>CUPS-IPP-1.1: CUPS Implementation of IPP</LI>
+<LI>CUPS-SAM-1.1.x: CUPS Software Administrators Manual</LI>
+<LI>CUPS-SDD-1.1: CUPS Software Design Description</LI>
+<LI>CUPS-SPM-1.1.x: CUPS Software Programming Manual</LI>
+<LI>CUPS-SSR-1.1: CUPS Software Security Report</LI>
+<LI>CUPS-STP-1.1: CUPS Software Test Plan</LI>
+<LI>CUPS-SUM-1.1.x: CUPS Software Users Manual</LI>
+<LI>CUPS-SVD-1.1: CUPS Software Version Description</LI>
</UL>
<H2><A NAME="2_2">2.2 Other Documents</A></H2>
-<P>The following non-CUPS documents are referenced by this document: </P>
+<P>The following non-CUPS documents are referenced by this document:</P>
<UL>
<LI><A HREF="http://partners.adobe.com/asn/developer/PDFS/TN/5003.PPD_Spec_v4.3.pdf">
-Adobe PostScript Printer Description File Format Specification,
- Version 4.3.</A></LI>
+Adobe PostScript Printer Description File Format Specification, Version
+ 4.3.</A></LI>
<LI><A HREF="http://partners.adobe.com/asn/developer/PDFS/TN/PLRM.pdf">
-Adobe PostScript Language Reference, Third Edition.</A></LI>
-<LI>IPP: Job and Printer Set Operations </LI>
-<LI>IPP/1.1: Encoding and Transport </LI>
-<LI>IPP/1.1: Implementers Guide </LI>
-<LI>IPP/1.1: Model and Semantics </LI>
-<LI><A HREF="http://www.ietf.org/rfc/rfc1179.txt">RFC 1179, Line
-Printer Daemon Protocol</A></LI>
-<LI><A HREF="http://www.ietf.org/rfc/rfc2567.txt">RFC 2567, Design
-Goals for an Internet Printing Protocol</A></LI>
-<LI><A HREF="http://www.ietf.org/rfc/rfc2568.txt">RFC 2568, Rationale
-for the Structure of the Model and Protocol</A> for the Internet
-Printing Protocol</LI>
-<LI><A HREF="http://www.ietf.org/rfc/rfc2569.txt">RFC 2569, Mapping
-between LPD and IPP Protocols</A></LI>
-<LI><A HREF="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616, Hypertext
-Transfer Protocol -- HTTP/1.1</A></LI>
-<LI><A HREF="http://www.ietf.org/rfc/rfc2617.txt">RFC 2617, HTTP
-Authentication: Basic and Digest Access</A> Authentication </LI>
+Adobe PostScript Language Reference, Third Edition.</A></LI>
+<LI>IPP: Job and Printer Set Operations</LI>
+<LI>IPP/1.1: Encoding and Transport</LI>
+<LI>IPP/1.1: Implementers Guide</LI>
+<LI>IPP/1.1: Model and Semantics</LI>
+<LI><A HREF="http://www.ietf.org/rfc/rfc1179.txt">RFC 1179, Line Printer
+ Daemon Protocol</A></LI>
+<LI><A HREF="http://www.ietf.org/rfc/rfc2567.txt">RFC 2567, Design Goals
+ for an Internet Printing Protocol</A></LI>
+<LI><A HREF="http://www.ietf.org/rfc/rfc2568.txt">RFC 2568, Rationale
+ for the Structure of the Model and Protocol</A> for the Internet
+ Printing Protocol</LI>
+<LI><A HREF="http://www.ietf.org/rfc/rfc2569.txt">RFC 2569, Mapping
+ between LPD and IPP Protocols</A></LI>
+<LI><A HREF="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616, Hypertext
+ Transfer Protocol -- HTTP/1.1</A></LI>
+<LI><A HREF="http://www.ietf.org/rfc/rfc2617.txt">RFC 2617, HTTP
+ Authentication: Basic and Digest Access</A> Authentication</LI>
</UL>
<H1><A NAME="3">3 File Management</A></H1>
<H2><A NAME="3_1">3.1 Directory Structure</A></H2>
- 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.
+ 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.
<H2><A NAME="3_2">3.2 Source Files</A></H2>
- Source files shall be documented and formatted as described in
-Appendix B, Coding Requirements.
+ Source files shall be documented and formatted as described in Appendix
+ B, Coding Requirements.
<H2><A NAME="3_3">3.3 Configuration Management</A></H2>
- 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.
-<P>Documentation on the CVS software is included with the whitepaper,
-"CVS II: Parallelizing Software Development". </P>
+ 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.
+<P>Documentation on the CVS software is included with the whitepaper,
+ "CVS II: Parallelizing Software Development".</P>
<H1><A NAME="4">4 Trouble Report Processing</A></H1>
- 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:
+ 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:
<OL>
<LI>STR is closed with complete resolution</LI>
<LI>STR is closed without resolution</LI>
<LI>STR is active</LI>
<LI>STR is pending (new STR or additional information available)</LI>
</OL>
- Trouble reports shall be processed using the following steps.
+ Trouble reports shall be processed using the following steps.
<H2><A NAME="4_1">4.1 Classification</A></H2>
- When a trouble report is received it must be classified at one of the
-following levels:
+ When a trouble report is received it must be classified at one of the
+ following levels:
<OL>
<LI>Request for enhancement</LI>
<LI>Documentation error</LI>
<LI>Unable to print to a printer</LI>
<LI>Unable to print at all</LI>
</OL>
- The scope of the problem should also be determined as:
+ The scope of the problem should also be determined as:
<OL>
<LI>Specific to a machine</LI>
<LI>Specific to an operating system</LI>
<LI>Applies to all machines and operating systems</LI>
</OL>
<H2><A NAME="4_2">4.2 Identification</A></H2>
- 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.
-<P>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). </P>
+ 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.
+<P>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).</P>
<H2><A NAME="4_3">4.3 Correction</A></H2>
- 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.
+ 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.
<H2><A NAME="4_4">4.4 Notification</A></H2>
- The user or vendor is notified when the fix is available or if the
-problem was caused by user error.
+ The user or vendor is notified when the fix is available or if the
+ problem was caused by user error.
<H1><A NAME="5">5 Software Releases</A></H1>
<H2><A NAME="5_1">5.1 Version Numbering</A></H2>
- CUPS uses a three-part version number separated by periods to
-represent the major, minor, and patch release numbers:
+ CUPS uses a three-part version number separated by periods to represent
+ the major, minor, and patch release numbers:
<UL>
<PRE>
major.minor.patch
1.1.0
</PRE>
</UL>
- Beta-test releases are indentified by appending the letter B followed
-by the build number:
+ Beta-test releases are indentified by appending the letter B followed
+ by the build number:
<UL>
<PRE>
major.minor.patchbbuild
1.1.0b1
</PRE>
</UL>
- 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:
+ 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:
<UL>
<PRE>
v1_0_0b1
v1_0_0
</PRE>
</UL>
- Each change that corrects a fault in a software sub-system increments
-the patch release number. If a change affects the 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:
+ Each change that corrects a fault in a software sub-system increments
+ the patch release number. If a change affects the 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:
<UL>
<PRE>
1.1.0b1 First beta release
</PRE>
</UL>
<H2><A NAME="5_2">5.2 Generation</A></H2>
- 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 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.
<H2><A NAME="5_3">5.3 Testing</A></H2>
- 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.
+ 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.
<H2><A NAME="5_4">5.4 Release</A></H2>
- When testing has been completed successfully a new distribution image
-is created from the current CVS code "snapshot". No production release
-shall contain software that has not passed the appropriate software
-tests.
+ When testing has been completed successfully a new distribution image
+ is created from the current CVS code "snapshot". No production release
+ shall contain software that has not passed the appropriate software
+ tests.
<H1 TYPE="A" VALUE="1"><A NAME="6">A Glossary</A></H1>
<H2><A NAME="6_1">A.1 Terms</A></H2>
<DL>
-<DT>C </DT>
-<DD>A computer language. </DD>
-<DT>parallel </DT>
-<DD>Sending or receiving data more than 1 bit at a time. </DD>
-<DT>pipe </DT>
-<DD>A one-way communications channel between two programs. </DD>
-<DT>serial </DT>
-<DD>Sending or receiving data 1 bit at a time. </DD>
-<DT>socket </DT>
-<DD>A two-way network communications channel. </DD>
+<DT>C</DT>
+<DD>A computer language.</DD>
+<DT>parallel</DT>
+<DD>Sending or receiving data more than 1 bit at a time.</DD>
+<DT>pipe</DT>
+<DD>A one-way communications channel between two programs.</DD>
+<DT>serial</DT>
+<DD>Sending or receiving data 1 bit at a time.</DD>
+<DT>socket</DT>
+<DD>A two-way network communications channel.</DD>
</DL>
<H2><A NAME="6_2">A.2 Acronyms</A></H2>
<DL>
-<DT>ASCII </DT>
-<DD>American Standard Code for Information Interchange </DD>
-<DT>CUPS </DT>
-<DD>Common UNIX Printing System </DD>
-<DT>ESC/P </DT>
-<DD>EPSON Standard Code for Printers </DD>
-<DT>FTP </DT>
-<DD>File Transfer Protocol </DD>
-<DT>HP-GL </DT>
-<DD>Hewlett-Packard Graphics Language </DD>
-<DT>HP-PCL </DT>
-<DD>Hewlett-Packard Page Control Language </DD>
-<DT>HP-PJL </DT>
-<DD>Hewlett-Packard Printer Job Language </DD>
-<DT>IETF </DT>
-<DD>Internet Engineering Task Force </DD>
-<DT>IPP </DT>
-<DD>Internet Printing Protocol </DD>
-<DT>ISO </DT>
-<DD>International Standards Organization </DD>
-<DT>LPD </DT>
-<DD>Line Printer Daemon </DD>
-<DT>MIME </DT>
-<DD>Multimedia Internet Mail Exchange </DD>
-<DT>PPD </DT>
-<DD>PostScript Printer Description </DD>
-<DT>SMB </DT>
-<DD>Server Message Block </DD>
-<DT>TFTP </DT>
-<DD>Trivial File Transfer Protocol </DD>
+<DT>ASCII</DT>
+<DD>American Standard Code for Information Interchange</DD>
+<DT>CUPS</DT>
+<DD>Common UNIX Printing System</DD>
+<DT>ESC/P</DT>
+<DD>EPSON Standard Code for Printers</DD>
+<DT>FTP</DT>
+<DD>File Transfer Protocol</DD>
+<DT>HP-GL</DT>
+<DD>Hewlett-Packard Graphics Language</DD>
+<DT>HP-PCL</DT>
+<DD>Hewlett-Packard Page Control Language</DD>
+<DT>HP-PJL</DT>
+<DD>Hewlett-Packard Printer Job Language</DD>
+<DT>IETF</DT>
+<DD>Internet Engineering Task Force</DD>
+<DT>IPP</DT>
+<DD>Internet Printing Protocol</DD>
+<DT>ISO</DT>
+<DD>International Standards Organization</DD>
+<DT>LPD</DT>
+<DD>Line Printer Daemon</DD>
+<DT>MIME</DT>
+<DD>Multimedia Internet Mail Exchange</DD>
+<DT>PPD</DT>
+<DD>PostScript Printer Description</DD>
+<DT>SMB</DT>
+<DD>Server Message Block</DD>
+<DT>TFTP</DT>
+<DD>Trivial File Transfer Protocol</DD>
</DL>
<H1><A NAME="7">B Coding Requirements</A></H1>
- 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.
+ 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.
<H2><A NAME="7_1">B.1 Source Files</A></H2>
<H3><A NAME="7_1_1">B.1.1 Naming</A></H3>
- 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".
+ 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".
<H3><A NAME="7_1_2">B.1.2 Documentation</A></H3>
- 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:
+ 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:
<UL>
<PRE>
/*
*/
</PRE>
</UL>
- 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:
+ 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:
<UL>
<PRE>
/*
</UL>
<H2><A NAME="7_2">B.2 Functions</A></H2>
<H3><A NAME="7_2_1">B.2.1 Naming</A></H3>
- 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.)
-<P>Functions with a local scope shall be declared "static" and be
-lowercase with underscores between words ("do_this", "do_that",
-"do_something_else", etc.) </P>
+ 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.)
+<P>Functions with a local scope shall be declared "static" and be
+ lowercase with underscores between words ("do_this", "do_that",
+ "do_something_else", etc.)</P>
<H3><A NAME="7_2_2">B.2.2 Documentation</A></H3>
- 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:
+ 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:
<UL>
<PRE>
/*
</UL>
<H2><A NAME="7_3">B.3 Methods</A></H2>
<H3><A NAME="7_3_1">B.3.1 Naming</A></H3>
- Methods shall be in lowercase with underscores between words
-("do_this", "do_that", "do_something_else", etc.)
+ Methods shall be in lowercase with underscores between words
+ ("do_this", "do_that", "do_something_else", etc.)
<H3><A NAME="7_3_2">B.3.2 Documentation</A></H3>
- 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:
+ 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:
<UL>
<PRE>
/*
</UL>
<H2><A NAME="7_4">B.4 Variables</A></H2>
<H3><A NAME="7_4_1">B.4.1 Naming</A></H3>
- 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.
-<P>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". </P>
+ 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.
+<P>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".</P>
<H3><A NAME="7_4_2">B.4.2 Documentation</A></H3>
- Each variable shall be declared on a separate line and shall be
-immediately followed by a comment block describing the variable:
+ Each variable shall be declared on a separate line and shall be
+ immediately followed by a comment block describing the variable:
<UL>
<PRE>
int this_variable; /* The current state of this */
</UL>
<H2><A NAME="7_5">B.5 Types</A></H2>
<H3><A NAME="7_5_1">B.5.1 Naming</A></H3>
- 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.)
+ 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.)
<H3><A NAME="7_5_2">B.5.2 Documentation</A></H3>
- Each type shall have a comment block immediately before the typedef:
+ Each type shall have a comment block immediately before the typedef:
<UL>
<PRE>
/*
</UL>
<H2><A NAME="7_6">B.6 Structures</A></H2>
<H3><A NAME="7_6_1">B.6.1 Naming</A></H3>
- 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.)
+ 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.)
<H3><A NAME="7_6_2">B.6.2 Documentation</A></H3>
- 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:
+ 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:
<UL>
<PRE>
/*
</UL>
<H2><A NAME="7_7">B.7 Classes</A></H2>
<H3><A NAME="7_7_1">B.7.1 Naming</A></H3>
- All class names shall be lowercase with underscores between words
-("this_class", "that_class", etc.)
+ All class names shall be lowercase with underscores between words
+ ("this_class", "that_class", etc.)
<H3><A NAME="7_7_2">B.7.2 Documentation</A></H3>
- 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:
+ 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:
<UL>
<PRE>
/*
</UL>
<H2><A NAME="7_8">B.8 Constants</A></H2>
<H3><A NAME="7_8_1">B.8.1 Naming</A></H3>
- 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.)
-<P>Typed enumerations shall be used whenever possible to allow for type
-checking by the compiler. </P>
+ 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.)
+<P>Typed enumerations shall be used whenever possible to allow for type
+ checking by the compiler.</P>
<H3><A NAME="7_8_2">B.8.2 Documentation</A></H3>
- Comment blocks shall immediately follow each constant:
+ Comment blocks shall immediately follow each constant:
<UL>
<PRE>
enum
</UL>
<H2><A NAME="7_9">B.9 Code</A></H2>
<H3><A NAME="7_9_1">B.9.1 Documentation</A></H3>
- All source code shall utilize block comments within functions to
-describe the operations being performed by a group of statements:
+ All source code shall utilize block comments within functions to
+ describe the operations being performed by a group of statements:
<UL>
<PRE>
/*
</UL>
<H3><A NAME="7_9_2">B.9.2 Style</A></H3>
<H4 TYPE="a">B.9.2.a Indentation</H4>
- 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:
+ 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:
<UL>
<PRE>
{
}
</PRE>
</UL>
- 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:
+ 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:
<UL>
<PRE>
switch (array[i])
</PRE>
</UL>
<H4>B.9.2.b Spacing</H4>
- A space shall follow each reserved word ("if", "while", etc.) Spaces
-shall not be inserted between a function name and the arguments in
-parenthesis.
+ A space shall follow each reserved word ("if", "while", etc.) Spaces
+ shall not be inserted between a function name and the arguments in
+ parenthesis.
<H4>B.9.2.c Return Values</H4>
- Parenthesis shall surround values returned from a function using
-"return":
+ Parenthesis shall surround values returned from a function using
+ "return":
<UL>
<PRE>
return (STATE_IDLE);
</PRE>
</UL>
<H4>B.9.2.d Loops</H4>
- Whenever convenient loops should count downward to zero to improve
-program performance:
+ Whenever convenient loops should count downward to zero to improve
+ program performance:
<UL>
<PRE>
for (i = sizeof(array) / sizeof(array[0]) - 1; i >= 0; i --)
<TABLE WIDTH="80%">
<TR><TH ALIGN="RIGHT">Summary of Problem:</TH><TD ALIGN="LEFT">
________________________________________</TD></TR>
-<TR><TH ALIGN="RIGHT">Problem Severity:</TH><TD ALIGN="LEFT">__1=RFE
-<BR> __2=Documentation-Error
-<BR> __3=Unable-to-Print-a-File
-<BR> __4=Unable-to-Print-to-a-Printer
+<TR><TH ALIGN="RIGHT">Problem Severity:</TH><TD ALIGN="LEFT">__1=RFE
+<BR> __2=Documentation-Error
+<BR> __3=Unable-to-Print-a-File
+<BR> __4=Unable-to-Print-to-a-Printer
<BR> __5=Unable-to-Print-at-All</TD></TR>
-<TR><TH ALIGN="RIGHT">Problem Scope:</TH><TD ALIGN="LEFT">__1=Machine
-__2=Operating-System __3=All</TD></TR>
+<TR><TH ALIGN="RIGHT">Problem Scope:</TH><TD ALIGN="LEFT">__1=Machine
+ __2=Operating-System __3=All</TD></TR>
<TR><TH ALIGN="RIGHT" VALIGN="TOP">Detailed Description of Problem:</TH><TD
-ALIGN="LEFT">________________________________________
-<BR> ________________________________________
-<BR> ________________________________________
-<BR> ________________________________________
-<BR> ________________________________________
+ALIGN="LEFT">________________________________________
+<BR> ________________________________________
+<BR> ________________________________________
+<BR> ________________________________________
+<BR> ________________________________________
<BR> ________________________________________</TD></TR>
</TABLE>
</CENTER>
projects / thirdparty / cups.git / blobdiff