1 # Copyright (C) 2007, Parrot Foundation.
6 docs/stability.pod -- Parrot Component/Interface Stability Classification
10 This document classifies Parrot components and interfaces based on their
11 stability. Stability is a measure of likeliness that a component or interface
12 will change in a subsequent version. Components include command-line tools,
13 and documents (eg. PDDs.) Interfaces include API/ABIs, modules, libraries,
14 environment variables, and implementations (eg. source and headers.)
16 Stability classifications must be included in component or interface
17 documentation. For an example, see the L<STABILITY> section of this doc.
19 =head2 Stability Classifications
21 There are five categories of stability, as described below:
27 This component or interface is only for use within Parrot; it shouldn't be
28 exposed or used externally. It may be modified or removed at any time.
32 Externally visible, but under active development. Use at your own risk.
36 Externally visible, but under development. Changes must include documentation
37 (and tests where appropriate,) and must be reviewed by the Project Team before
38 committing to trunk. Backward compatibility is maintained when possible.
42 Externally visible and unlikely to change between minor releases. Changes must
43 include docs and tests, must be reviewed and approved by the Project Team, and
44 cannot be applied without a deprecation cycle for any affected component or
49 This component or interface is no longer supported; it will be removed after
50 the completion of its deprecation cycle (usually one release.) Items that
51 have been deprecated but not yet removed are documented in the top level
60 =item Determine where and how stability should be documented for each
67 Evolving. This proposal has been reviewed and accepted by the Project Team,
68 but some details remain to be filled in.
72 jerry gay a.k.a. particle