Google Git
Sign in
android / platform / external / libcups / ef416fc25c4af449e930416117bedb12fc9924ba / . / doc / cmp.html
blob: 7bd293c56f8fe1397f170853d7c44efe0f6481de [file] [log] [blame]
<!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>
<META NAME="author" CONTENT="Easy Software Products">
<META NAME="copyright" CONTENT="Copyright 1997-2005, 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 }
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 BGCOLOR="white">
<CENTER><A HREF="#CONTENTS"><IMG SRC="images/cups-large.gif" BORDER="0" WIDTH="431" HEIGHT="511" ALT="CUPS Configuration Management Plan"><BR>
<H1>CUPS Configuration Management Plan</H1></A><BR>
CUPS-CMP-1.1<BR>
Easy Software Products<BR>
Copyright 1997-2005, All Rights Reserved<BR>
</CENTER>
<HR NOSHADE>
<H1 ALIGN="CENTER"><A NAME="CONTENTS">Table of Contents</A></H1>
<BR>
<BR><B><A HREF="#1">1 Scope</A></B>
<UL>
<LI><A HREF="#1_1">1.1 Identification</A></LI>
<LI><A HREF="#1_2">1.2 System Overview</A></LI>
<LI><A HREF="#1_3">1.3 Document Overview</A></LI>
</UL>
<B><A HREF="#2">2 References</A></B>
<UL>
<LI><A HREF="#2_1">2.1 CUPS Documentation</A></LI>
<LI><A HREF="#2_2">2.2 Other Documents</A></LI>
</UL>
<B><A HREF="#3">3 File Management</A></B>
<UL>
<LI><A HREF="#3_1">3.1 Directory Structure</A></LI>
<LI><A HREF="#3_2">3.2 Source Files</A></LI>
<LI><A HREF="#3_3">3.3 Configuration Management</A></LI>
</UL>
<B><A HREF="#4">4 Trouble Report Processing</A></B>
<UL>
<LI><A HREF="#4_1">4.1 Classification</A></LI>
<LI><A HREF="#4_2">4.2 Identification</A></LI>
<LI><A HREF="#4_3">4.3 Correction</A></LI>
<LI><A HREF="#4_4">4.4 Notification</A></LI>
</UL>
<B><A HREF="#5">5 Software Releases</A></B>
<UL>
<LI><A HREF="#5_1">5.1 Version Numbering</A></LI>
<LI><A HREF="#5_2">5.2 Generation</A></LI>
<LI><A HREF="#5_3">5.3 Testing</A></LI>
<LI><A HREF="#5_4">5.4 Releases</A>
<UL>
<LI><A HREF="#5_4_1">5.4.1 Beta Releases</A></LI>
<LI><A HREF="#5_4_2">5.4.2 Release Candidates</A></LI>
<LI><A HREF="#5_4_3">5.4.3 Production Releases</A></LI>
</UL>
</LI>
</UL>
<B><A HREF="#6">A Glossary</A></B>
<UL>
<LI><A HREF="#6_1">A.1 Terms</A></LI>
<LI><A HREF="#6_2">A.2 Acronyms</A></LI>
</UL>
<B><A HREF="#7">B Coding Requirements</A></B>
<UL>
<LI><A HREF="#7_1">B.1 Source Files</A>
<UL>
<LI><A HREF="#7_1_1">B.1.1 Naming</A></LI>
<LI><A HREF="#7_1_2">B.1.2 Documentation</A></LI>
</UL>
</LI>
<LI><A HREF="#7_2">B.2 Functions</A>
<UL>
<LI><A HREF="#7_2_1">B.2.1 Naming</A></LI>
<LI><A HREF="#7_2_2">B.2.2 Documentation</A></LI>
</UL>
</LI>
<LI><A HREF="#7_3">B.3 Methods</A>
<UL>
<LI><A HREF="#7_3_1">B.3.1 Naming</A></LI>
<LI><A HREF="#7_3_2">B.3.2 Documentation</A></LI>
</UL>
</LI>
<LI><A HREF="#7_4">B.4 Variables</A>
<UL>
<LI><A HREF="#7_4_1">B.4.1 Naming</A></LI>
<LI><A HREF="#7_4_2">B.4.2 Documentation</A></LI>
</UL>
</LI>
<LI><A HREF="#7_5">B.5 Types</A>
<UL>
<LI><A HREF="#7_5_1">B.5.1 Naming</A></LI>
<LI><A HREF="#7_5_2">B.5.2 Documentation</A></LI>
</UL>
</LI>
<LI><A HREF="#7_6">B.6 Structures</A>
<UL>
<LI><A HREF="#7_6_1">B.6.1 Naming</A></LI>
<LI><A HREF="#7_6_2">B.6.2 Documentation</A></LI>
</UL>
</LI>
<LI><A HREF="#7_7">B.7 Classes</A>
<UL>
<LI><A HREF="#7_7_1">B.7.1 Naming</A></LI>
<LI><A HREF="#7_7_2">B.7.2 Documentation</A></LI>
</UL>
</LI>
<LI><A HREF="#7_8">B.8 Constants</A>
<UL>
<LI><A HREF="#7_8_1">B.8.1 Naming</A></LI>
<LI><A HREF="#7_8_2">B.8.2 Documentation</A></LI>
</UL>
</LI>
<LI><A HREF="#7_9">B.9 Code</A>
<UL>
<LI><A HREF="#7_9_1">B.9.1 Documentation</A></LI>
<LI><A HREF="#7_9_2">B.9.2 Style</A></LI>
</UL>
</LI>
</UL>
<B><A HREF="#8">C Software Trouble Report Form</A></B><HR NOSHADE>
<H1><A NAME="1">1 Scope</A></H1>
<H2><A NAME="1_1">1.1 Identification</A></H2>
<P>This configuration management plan document provides the guidelines
for development and maintenance of the Common UNIX Printing System
(&quot;CUPS&quot;) Version 1.1 software.</P>
<H2><A NAME="1_2">1.2 System Overview</A></H2>
<P>CUPS provides a portable printing layer for UNIX&reg;-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 (&quot;IPP&quot;) as the basis for
managing print jobs and queues. The Line Printer Daemon (&quot;LPD&quot;) Server
Message Block (&quot;SMB&quot;), and AppSocket (a.k.a. JetDirect) protocols are
also supported with reduced functionality. CUPS adds network printer
browsing and PostScript Printer Description (&quot;PPD&quot;) based printing
options to support real-world printing under UNIX.</P>
<P>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.</P>
<P>Drivers for thousands of printers are provided with our ESP Print Pro
software, available at:</P>
<PRE>
<A HREF="http://www.easysw.com/printpro/">http://www.easysw.com/printpro/</A>
</PRE>
<P>CUPS is licensed under the GNU General Public License and GNU Library
General Public License. Please contact Easy Software Products for
commercial support and &quot;binary distribution&quot; rights.</P>
<H2><A NAME="1_3">1.3 Document Overview</A></H2>
<P>This configuration management document is organized into the
following sections:</P>
<UL>
<LI>1 - Scope</LI>
<LI>2 - References</LI>
<LI>3 - File Management</LI>
<LI>4 - Trouble Report Processing</LI>
<LI>5 - Software Releases</LI>
<LI>A - Glossary</LI>
<LI>B - Coding Requirements</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>
</UL>
<H2><A NAME="2_2">2.2 Other Documents</A></H2>
<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>
<LI><A HREF="http://partners.adobe.com/asn/developer/PDFS/TN/PLRM.pdf">
Adobe PostScript Language Reference, Third Edition.</A></LI>
<LI>IPP/1.1: Implementers Guide</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/rfc2396.txt">RFC 2396, Uniform
Resource Identifiers (URI): Generic Syntax</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 for the Internet Printing
Protocol</A></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>
<LI><A HREF="http://www.ietf.org/rfc/rfc2910.txt">RFC 2910, IPP/1.1:
Encoding and Transport</A></LI>
<LI><A HREF="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911, IPP/1.1:
Model and Semantics</A></LI>
<LI><A HREF="http://www.ietf.org/rfc/rfc3380.txt">RFC 3380, IPP: Job and
Printer Set Operations</A></LI>
</UL>
<H1><A NAME="3">3 File Management</A></H1>
<H2><A NAME="3_1">3.1 Directory Structure</A></H2>
<P>Each source file shall be placed a sub-directory corresponding to the
software sub-system it belongs to (&quot;scheduler&quot;, &quot;cups&quot;, etc.) To remain
compatible with older UNIX filesystems, directory names shall not
exceed 16 characters in length.</P>
<H2><A NAME="3_2">3.2 Source Files</A></H2>
<P>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.</P>
<H2><A NAME="3_3">3.3 Configuration Management</A></H2>
<P>Source files shall be placed under the control of the Concurrent
Versions System (&quot;CVS&quot;) software. Source files shall be &quot;checked in&quot;
with each change so that modifications can be tracked.</P>
<P>Documentation on the CVS software is included with the whitepaper,
&quot;CVS II: Parallelizing Software Development&quot;.</P>
<H1><A NAME="4">4 Trouble Report Processing</A></H1>
<P>A Software Trouble Report (&quot;STR&quot;) 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:</P>
<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>
<P>Trouble reports shall be processed using the following steps.</P>
<H2><A NAME="4_1">4.1 Classification</A></H2>
<P>When a trouble report is received it must be classified at one of the
following priority levels:</P>
<OL>
<LI>Request for enhancement, e.g. asking for a feature</LI>
<LI>Low, e.g. a documentation error or undocumented side-effect</LI>
<LI>Moderate, e.g. unable to print a file or unable to compile the
software</LI>
<LI>High, e.g. unable to print to a printer or key functionality not
working</LI>
<LI>Critical, e.g. unable to print at all</LI>
</OL>
<P>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.</P>
<P>The scope of the problem should also be determined as:</P>
<OL>
<LI>Specific to a machine or printer</LI>
<LI>Specific to an operating system</LI>
<LI>Applies to all machines, printers, and operating systems</LI>
</OL>
<H2><A NAME="4_2">4.2 Identification</A></H2>
<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>
<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>
<P>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.</P>
<H2><A NAME="4_4">4.4 Notification</A></H2>
<P>The user or vendor is notified when the fix is available or if the
problem was caused by user error.</P>
<H1><A NAME="5">5 Software Releases</A></H1>
<H2><A NAME="5_1">5.1 Version Numbering</A></H2>
<P>CUPS uses a three-part version number separated by periods to
represent the major, minor, and patch release numbers:</P>
<PRE>
MAJOR.MINOR.PATCH
1.1.0
</PRE>
<P>Beta-test releases are indentified by appending the letter B followed
by the build number:</P>
<PRE>
MAJOR.MINOR.PATCHbBUILD
1.1.0b1
</PRE>
<P>Release candidates are indentified by appending the letters RC
followed by the build number:</P>
<PRE>
MAJOR.MINOR.PATCHrcBUILD
1.1.0rc1
</PRE>
<P>A CVS snapshot is generated for every beta and final release and uses
the version number preceded by the letter &quot;v&quot; and with the decimal
points replaced by underscores:</P>
<PRE>
v1_1_0b1
v1_1_0rc1
v1_1_0
</PRE>
<P>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:</P>
<PRE>
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
</PRE>
<H2><A NAME="5_2">5.2 Generation</A></H2>
<P>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.</P>
<H2><A NAME="5_3">5.3 Testing</A></H2>
<P>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.</P>
<H2><A NAME="5_4">5.4 Releases</A></H2>
<P>When testing has been completed successfully a new distribution image
is created from the current CVS code &quot;snapshot&quot;. 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:
<CENTER>
<TABLE BORDER="1">
<TR><TH>Week</TH><TH>Version</TH><TH>Description</TH></TR>
<TR><TD>T-6 weeks</TD><TD>1.1.0b1</TD><TD>First beta</TD></TR>
<TR><TD>T-5 weeks</TD><TD>1.1.0b2</TD><TD>Second beta</TD></TR>
<TR><TD>T-4 weeks</TD><TD>1.1.0b3</TD><TD>Third beta</TD></TR>
<TR><TD>T-3 weeks</TD><TD>1.1.0rc1</TD><TD>First release candidate</TD></TR>
<TR><TD>T-2 weeks</TD><TD>1.1.0rc2</TD><TD>Second release candidate</TD></TR>
<TR><TD>T-0 weeks</TD><TD>1.1.0</TD><TD>Production</TD></TR>
</TABLE>
</CENTER>
</P>
<P>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.</P>
<H3><A NAME="5_4_1">5.4.1 Beta Releases</A></H3>
<P>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.</P>
<P>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.</P>
<H3><A NAME="5_4_2">5.4.2 Release Candidates</A></H3>
<P>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.</P>
<P>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.</P>
<H3><A NAME="5_4_3">5.4.3 Production Releases</A></H3>
<P>Production releases are generated after a successful release
candidate and represent a stable release of the software suitable for
all users.</P>
<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>
</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>
</DL>
<H1><A NAME="7">B Coding Requirements</A></H1>
<P>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.</P>
<H2><A NAME="7_1">B.1 Source Files</A></H2>
<H3><A NAME="7_1_1">B.1.1 Naming</A></H3>
<P>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 &quot;.c&quot; for ANSI C and
&quot;.cxx&quot; for C++ source files. All other &quot;include&quot; files shall have an
extension of &quot;.h&quot;.</P>
<H3><A NAME="7_1_2">B.1.2 Documentation</A></H3>
<P>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 &quot;$Id$&quot; tag:</P>
<PRE>
/*
* &quot;$Id$&quot;
*
* Description of file contents.
*
* Copyright 1997-2005 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 &quot;LICENSE.txt&quot; 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 USA
*
* Voice: (301) 373-9600
* EMail: [email protected]
* WWW: http://www.cups.org
*
* Contents:
*
* function1() - Description 1.
* function2() - Description 2.
* function3() - Description 3.
*/
</PRE>
<!-- NEED 1in -->
<P>For source files that are subject to the Apple OS-Developed Software
exception, the following additional comment should appear after the
contact information:</P>
<PRE>
* This file is subject to the Apple OS-Developed Software exception.
</PRE>
<P>The bottom of each source file shall contain a trailer giving the
name of the file using the CVS &quot;$Id$&quot; 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:</P>
<PRE>
/*
* End of &quot;$Id$&quot;.
*/
</PRE>
<H2><A NAME="7_2">B.2 Functions</A></H2>
<H3><A NAME="7_2_1">B.2.1 Naming</A></H3>
<P>Functions with a global scope shall be capitalized (&quot;DoThis&quot;,
&quot;DoThat&quot;, &quot;DoSomethingElse&quot;, etc.) The only exception to this rule
shall be the CUPS interface library functions which may begin with a
prefix word in lowercase (&quot;cupsDoThis&quot;, &quot;cupsDoThat&quot;, etc.)</P>
<P>Functions with a local scope shall be declared &quot;static&quot; and be
lowercase with underscores between words (&quot;do_this&quot;, &quot;do_that&quot;,
&quot;do_something_else&quot;, etc.)</P>
<H3><A NAME="7_2_2">B.2.2 Documentation</A></H3>
<P>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:</P>
<PRE>
/*
* 'do_this()' - Compute y = this(x).
*
* Notes: none.
*/
static float /* O - Inverse power value, 0.0 &lt;= y &lt;= 1.1 */
do_this(float x) /* I - Power value (0.0 &lt;= x &lt;= 1.1) */
{
...
return (y);
}
</PRE>
<P>Return/output values are indicated using an &quot;O&quot; prefix, input values
are indicated using the &quot;I&quot; prefix, and values that are both input and
output use the &quot;IO&quot; prefix for the corresponding in-line comment.</P>
<H2><A NAME="7_3">B.3 Methods</A></H2>
<H3><A NAME="7_3_1">B.3.1 Naming</A></H3>
<P>Methods shall be in lowercase with underscores between words
(&quot;do_this&quot;, &quot;do_that&quot;, &quot;do_something_else&quot;, etc.)</P>
<H3><A NAME="7_3_2">B.3.2 Documentation</A></H3>
<P>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:</P>
<PRE>
/*
* 'class::do_this()' - Compute y = this(x).
*
* Notes: none.
*/
float /* O - Inverse power value, 0.0 &lt;= y &lt;= 1.0 */
class::do_this(float x) /* I - Power value (0.0 &lt;= x &lt;= 1.0) */
{
...
return (y);
}
</PRE>
<P>Return/output values are indicated using an &quot;O&quot; prefix, input values
are indicated using the &quot;I&quot; prefix, and values that are both input and
output use the &quot;IO&quot; prefix for the corresponding in-line comment.</P>
<H2><A NAME="7_4">B.4 Variables</A></H2>
<H3><A NAME="7_4_1">B.4.1 Naming</A></H3>
<P>Variables with a global scope shall be capitalized (&quot;ThisVariable&quot;,
&quot;ThatVariable&quot;, &quot;ThisStateVariable&quot;, etc.) The only exception to this
rule shall be the CUPS interface library global variables which must
begin with the prefix &quot;cups&quot; (&quot;cupsThisVariable&quot;, &quot;cupsThatVariable&quot;,
etc.) Global variables shall be replaced by function arguments whenever
possible.</P>
<P>Variables with a local scope shall be lowercase with underscores
between words (&quot;this_variable&quot;, &quot;that_variable&quot;, etc.) Any local
variables shared by functions within a source file shall be declared
&quot;static&quot;.</P>
<H3><A NAME="7_4_2">B.4.2 Documentation</A></H3>
<P>Each variable shall be declared on a separate line and shall be
immediately followed by a comment block describing the variable:</P>
<PRE>
int this_variable; /* The current state of this */
int that_variable; /* The current state of that */
</PRE>
<H2><A NAME="7_5">B.5 Types</A></H2>
<H3><A NAME="7_5_1">B.5.1 Naming</A></H3>
<P>All type names shall be lowercase with underscores between words and
&quot;_t&quot; appended to the end of the name (&quot;this_type_t&quot;, &quot;that_type_t&quot;,
etc.)</P>
<H3><A NAME="7_5_2">B.5.2 Documentation</A></H3>
<P>Each type shall have a comment block immediately before the typedef:</P>
<PRE>
/*
* This type is for CUPS foobar options.
*/
typedef int cups_this_type_t;
</PRE>
<H2><A NAME="7_6">B.6 Structures</A></H2>
<H3><A NAME="7_6_1">B.6.1 Naming</A></H3>
<P>All structure names shall be lowercase with underscores between words
and &quot;_str&quot; appended to the end of the name (&quot;this_struct_str&quot;,
&quot;that_struct_str&quot;, etc.)</P>
<H3><A NAME="7_6_2">B.6.2 Documentation</A></H3>
<P>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:</P>
<PRE>
/*
* 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 */
};
</PRE>
<H2><A NAME="7_7">B.7 Classes</A></H2>
<H3><A NAME="7_7_1">B.7.1 Naming</A></H3>
<P>All class names shall be lowercase with underscores between words
(&quot;this_class&quot;, &quot;that_class&quot;, etc.)</P>
<H3><A NAME="7_7_2">B.7.2 Documentation</A></H3>
<P>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:</P>
<PRE>
/*
* 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 */
};
</PRE>
<H2><A NAME="7_8">B.8 Constants</A></H2>
<H3><A NAME="7_8_1">B.8.1 Naming</A></H3>
<P>All constant names shall be uppercase with underscored between words
(&quot;THIS_CONSTANT&quot;, &quot;THAT_CONSTANT&quot;, etc.) Constants defined for the CUPS
interface library must begin with an uppercase prefix
(&quot;CUPS_THIS_CONSTANT&quot;, &quot;CUPS_THAT_CONSTANT&quot;, etc.)</P>
<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>
<P>Comment blocks shall immediately follow each constant:</P>
<PRE>
enum
{
CUPS_THIS_TRAY, /* This tray */
CUPS_THAT_TRAY /* That tray */
};
</PRE>
<H2><A NAME="7_9">B.9 Code</A></H2>
<H3><A NAME="7_9_1">B.9.1 Documentation</A></H3>
<P>All source code shall utilize block comments within functions to
describe the operations being performed by a group of statements:</P>
<PRE>
/*
* Clear the state array before we begin...
*/
for (i = 0; i &lt; (sizeof(array) / sizeof(sizeof(array[0])); i ++)
array[i] = STATE_IDLE;
/*
* Wait for state changes...
*/
do
{
for (i = 0; i &lt; (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])));
</PRE>
<H3><A NAME="7_9_2">B.9.2 Style</A></H3>
<H4 TYPE="a">B.9.2.a Indentation</H4>
<P>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:</P>
<PRE>
{
int i; /* Looping var */
/*
* Process foobar values from 0 to 999...
*/
for (i = 0; i &lt; 1000; i ++)
{
do_this(i);
do_that(i);
}
}
</PRE>
<P>Single-line statements following &quot;do&quot;, &quot;else&quot;, &quot;for&quot;, &quot;if&quot;, and
&quot;while&quot; shall be indented 2 spaces as well. Blocks of code in a
&quot;switch&quot; block shall be indented 4 spaces after each &quot;case&quot; and
&quot;default&quot; case:</P>
<PRE>
switch (array[i])
{
case STATE_IDLE :
do_this(i);
do_that(i);
break;
default :
do_nothing(i);
break;
}
</PRE>
<H4>B.9.2.b Spacing</H4>
<P>A space shall follow each reserved word (&quot;if&quot;, &quot;while&quot;, etc.) Spaces
shall not be inserted between a function name and the arguments in
parenthesis.</P>
<H4>B.9.2.c Return Values</H4>
<P>Parenthesis shall surround values returned from a function using
&quot;return&quot;:</P>
<PRE>
return (STATE_IDLE);
</PRE>
<H4>B.9.2.d Loops</H4>
<P>Whenever convenient loops should count downward to zero to improve
program performance:</P>
<PRE>
for (i = sizeof(array) / sizeof(array[0]) - 1; i &gt;= 0; i --)
array[i] = STATE_IDLE;
</PRE>
<H1 ALIGN="RIGHT"><A NAME="8">C Software Trouble Report Form</A></H1>
<CENTER>
<TABLE WIDTH="80%">
<TR><TH ALIGN="RIGHT">Summary of Problem:</TH><TD COLSPAN="2">
_____________________________________________</TD></TR>
<TR><TD COLSPAN="3">&nbsp;</TD></TR>
<TR><TH ALIGN="RIGHT" ROWSPAN="5" VALIGN="TOP">Problem Severity:</TH><TD>
__1</TD><TD>Request for enhancement, e.g. asking for a feature</TD></TR>
<TR><TD>__2</TD><TD>Low, e.g. a documentation error or undocumented
side-effect</TD></TR>
<TR><TD>__3</TD><TD>Moderate, e.g. unable to print a file or unable to
compile the software</TD></TR>
<TR><TD>__4</TD><TD>High, e.g. unable to print to a printer or key
functionality not working</TD></TR>
<TR><TD>__5</TD><TD>Critical, e.g. unable to print at all</TD></TR>
<TR><TD COLSPAN="3">&nbsp;</TD></TR>
<TR><TH ALIGN="RIGHT" ROWSPAN="3" VALIGN="TOP">Problem Scope:</TH><TD>
__1</TD><TD>Machine or printer</TD></TR>
<TR><TD>__2</TD><TD>Operating System</TD></TR>
<TR><TD>__3</TD><TD>All machines, printers, or operating systems</TD></TR>
<TR><TD COLSPAN="3">&nbsp;</TD></TR>
<TR><TH ALIGN="RIGHT" VALIGN="TOP">Detailed Description of Problem:</TH><TD
COLSPAN="2">_____________________________________________
<BR> _____________________________________________
<BR> _____________________________________________
<BR> _____________________________________________
<BR> _____________________________________________</TD></TR>
</TABLE>
</CENTER>
</BODY>
</HTML>