Skip to content

Commit 69e37fb

Browse files
committed
Update top-level documentation files in preparation for the 2.3.0 release.
1 parent 05690fd commit 69e37fb

File tree

5 files changed

+57
-39
lines changed

5 files changed

+57
-39
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@ Contributing to CUPS
22
====================
33

44
CUPS is developed by Apple Inc. and distributed as open source software under
5-
the Apache License, Version 2.0. Significant contributions to CUPS must be
6-
licensed to Apple using the Apple Contributor Agreement:
5+
the Apache License, Version 2.0 with exceptions to allow linking to GPL2/LGPL2
6+
code. Significant contributions to CUPS must be licensed to Apple using the
7+
Apple Contributor Agreement:
78

89
https://www.cups.org/AppleContributorAgreement_2011-03-10.pdf
910

10-
Contributions should be submitted as attachments to bug reports on the CUPS web
11-
site. Changes to existing source files should be submitted as unified diffs
12-
(both Subversion and Git produce this format by default) while new source files
11+
Contributions should be submitted as attachments to bug reports on the
12+
[CUPS Github project](https://github.com/apple/cups). Changes to existing
13+
source files should be submitted as unified diffs while new source files
1314
should be provided as-is or in an archive. Github pull requests can also be
1415
used to submit changes.

CREDITS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
CREDITS - 2017-05-01
1+
CREDITS - 2019-08-21
22
====================
33

44
Few projects are completed by one person, and CUPS is no exception. We'd like

DEVELOPING.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ major, minor, and patch release numbers. Major release numbers indicate large
6363
design changes or backwards-incompatible changes to the CUPS API or CUPS
6464
Imaging API. Minor release numbers indicate new features and other smaller
6565
changes which are backwards-compatible with previous CUPS releases. Patch
66-
numbers indicate bug fixes to the previous feature or patch release.
66+
numbers indicate bug fixes to the previous feature or patch release. This
67+
version numbering scheme is consistent with the
68+
[Semantic Versioning](http://semver.org) specification.
6769

6870
> Note:
6971
>
@@ -114,6 +116,10 @@ Contributed source code must follow the guidelines below. While the examples
114116
are for C and C++ source files, source code for other languages should conform
115117
to the same guidelines as allowed by the language.
116118

119+
Source code comments provide the reference portion of the CUPS Programming
120+
Manual, which is generated using the [codedoc](https://msweet.org/codedoc)
121+
software.
122+
117123

118124
### Source Files
119125

@@ -270,15 +276,17 @@ Return/output values are indicated using an "O" prefix, input values are
270276
indicated using the "I" prefix, and values that are both input and output use
271277
the "IO" prefix for the corresponding in-line comment.
272278

273-
The Mini-XML documentation generator also understands the following special
274-
text in the function description comment:
279+
The [codedoc](https://msweet.org/codedoc) documentation generator also
280+
understands the following special text in the function description comment:
275281

276-
@deprecated@ - Marks the function as deprecated (not recommended
277-
for new development and scheduled for removal)
282+
@deprecated@ - Marks the function as deprecated: not recommended
283+
for new development and scheduled for removal.
284+
@link name@ - Provides a hyperlink to the corresponding function
285+
or type definition.
278286
@since CUPS version@ - Marks the function as new in the specified version
279287
of CUPS.
280-
@private@ - Marks the function as private (same as starting the
281-
function name with an underscore)
288+
@private@ - Marks the function as private so it will not be
289+
included in the documentation.
282290

283291

284292
### Variables

INSTALL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
INSTALL - CUPS v2.3.0 - 2019-05-24
1+
INSTALL - CUPS v2.3.0 - 2019-08-21
22
==================================
33

44
This file describes how to compile and install CUPS from source code. For more

README.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
README - CUPS v2.3.0 - 2019-05-24
1+
README - CUPS v2.3.0 - 2019-08-21
22
=================================
33

4-
Looking for compile instructions? Read the file `INSTALL.md` instead...
5-
6-
74
INTRODUCTION
85
------------
96

10-
117
CUPS is a standards-based, open source printing system developed by Apple Inc.
128
for macOS® and other UNIX®-like operating systems. CUPS uses the Internet
139
Printing Protocol ("IPP") and provides System V and Berkeley command-line
@@ -29,8 +25,21 @@ CUPS is licensed under the Apache License Version 2.0. See the file
2925
READING THE DOCUMENTATION
3026
-------------------------
3127

28+
Initial documentation to get you started is provided in the root directory of
29+
the CUPS sources:
30+
31+
- `CHANGES.md`: A list of changes in the current major release of CUPS.
32+
- `CONTRIBUTING.md`: Guidelines for contributing to the CUPS project.
33+
- `CREDITS.md`: A list of past contributors to the CUPS project.
34+
- `DEVELOPING.md`: Guidelines for developing code for the CUPS project.
35+
- `INSTALL.md`: Instructions for building and installing CUPS.
36+
- `LICENSE`: The CUPS license agreement (Apache 2.0).
37+
- `NOTICE`: Copyright notices and exceptions to the CUPS license agreement.
38+
- `README.md`: This file.
39+
3240
Once you have installed the software you can access the documentation (and a
33-
bunch of other stuff) online at <http://localhost:631/>.
41+
bunch of other stuff) online at <http://localhost:631/> and using the `man`
42+
command, for example `man cups`.
3443

3544
If you're having trouble getting that far, the documentation is located under
3645
the `doc/help` and `man` directories.
@@ -76,22 +85,22 @@ printer at address 11.22.33.44:
7685

7786
CUPS also includes several sample PPD files you can use for "legacy" printers:
7887

79-
Driver PPD Name
80-
----------------------------- ------------------------------
81-
Dymo Label Printers drv:///sample.drv/dymo.ppd
82-
Intellitech Intellibar drv:///sample.drv/intelbar.ppd
83-
EPSON 9-pin Series drv:///sample.drv/epson9.ppd
84-
EPSON 24-pin Series drv:///sample.drv/epson24.ppd
85-
Generic PCL Laser Printer drv:///sample.drv/generpcl.ppd
86-
Generic PostScript Printer drv:///sample.drv/generic.ppd
87-
HP DeskJet Series drv:///sample.drv/deskjet.ppd
88-
HP LaserJet Series drv:///sample.drv/laserjet.ppd
89-
OKIDATA 9-Pin Series drv:///sample.drv/okidata9.ppd
90-
OKIDATA 24-Pin Series drv:///sample.drv/okidat24.ppd
91-
Zebra CPCL Label Printer drv:///sample.drv/zebracpl.ppd
92-
Zebra EPL1 Label Printer drv:///sample.drv/zebraep1.ppd
93-
Zebra EPL2 Label Printer drv:///sample.drv/zebraep2.ppd
94-
Zebra ZPL Label Printer drv:///sample.drv/zebra.ppd
88+
Driver | PPD Name
89+
----------------------------- | ------------------------------
90+
Dymo Label Printers | drv:///sample.drv/dymo.ppd
91+
Intellitech Intellibar | drv:///sample.drv/intelbar.ppd
92+
EPSON 9-pin Series | drv:///sample.drv/epson9.ppd
93+
EPSON 24-pin Series | drv:///sample.drv/epson24.ppd
94+
Generic PCL Laser Printer | drv:///sample.drv/generpcl.ppd
95+
Generic PostScript Printer | drv:///sample.drv/generic.ppd
96+
HP DeskJet Series | drv:///sample.drv/deskjet.ppd
97+
HP LaserJet Series | drv:///sample.drv/laserjet.ppd
98+
OKIDATA 9-Pin Series | drv:///sample.drv/okidata9.ppd
99+
OKIDATA 24-Pin Series | drv:///sample.drv/okidat24.ppd
100+
Zebra CPCL Label Printer | drv:///sample.drv/zebracpl.ppd
101+
Zebra EPL1 Label Printer | drv:///sample.drv/zebraep1.ppd
102+
Zebra EPL2 Label Printer | drv:///sample.drv/zebraep2.ppd
103+
Zebra ZPL Label Printer | drv:///sample.drv/zebra.ppd
95104

96105
You can run the `lpinfo -m` command to list all of the available drivers:
97106

@@ -151,9 +160,9 @@ LEGAL STUFF
151160
Copyright © 2007-2019 by Apple Inc.
152161
Copyright © 1997-2007 by Easy Software Products.
153162

154-
CUPS is provided under the terms of the Apache License, Version 2.0. A copy of
155-
this license can be found in the file `LICENSE`. Additional legal information
156-
is provided in the file `NOTICE`.
163+
CUPS is provided under the terms of the Apache License, Version 2.0 with
164+
exceptions for GPL2/LGPL2 software. A copy of this license can be found in the
165+
file `LICENSE`. Additional legal information is provided in the file `NOTICE`.
157166

158167
Unless required by applicable law or agreed to in writing, software distributed
159168
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR

0 commit comments

Comments
 (0)