Guillem Jover 83b5b8fe54 doc: Fix typos in documentation and code comments 4 years ago
..
.gitignore 0581dda824 build: Add optional code coverage support 10 years ago
Doxyfile.in f3af91bcb3 build: Add an configure option to choose the kind of documentation 5 years ago
README.api 2587fce6d8 doc: Update custom changelog parser API support status in README.api 4 years ago
README.feature-removal-schedule 83b5b8fe54 doc: Fix typos in documentation and code comments 4 years ago
coding-style.txt 9aa458e8a3 build: Fix M4sh/Autoconf coding style 4 years ago
frontend.txt 0aec21906f doc: Add new frontend.txt file documenting some public interfaces 8 years ago
lcov-inject.pl ca9b5c6511 build: Print an actual newline instead of a literal \n in lcov output 4 years ago
triggers.txt fa216338f3 doc, man: Fix typos 4 years ago

README.api

This is an (incomplete) list of currently provided APIs by dpkg, and
their supported status.


What: libdpkg.a (C static library)
Status: volatile
Description:
The API provided by this library is highly volatile, still in the process
of being cleaned up. It's only supposed to be used internally by dpkg for
now. Header files, functions, variables and types might get renamed,
removed or change semantics. If you still have a need to use it, which
you'd be doing anyway, say by locally building dpkg to get the library,
then define the C preprocessor macro LIBDPKG_VOLATILE_API in your build
to acknowledge that fact.

What: libdpkg-perl (perl modules)
Status: stable
Description:
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 as Dpkg::Changelog derived modules
Status: stable
Description:
Since dpkg 1.18.8, custome changelog parsers are supported as modules
derived from the Dpkg::Changelog module. The derived modules need to
implement all required documented methods.