home *** CD-ROM | disk | FTP | other *** search
/ Clickx 115 / Clickx 115.iso / software / tools / windows / tails-i386-0.16.iso / live / filesystem.squashfs / usr / share / doc / libdpkg-perl / README.api < prev    next >
Encoding:
Text File  |  2012-09-17  |  1.7 KB  |  42 lines
  1. This is an (incomplete) list of currently provided APIs by dpkg, and
  2. their supported status.
  3.  
  4.  
  5. What: libdpkg.a (C static library)
  6. Status: volatile
  7. Description:
  8.  The API provided by this library is highly volatile, still in the process
  9.  of being cleaned up. It's only supposed to be used internally by dpkg for
  10.  now. Header files, functions, variables and types might get renamed,
  11.  removed or change semantics. If you still have a need to use it, which
  12.  you'd be doing anyway, say by locally building dpkg to get the library,
  13.  then define the C preprocessor macro LIBDPKG_VOLATILE_API in your build
  14.  to acknowledge that fact.
  15.  
  16. What: libdpkg-perl (perl modules)
  17. Status: stable
  18. Description:
  19.  Among the perl modules provided by libdpkg-perl, you can safely rely on
  20.  those that have $VERSION set to 1.00 (or higher). Note however that the
  21.  API is defined by what's documented in the corresponding manual pages and
  22.  nothing more. You can't assume anything else based on what you read in
  23.  the source code. If you feel the need for further refinements in the
  24.  documented API, don't hesitate to file a wishlist bug against
  25.  libdpkg-perl.
  26.  .
  27.  In case of API-breaking changes, the major number in $VERSION will be
  28.  increased. For API extensions, the minor number will be increased.
  29.  
  30. What: custom changelog parsers in /usr/lib/dpkg/parsechangelog
  31. Status: stable
  32. Version: 2.0
  33. Description:
  34.  Since dpkg 1.14.16, the set of command-line options that custom
  35.  changelog parsers must support has been expanded (see
  36.  dpkg-parsechangelog(1)). For compatibility, changelog parsers supporting
  37.  only the old options are supported in lenny. In lenny+1, that support
  38.  will be dropped.
  39.  .
  40.  For reference, only the -v option was supported in version 1.0 of this
  41.  API.
  42.