summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRaphaël Hertzog <hertzog@debian.org>2010-02-26 13:50:42 +0100
committerRaphaël Hertzog <hertzog@debian.org>2010-02-26 14:09:02 +0100
commit7fd5e980f780c43e757432c7f0438e23c1e4d4cd (patch)
treefa466d49569175857c887296456b498ba134b866 /doc
parent0934601905ea4546a874a6558f7a2a2552cd62f1 (diff)
downloaddpkg-7fd5e980f780c43e757432c7f0438e23c1e4d4cd.tar.gz
Introduce the libdpkg-perl package
Clarify the status of the API in README.api.
Diffstat (limited to 'doc')
-rw-r--r--doc/README.api18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/README.api b/doc/README.api
index 49c7cac86..fe575ad24 100644
--- a/doc/README.api
+++ b/doc/README.api
@@ -13,17 +13,25 @@ Description:
then define the C preprocessor macro LIBDPKG_VOLATILE_API in your build
to acknowledge that fact.
-What: Dpkg (perl modules)
-Status: testing
+What: libdpkg-perl (perl modules)
+Status: stable
Description:
- The API provided by these modules is not yet stable, it's only supposed to
- be used internally by dpkg for now.
+ Among the perl modules provided by libdpkg-perl, you can safely rely on
+ those that have $VERSION set to 1.00 (or higher). Note however that the
+ API is defined by what's documented in the corresponding manual pages and
+ nothing more. You can't assume anything else based on what you read in
+ the source code. If you feel the need for further refinements in the
+ documented API, don't hesitate to file a wishlist bug against
+ libdpkg-perl.
+ .
+ In case of API-breaking changes, the major number in $VERSION will be
+ increased. For API extensions, the minor number will be increased.
What: custom changelog parsers in /usr/lib/dpkg/parsechangelog
Status: stable
Version: 2.0
Description:
- Since dpkg 1.14.16, the set of command-line options that custome
+ Since dpkg 1.14.16, the set of command-line options that custom
changelog parsers must support has been expanded (see
dpkg-parsechangelog(1)). For compatibility, changelog parsers supporting
only the old options are supported in lenny. In lenny+1, that support