Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 74 lines (45 sloc) 2.114 kb
7f1d5ca Duke Leto [doc] DEPRECATED.pod is now called docs/changes/api.yaml
leto authored
1 # Copyright (C) 2007-2011, Parrot Foundation.
9be9714 Jerry Gay #41317: [PATCH] parrot component/interface stability classification
particle authored
2
3 =head1 NAME
4
5 docs/stability.pod -- Parrot Component/Interface Stability Classification
6
7 =head1 DESCRIPTION
8
9 This document classifies Parrot components and interfaces based on their
10 stability. Stability is a measure of likeliness that a component or interface
11 will change in a subsequent version. Components include command-line tools,
12 and documents (eg. PDDs.) Interfaces include API/ABIs, modules, libraries,
13 environment variables, and implementations (eg. source and headers.)
14
15 Stability classifications must be included in component or interface
16 documentation. For an example, see the L<STABILITY> section of this doc.
17
18 =head2 Stability Classifications
19
20 There are five categories of stability, as described below:
21
22 =over 4
23
24 =item Private
25
26 This component or interface is only for use within Parrot; it shouldn't be
27 exposed or used externally. It may be modified or removed at any time.
28
29 =item Unstable
30
31 Externally visible, but under active development. Use at your own risk.
32
7f1d5ca Duke Leto [doc] DEPRECATED.pod is now called docs/changes/api.yaml
leto authored
33 =item Experimental
9be9714 Jerry Gay #41317: [PATCH] parrot component/interface stability classification
particle authored
34
35 Externally visible, but under development. Changes must include documentation
36 (and tests where appropriate,) and must be reviewed by the Project Team before
7f1d5ca Duke Leto [doc] DEPRECATED.pod is now called docs/changes/api.yaml
leto authored
37 committing to master. Backward compatibility is maintained when possible.
9be9714 Jerry Gay #41317: [PATCH] parrot component/interface stability classification
particle authored
38
39 =item Stable
40
41 Externally visible and unlikely to change between minor releases. Changes must
42 include docs and tests, must be reviewed and approved by the Project Team, and
43 cannot be applied without a deprecation cycle for any affected component or
44 interface.
45
46 =item Deprecated
47
6e5ea61 Reini Urban [docs] Update stability and memory_internals
rurban authored
48 This component or interface is no longer supported; it will be removed
49 after the completion of its deprecation cycle (the next supported
50 release.) Items that have been deprecated but not yet removed are
51 documented in the top level F<api.yaml>.
9be9714 Jerry Gay #41317: [PATCH] parrot component/interface stability classification
particle authored
52
53 =back
54
55 =head1 TODO
56
57 =over 4
58
59 =item Determine where and how stability should be documented for each
60 component/interface
61
62 =back
63
64 =head1 STABILITY
65
6e5ea61 Reini Urban [docs] Update stability and memory_internals
rurban authored
66 Stable. This proposal has been reviewed and accepted by the Project Team,
67 and is executed in practice for over 7 years.
9be9714 Jerry Gay #41317: [PATCH] parrot component/interface stability classification
particle authored
68
69 =head1 AUTHOR
70
71 jerry gay a.k.a. particle
72
73 =cut
Something went wrong with that request. Please try again.