Documentation

This developer guide 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.

Communication

How to Contact the Developers

The CUPS Forums are the primary means of asking questions and informally discussing issues and feature requests with the CUPS developers. Table 1 shows the available forums and their focus:

How to Submit a Bug Report or Feature Request

The CUPS "Bugs & Features" page provides access to the CUPS software trouble report database and is the formal way to submit a bug report or feature request to the CUPS developers. Please note, however, that we do not provide answers to usage questions or resolve problems in third-party software on this page - use the CUPS Forums for that instead.

Unlike discussions that occur on the CUPS Forums, formal bug reports and feature requests must be acted on by the CUPS developers. This does not mean that every bug report is resolved or every feature request is implemented, but we do respond and keep track of them all for posterity.

Please use the search feature of the Bugs & Features page before submitting a new bug report or feature request. If you see an existing report that matches your issue, please post a message to that report ("I have this issue as well", "I would also like to see", etc.) rather than submitting a new report. This helps speed the resolution of your issue by reducing the CUPS developers' work load.

How to Prepare a Patch

When submitting a bug report or feature request, you can include patch files that resolve the bug or implement the feature to speed the inclusion of that bug fix or feature in a new CUPS release. For changes to existing files, we prefer a unified diff against the current Subversion trunk branch, which can be generated easily using the following Subversion command:

svn diff >filename.patch

If you produce a patch using a released source archive, use one of the following commands instead:

diff -u oldfilename filename >filename.patch

diff -urN olddirectory directory >filename.patch

New files and files with significant changes can be submitted in their entirety, however that may delay the adoption of your changes.

Patches and files must conform to the standards outlined in the "Coding Guidelines" and "Makefile Guidelines" 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.

Software Development Practices

Version Numbering

CUPS uses a three-part version number separated by periods to represent the major, minor, and patch release numbers. Major release numbers indicate large design changes or backwards-incompatible changes to the CUPS API or CUPS Imaging API. Minor release numbers indicate new features and other smaller changes which are backwards-compatible with previous CUPS releases. Patch numbers indicate bug fixes to the previous release.

When we talk about compatibility, we are talking about binary compatibility for public APIs and output format compatibility for program interfaces. Changes to configuration file formats or the default behavior of programs are not generally considered incompatible as the upgrade process can normally address such changes gracefully.

Production releases use the plain version numbers:

MAJOR.MINOR.PATCH
1.0.0
1.0.1
1.0.2
...
1.1.0
...
1.1.23
1.2.0
1.2.1
...
1.3.0
...
2.0.0

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.

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.

Beta-test releases are identified by appending the letter B to the major and minor version numbers followed by the beta release number:

MAJOR.MINORbNUMBER
1.2b1

Release candidates are identified by appending the letters RC to the major and minor version numbers followed by the release candidate number:

MAJOR.MINORrcNUMBER
1.2rc1

Developer snapshots are identified by appending the letters SVN-R to the major and minor version numbers followed by the revision number:

MAJOR.MINORsvn-rREV
1.2svn-r1234

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.

Version Control (Subversion)

The CUPS source files are managed by the Subversion ("SVN") software, available at:

subversion.tigris.org

Source files are "checked in" with each change so that modifications can be tracked, and each checkin must reference any applicable STRs. The following format must be used for commit log messages:

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")

bar.h:
    - More detailed changes

Primary development occurs on the trunk branch, with changes merged back to release branches as needed. Table 2 shows the URLs developers use for the various CUPS subprojects and branches:

The branch for a MAJOR.MINOR release are created when the first production release (MAJOR.MINOR.0) is made using the name "branch-MAJOR.MINOR". Release tags are created for every beta, candidate, and production release using the name "release-MAJOR.MINOR.PATCHbNUMBER", "release-MAJOR.MINOR.PATCHrcNUMBER", or "release-MAJOR.MINOR.PATCH", respectively. No release tags are created for developer snapshots.

Files and Directories

File and directory names may not exceed 16 characters in length to ensure compability with older UNIX filesystems. In addition, to avoid problems with case-insensitive filesystems, you may not use names which differ only by case, for example "ReadMe" and "README" are not allowed in the same directory.

Source files must be documented and formatted as described in "Coding Requirements". Make files must follow the guidelines in "Makefile Guidelines".

Build System

The CUPS build system uses GNU autoconf to tailor the library to the local operating system. Project files for major IDEs are also provided for Microsoft Windows^®. To improve portability, makefiles must not make use of the unique features offered by GNU make. See the Makefile Guidelines section for a description of the allowed make features and makefile guidelines.

Additional GNU build programs such as GNU automake and GNU libtool must not be used. GNU automake produces non-portable makefiles which depend on GNU-specific extensions, and GNU libtool is not portable or reliable enough for CUPS.

Packaging

Source packages are created using the tools/makesrcdist script in the Subversion repository. The script optionally uses a version number argument:

tools/makesrcdist
tools/makesrcdist version

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.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-version-source.tar.bz2" and "/tmp/cups-version-source.tar.gz".

Binary packages are not generally distributed by the CUPS team, however the packaging/cups.spec and packaging/cups.list files may be used to create binary packages on Linux, Mac OS X, and UNIX. The packaging/cups.spec file produces a binary package using the rpmbuild(8) software:

rpmbuild -ta cups-version-source.tar.gz

The cups.list file is generated by the configure script and produces binary packages for many platforms using the EPM software. Table 3 shows the targets that are available for each type of binary package:

Finally, the tools/testrpm and tools/testosx scripts can be used to create binary packages from the current working copy for testing on Linux and Mac OS X, respectively:

tools/testrpm
sudo rpm -U /usr/src/redhat/RPMS/i386/cups*.rpm

sudo tools/testosx
open cups.pkg

Testing

Software testing is conducted according to the CUPS Software Test Plan. This testing is automated via the top-level makefile test target:

make test

The test environment allows for both short-term automated testing and long-term testing and development without the automated test script.

Trouble Report Processing

A Software Trouble Report ("STR") must be submitted every time a user or vendor experiences a problem with the CUPS software. Trouble reports are maintained on the Bugs & Features page with one of the following states:

1. STR is closed with complete resolution
2. STR is closed without resolution
3. STR is active, waiting on information from submitter
4. STR is pending with additional information from submitter
5. STR is newly submitted

Trouble reports are processed using the following steps.

1. Classification

   When a trouble report is received it must be classified at one of the following priority levels:

   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

   Level 4 and 5 trouble reports must be resolved in the next software release. Level 2 and 3 trouble reports are scheduled for resolution in a specific release at the discretion of the release coordinator. Level 1 trouble reports are scheduled for resolution in a future feature release.

   The scope of the problem is also determined as:

   1. Specific to a machine or printer
   2. Specific to an operating system
   3. Applies to all machines, printers, and operating systems
2. Identification

   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).

3. Correction

   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.

4. Notification

   The user or vendor is notified when the fix is available or if the problem was caused by user error.

Release Management

When testing has been completed successfully, a new source package is created using the tools/makesrcdist script. Three types of releases, beta, candidate, and production, are created and released to the public using the basic schedule in Table 4. At least one beta and one release candidate must be created prior to a production release, and there must be at least two weeks between the last beta and first candidate and last candidate and first production release.

Coding Guidelines

These coding guidelines provide detailed information on source file formatting and documentation content and must be applied to all C and C++ source files provided with CUPS. Source code for other languages should conform to these guidelines as allowed by the language.

Source Files

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 Subversion "$Id$" tag:

/*
 * "$Id$"
 *
 *   Description of file contents.
 *
 *   Copyright 2007 by Apple Inc.
 *
 *   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:
 *
 *   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 Subversion "$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

Functions with a global scope shall have a lowercase prefix followed by capitalized words ("cupsDoThis", "cupsDoThat", "cupsDoSomethingElse", etc.) Private global functions shall begin with a leading underscore ("_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.

The Mini-XML documentation generator also understands the following special text in the function description comment:

• @since CUPS version@ - Marks the function as new in the specified version of CUPS.
• @deprecated@ - Marks the function as deprecated (not recommended for new development and scheduled for removal)

Variables

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 */

Types

All type names shall be lowercase with underscores between words and "_t" appended to the end of the name ("cups_this_type_t", "cups_that_type_t", etc.) Type names must start with a prefix, typically "cups" or the name of the program, to avoid conflicts with system types. Private type names must start with an underscore ("_cups_this_t", "_cups_that_t", etc.)

Each type shall have a comment block immediately after the typedef:

typedef int cups_this_type_t;           /* This type is for CUPS foobar options. */

Structures

All structure names shall be lowercase with underscores between words and "_s" appended to the end of the name ("cups_this_s", "cups_that_s", etc.) Structure names must start with a prefix, typically "cups" or the name of the program, to avoid conflicts with system types. Private structure names must start with an underscore ("_cups_this_s", "_cups_that_s", etc.)

Each structure shall have a comment block immediately after the struct and each member shall be documented in accordance with the variable naming policy above:

struct cups_this_struct_s               /* This structure is for CUPS foobar options. */
{
  int this_member;                      /* Current state for this */
  int that_member;                      /* Current state for that */
};

Constants

All constant names shall be uppercase with underscored between words ("CUPS_THIS_CONSTANT", "CUPS_THAT_CONSTANT", etc.) Constants must begin with an uppercase prefix, typically "CUPS" or the program name.

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 */
};

Code

All source code shall utilize block comments within functions to describe the operations being performed by a group of statements; avoid putting a comment per line unless absolutely necessary, and then consider refactoring the code so that it is not necessary:

/*
 * 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])));

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:

{
  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;
}

Spacing

A space shall follow each reserved word ("if", "while", etc.) Spaces shall not be inserted between a function name and the arguments in parenthesis.

Return Values

Parenthesis shall surround values returned from a function using "return":

return (CUPS_STATE_IDLE);

Loops

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] = CUPS_STATE_IDLE;

Makefile Guidelines

The following is a guide to the makefile-based build system used by CUPS. These standards have been developed over the years to allow CUPS to be built on as many systems and environments as possible.

General Organization

The CUPS source code is organized functionally into a top-level makefile, include file, and subdirectories each with their own makefile and dependencies files. The ".in" files are template files for the autoconf software and are used to generate a static version of the corresponding file.

Makefile Documentation

Each make file must start with the standard CUPS header containing the Subversion "$Id$" keyword, description of the file, and CUPS copyright and license notice:

#
# "$Id$"
#
#   Makefile for ...
#
#   Copyright 2007 by Apple Inc.
#
#   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/".
#

The end of each makefile must have a comment saying:

#
# End of "$Id$".
#

The purpose of the trailer is to indicate the end of the makefile so that truncations are immediately obvious.

Portable Makefile Construction

CUPS uses a common subset of make program syntax to ensure that the software can be compiled "out of the box" on as many systems as possible. The following is a list of assumptions we follow when constructing makefiles:

• Targets; we assume that the make program supports the notion of simple targets of the form "name:" that perform tab-indented commands that follow the target, e.g.:

  target:
  → target commands

• Dependencies; we assume that the make program supports recursive dependencies on targets, e.g.:

  target: foo bar
  → target commands
  
  foo: bla
  → foo commands
  
  bar:
  → bar commands
  
  bla:
  → bla commands

• Variable Definition; we assume that the make program supports variable definition on the command-line or in the makefile using the following form:

  name=value

• Variable Substitution; we assume that the make program supports variable substitution using the following forms:
  • $(name); substitutes the value of "name",
  • ($name:.old=.new); substitutes the value of "name" with the filename extensions ".old" changed to ".new",
  • $(MAKEFLAGS); substitutes the command-line options passed to the program without the leading hyphen (-),
  • $$; substitutes a single $ character,
  • $<; substitutes the current source file or dependency, and
  • $@; substitutes the current target name.
• Suffixes; we assume that the make program supports filename suffixes with assumed dependencies, e.g.:

  .SUFFIXES: .c .o
  .c.o:
  → $(CC) $(CFLAGS) -o $@ -c $<

• Include Files; we assume that the make program supports the include directive, e.g.:

  include ../Makedefs
  include Dependencies

• Comments; we assume that comments begin with a # character and proceed to the end of the current line.
• Line Length; we assume that there is no practical limit to the length of lines.
• Continuation of long lines; we assume that the \ character may be placed at the end of a line to concatenate two or more lines in a makefile to form a single long line.
• Shell; we assume a POSIX-compatible shell is present on the build system.

Standard Variables

The following variables are defined in the "Makedefs" file generated by the autoconf software:

• AR; the library archiver command,
• ARFLAGS; options for the library archiver command,
• BUILDROOT; optional installation prefix,
• MAN1EXT; extension for man pages in section 1,
• MAN3EXT; extension for man pages in section 3,
• MAN5EXT; extension for man pages in section 5,
• MAN7EXT; extension for man pages in section 7,
• MAN8DIR; subdirectory for man pages in section 8,
• MAN8EXT; extension for man pages in section 8,
• CC; the C compiler command,
• CFLAGS; options for the C compiler command,
• CXX; the C++ compiler command,
• CXXFLAGS; options for the C++ compiler command,
• DSOCOMMAND; the shared library building command,
• DSOFLAGS; options for the shared library building command,
• INSTALL; the install command,
• INSTALL_BIN; the program installation command,
• INSTALL_DATA; the data file installation command,
• INSTALL_DIR; the directory installation command,
• INSTALL_LIB; the library installation command,
• INSTALL_MAN; the documentation installation command,
• INSTALL_SCRIPT; the shell script installation command,
• LDFLAGS; options for the linker,
• LIBS; libraries for all programs,
• LN; the ln command,
• OPTIM; common compiler optimization options,
• RM; the rm command,
• SHELL; the sh (POSIX shell) command,
• STRIP; the strip command,
• bindir; the binary installation directory,
• datadir; the data file installation directory,
• exec_prefix; the installation prefix for executable files,
• libdir; the library installation directory,
• mandir; the man page installation directory,
• prefix; the installation prefix for non-executable files, and
• srcdir; the source directory.

Standard Targets

The following standard targets must be defined in each makefile:

• all; creates all target programs, libraries, and documentation files,
• clean; removes all target programs, libraries, documentation files, and object files,
• depend; generates automatic dependencies for any C or C++ source files (also see "Dependencies"),
• distclean; removes autoconf-generated files in addition to those removed by the "clean" target,
• install; installs all distribution files in their corresponding locations (also see "Install/Uninstall Support"),
• uninstall; removes all distribution files from their corresponding locations (also see "Install/Uninstall Support"), and

Object Files

Object files (the result of compiling a C or C++ source file) have the extension ".o".

Programs

Program files are the result of linking object files and libraries together to form an executable file. A typical program target looks like:

program: $(OBJS)
→ echo Linking $@...
→ $(CC) $(LDFLAGS) -o $@ $(OBJS) $(LIBS)

Static Libraries

Static libraries have a prefix of "lib" and the extension ".a". A typical static library target looks like:

libname.a: $(OBJECTS)
→ echo Creating $@...
→ $(RM) $@
→ $(AR) $(ARFLAGS) $@ $(OBJECTS)
→ $(RANLIB) $@

Shared Libraries

Shared libraries have a prefix of "lib" and the extension ".dylib", ".sl", ".so", or "_s.a" depending on the operating system. A typical shared library is composed of several targets that look like:

libname.so: $(OBJECTS)
→ echo $(DSOCOMMAND) libname.so.$(DSOVERSION) ...
→ $(DSOCOMMAND) libname.so.$(DSOVERSION) $(OBJECTS)
→ $(RM) libname.so libname.so.$(DSOMAJOR)
→ $(LN) libname.so.$(DSOVERSION) libname.so.$(DSOMAJOR)
→ $(LN) libname.so.$(DSOVERSION) libname.so

libname.sl: $(OBJECTS)
→ echo $(DSOCOMMAND) libname.sl.$(DSOVERSION) ...
→ $(DSOCOMMAND) libname.sl.$(DSOVERSION) $(OBJECTS)
→ $(RM) libname.sl libname.sl.$(DSOMAJOR)
→ $(LN) libname.sl.$(DSOVERSION) libname.sl.$(DSOMAJOR)
→ $(LN) libname.sl.$(DSOVERSION) libname.sl

libname.dylib: $(OBJECTS)
→ echo $(DSOCOMMAND) libname.$(DSOVERSION).dylib ...
→ $(DSOCOMMAND) libname.$(DSOVERSION).dylib \
→ → -install_name $(libdir)/libname.$(DSOMAJOR).dylib \
→ → -current_version libname.$(DSOVERSION).dylib \
→ → -compatibility_version $(DSOMAJOR).0 \
→ → $(OBJECTS) $(LIBS)
→ $(RM) libname.dylib
→ $(RM) libname.$(DSOMAJOR).dylib
→ $(LN) libname.$(DSOVERSION).dylib libname.$(DSOMAJOR).dylib
→ $(LN) libname.$(DSOVERSION).dylib libname.dylib

libname_s.a: $(OBJECTS)
→ echo $(DSOCOMMAND) libname_s.o ...
→ $(DSOCOMMAND) libname_s.o $(OBJECTS) $(LIBS)
→ echo $(LIBCOMMAND) libname_s.a libname_s.o
→ $(RM) $@
→ $(LIBCOMMAND) libname_s.a libname_s.o
→ $(CHMOD) +x libname_s.a

Dependencies

Static dependencies are expressed in each makefile following the target, for example:

foo: bar

Static dependencies shall only be used when it is not possible to automatically generate them. Automatic dependencies are stored in a file named "Dependencies" and included at the end of the makefile. The following "depend" target rule shall be used to create the automatic dependencies:

depend:
→ $(MAKEDEPEND) -Y -I.. -f Dependencies $(OBJS:.o=.c)

We only regenerate the automatic dependencies on a Linux system and express any non-Linux dependencies statically in the makefile.

Install/Uninstall Support

All makefiles must contain install and uninstall rules which install or remove the corresponding software. These rules must use the $(BUILDROOT) variable as a prefix to any installation directory so that CUPS can be installed in a temporary location for packaging by programs like rpmbuild.

The $(INSTALL_BIN), $(INSTALL_DATA), $(INSTALL_DIR), $(INSTALL_LIB), $(INSTALL_MAN), and $(INSTALL_SCRIPT) variables must be used when installing files so that the proper ownership and permissions are set on the installed files.

The $(RANLIB) command must be run on any static libraries after installation since the symbol table is invalidated when the library is copied on some platforms.