+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<!-- SECTION: Specifications -->
<HEAD>
- <TITLE>CUPS Configuration Management Plan</TITLE>
+ <TITLE>CUPS Developer Guide</TITLE>
+ <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
</HEAD>
<BODY>
-<P>This configuration management plan documents the guidelines
-and processes we use when developing and maintaining the Common
-UNIX Printing System ("CUPS") and related software. Our goal is
-to provide reliable and efficient software and documentation that
-addresses the needs of our users.</P>
+<H1 CLASS="title">CUPS Developer Guide</H1>
+
+<P>This developer guide documents the guidelines and processes we use when developing and maintaining CUPS and related software. Our goal is to provide reliable and efficient software and documentation that addresses the needs of our users.</P>
<H2 CLASS="title"><A NAME="COMMUNICATION">Communication</A></H2>
in their entirety, however that may delay the adoption of your
changes.</P>
-<BLOCKQUOTE>Patches and files must conform to the standards
-outlined in the "<A HREF="#CODING">Coding Guidelines</A>" and "<A
-HREF="#MAKEFILES">Makefile Guidelines</A>" sections in this
-document. In addition, since Easy Software Products provides CUPS
-under multiple licenses, we require that you assign the copyright
-for your changes and files to us for inclusion in
-CUPS.</BLOCKQUOTE>
+<BLOCKQUOTE>Patches and files must conform to the standards outlined in the
+"<A HREF="#CODING">Coding Guidelines</A>" and "<A HREF="#MAKEFILES">Makefile
+Guidelines</A>" sections in this document. In addition, since Apple Inc.
+provides CUPS under multiple licenses, we require that you assign the copyright
+for your changes and files to us for inclusion in CUPS.</BLOCKQUOTE>
<H2 CLASS="title"><A NAME="PRACTICES">Software Development Practices</A></H2>
2.0.0
</PRE>
-<P>The first production release in a MAJOR.MINOR series
-(MAJOR.MINOR.0) is called a feature release. Feature releases are
-the only releases that may contain new features. Subsequent
-production releases in a MAJOR.MINOR series may only contain bug
-fixes.</P>
+<P>The first production release in a MAJOR.MINOR series (MAJOR.MINOR.0) is
+called a feature release. Feature releases are the only releases that may
+contain new features. Subsequent production releases in a MAJOR.MINOR series may
+only contain bug fixes.</P>
-<BLOCKQUOTE>We did not hold to this limitation in the CUPS 1.1
-series for a variety of reasons. Starting with CUPS 1.2, the "no
-new features in a patch release" policy will be strictly
-enforced. This should yield more frequent minor releases with
-fewer new features (and interactions!) to
-validate/test.</BLOCKQUOTE>
+<BLOCKQUOTE>We did not hold to this limitation in the CUPS 1.1 series for a
+variety of reasons. Starting with CUPS 1.2, the "no new features in a patch
+release" policy has been strictly enforced. The policy has also resulted in
+fewer new features (and interactions!) to validate/test in the subsequence
+feature releases.</BLOCKQUOTE>
-<P>Beta-test releases are identified by appending the letter B
-to the major and minor version numbers followed by the beta
-release number:</P>
+<P>Beta-test releases are identified by appending the letter B to the major and
+minor version numbers followed by the beta release number:</P>
<PRE CLASS="command">
MAJOR.MINORbNUMBER
1.2b1
</PRE>
-<P>Release candidates are identified by appending the letters RC
-to the major and minor version numbers followed by the release
-candidate number:</P>
+<P>Release candidates are identified by appending the letters RC to the major
+and minor version numbers followed by the release candidate number:</P>
<PRE CLASS="command">
MAJOR.MINORrcNUMBER
1.2rc1
</PRE>
-<P>Developer snapshots are identified by appending the letters
-SVN-R to the major and minor version numbers followed by the
-revision number:</P>
+<P>Developer snapshots are identified by appending the letters SVN-R to the
+major and minor version numbers followed by the revision number:</P>
<PRE CLASS="command">
MAJOR.MINORsvn-rREV
1.2svn-r1234
</PRE>
-<P>Beta-test releases, release candidates, and developer
-snapshots are only created for new minor releases. Once a
-production release has been made (MAJOR.MINOR.0), subsequent
-patch releases are issues without preliminary beta or release
-testing.</P>
+<P>Beta-test releases, release candidates, and developer snapshots are only
+created for new minor releases. Once a production release has been made
+(MAJOR.MINOR.0), subsequent patch releases are issues without preliminary beta
+or release testing.</P>
<H3>Version Control (Subversion)</H3>
commit log messages:</P>
<PRE CLASS="command">
-Summary of the change ("fix PostScript printing bug") along
-with corresponding STRs ("STR #1, STR #6")
-
-foo.cxx:
- - function(): Detailed list of changes
- - function2(): Detailed list of changes
- - Summary of design changes ("added new foo struct")
+Summary of the change on one line followed by bug number (STR #NNNN)
-bar.h:
- - More detailed changes
+Detailed list of changes.
</PRE>
<P>Primary development occurs on the <var>trunk</var> branch,
HREF="http://www.gnu.org/software/autoconf/">GNU autoconf</A> to
tailor the library to the local operating system. Project files
for major IDEs are also provided for Microsoft
-Windows<suP>®</suP>. To improve portability, makefiles must
+Windows<SUP>®</SUP>. To improve portability, makefiles must
not make use of the unique features offered by <A
HREF="http://www.gnu.org/software/make/">GNU make</A>. See the <A
HREF="#MAKEFILES">Makefile Guidelines</A> section for a
<P>When run with no arguments, the script creates a snapshot of
the current working copy and names it using the highest revision
number in the WC, for example
-"/tmp/cups-1.2svn-r1234-source.tar.bz2" and
-"/tmp/cups-1.2svn-r1234-source.tar.gz". When run with two
+"/tmp/cups-1.3svn-r1234-source.tar.bz2" and
+"/tmp/cups-1.3svn-r1234-source.tar.gz". When run with two
arguments, the script creates a release tag in the repository and
exports that tag, creating the files
"/tmp/cups-<I>version</I>-source.tar.bz2" and
<P>Binary packages are not generally distributed by the CUPS
team, however the <VAR>packaging/cups.spec</VAR> and
<VAR>packaging/cups.list</VAR> files may be used to create binary
-packages on Linux, MacOS X, and UNIX. The
+packages on Linux, Mac OS X, and UNIX. The
<VAR>packaging/cups.spec</VAR> file produces a binary package
using the <CODE>rpmbuild(8)</CODE> software:</P>
</TR>
<TR>
<TD>osx</TD>
- <TD>MacOS X Install</TD>
+ <TD>Mac OS X Install</TD>
</TR>
<TR>
<TD>pkg</TD>
<P>Finally, the <VAR>tools/testrpm</VAR> and
<VAR>tools/testosx</VAR> scripts can be used to create binary
packages from the current working copy for testing on Linux and
-MacOS X, respectively:</P>
+Mac OS X, respectively:</P>
<PRE CLASS="command">
tools/testrpm
*
* Description of file contents.
*
- * Copyright yyyy-YYYY 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 USA
+ * Copyright 2010 by Apple Inc.
*
- * Voice: (301) 373-9600
- * EMail: cups-info@cups.org
- * WWW: http://www.cups.org/
+ * These coded instructions, statements, and computer programs are the
+ * property of Apple Inc. 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
+ * file is missing or damaged, see the license at "http://www.cups.org/".
*
* Contents:
*
<UL>
- <LI><CODE>@since CUPS <I>version</I>@</CODE> - Marks the
- function as new in the specified version of CUPS.</LI>
-
<LI><CODE>@deprecated@</CODE> - Marks the function as
deprecated (not recommended for new development and
scheduled for removal)</LI>
+ <LI><CODE>@since CUPS <I>version</I>@</CODE> - Marks the
+ function as new in the specified version of CUPS.</LI>
+
+ <LI><CODE>@private@</CODE> - Marks the function as private.</LI>
+
</UL>
<H3>Variables</H3>
#
# Makefile for ...
#
-# Copyright yyyy-YYYY 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 USA
+# Copyright 2007 by Apple Inc.
#
-# Voice: (301) 373-9600
-# EMail: cups-info@cups.org
-# WWW: http://www.cups.org/
+# These coded instructions, statements, and computer programs are the
+# property of Apple Inc. 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
+# file is missing or damaged, see the license at "http://www.cups.org/".
#
</PRE>
projects / thirdparty / cups.git / blobdiff