Version 57:

Incompatible with clients using versions 0-56:

     pkg.client.api.ImageInterface has changed as follows:

        * get_preferred_publisher has been replaced with 

          get_highest_ranked_publisher

        * set_pub_search_after has been removed

        * set_pub_search_before has been removed

        * search_after, search_before, and search_first have been added as 

	  options to add_publisher and update_publisher

        * The write_syspub_0 function has been added.

     pkg.client.publisher.RepositoryURI has changed as follows:

        * proxy and system attributes have been added

        * The get_host function has been added.

        * The change_scheme function has been added.

     pkg.client.publisher.Repository has changed as follows:

        * a proxy attribute has been added and may be set during initialization

     pkg.client.publisher.Publisher has changed as follows:

        * The repositories attribute which contained a list of Repository 

          objects has been replaced by the repository attribute which contains a

          single Repository object.

        * The selected_repository attribute has been removed.

        * A sys_pub attribute has been added which indicates whether a publisher

          is a system publisher.

        * The add_repository function has been replaced with the set_repository

          function.

        * The has_configuration function has been added which attempts to 

          determine whether a publisher has been configured by a user.

        * The remove_repository function has had its arguments removed.

        * The set_selected_repository function has been removed.

Version 56:

Compatible with clients using version 55:

     pkg.client.api.ImageInterface has changed as follows:

        * added a get_salvaged() method to the PlanDescription class to

          get the list of files or directories that were salvaged during

          the executed package operation

Version 55:

Incompatible with clients using versions 0-54:

     pkg.client.publisher.Publisher has changed as follows:

	* The following functions have been removed:

          get_intermediate_certs

       	  verify_ca_certs

        * verify_chain has had the mandatory parameter cur_pathlen added which

	  indicates how many certificates exist between cert and the leaf cert.

        * approve_ca_cert has had the 'manual' parameter removed as only the

          user can approve a certificate now.

Version 54:

Compatible with clients using versions 53-54:

     pkg.client.api.ImageInterface has changed as follows:

        * added avoid_pkgs, get_avoid_list functions to client

          interface to manage group dependency behavior.

Version 53:

Incompatible with clients using versions 0-52:

    General changes:

        * Support for pkg(5) archives has been added; a file URI

          containing the location of an archive can be used anywhere

          that a repository location is (except for search).

        * Publishers are no longer required to have origins or mirrors

          so that sticky state and search order can be retained when

          installing packages from temporary sources.

        * The client API now supports the use of temporary sources of

          package during during operations.

    pkg.client.api.ImageInterface has changed as follows:

        * get_pkg_list() is now a locking operation and cannot be used

          at the same time as other functions (such as a multi-threaded

          scenario)

        * get_pkg_categories() is now a locking operation and cannot be

          used at the same time as other functions (such as a multi-

          threaded scenario)

        * add_publisher() now permits publishers with no repository

          origins or mirrors to be added.

        * update_publisher() now permits publishers to be updated even

          if the new object has no origins or mirrors.

        * info(), get_pkg_categories(), get_pkg_list(), get_manifest(),

          plan_install(), plan_update(), plan_update_all(), and

          plan_change_varcets() now have a 'repos' parameter for

          specifying temporary package repositories for use during

          the operation.

    pkg.client.progress has changed as follows:

        * There are new methods for tracking the progress of archive

          creation: archive_set_goal(), archive_add_progress(),

          and archive_done().  See 'pydoc pkg.client.progress' for

          details.

    pkg.client.api_errors has changed as follows:

        * The PublisherOriginRequired exception class has been removed.

        * The new Exception NoPublisherRepositories was added.  It is

          raised whenever an attempt to perform a transport operation

          for a publisher with no transport configuration is made.

Version 52:

Incompatible with clients using versions 0-51:

    pkg.client.publisher.Publisher has changed as follows:

        * The following functions have been made private:

            add_cert, get_certs_by_name, get_crl, check_extensions

        * check_critical was removed.

        * verify_chain had an additional, optional, argument added to it.  The

          usages paramter defines what uses the certificate needs to allow.

          If this parameter isn't set, then it's assumed that the certificate

          should be able to be used for all known uses.

        * The following constants were added to be used as values to the usages

          parameter for verify chain.

Version 51:

Compatible with clients using versions 46-50:

    pkg.client.api.PlanDescription has changed as follows:

        * get_solver_errors() was added to allow retrieval of extended

          error information for plan_*() functions.  See 'pydoc

          pkg.client.api' for details.

Version 50:

Compatible with clients using versions 46-49:

    pkg.client.api.ImageInterface changed as follows:

        * The new function plan_revert() was added to allow planning

          an operation for reverting specific or tagged packaged

          files.

Version 49:

Compatible with clients using versions 46-48:

    pkg.client.api.ImageInterface has changed as follows:

        * plan_install and plan_update take an optional

          argument to reject packages in solution.

Version 48:

Compatible with clients using versions 46-47.

    pkg.client.api.ImageInterface has changed as follows:

        * The ImageInterface class constructor now accepts an

          exact_match parameter that allows consumers to control

          whether an attempt to find an image starting from the

          specified directory is made.  See 'pydoc pkg.client.api'

          for detailed usage.

        * If the exact_match parameter of the class constructor is

          False, an ImageLocationAmbiguous exception will be raised

          on Solaris if the image is not found at '/'.  Other platforms

          will continue to accept an image found at any location.

        * A new property named 'progresstracker' was added to allow

          consumers to change the ProgressTracker object used by the

          API object instance after class initialization.  See 'pydoc

          pkg.client.api' for detailed usage.

    pkg.client.api_errors has changed as follows:

        * A new ImageLocationAmbiguous exception was added.

Version 47:

Compatible with clients using version 46.

    pkg.client.api.ImageInterface has changed as follows:

        * A new function named 'update_format' has been added to allow

          clients to upgrade images in older formats to the newest one.

          By default, images rooted at '/' or that are for a zone are

          automatically upgraded to the newest format if the user of

          the client has sufficient privileges.

    pkg.client.api_errors has changed as follows:

        * A new exception named 'ImageFormatUpdateNeeded' has been added

          that may be raised by the API whenever an API operation

          requires that the image be updated to a new format before

          the operation can be performed.

Version 46:

Incompatible with clients using versions 0-45.

    pkg.client.api.ImageInterface has changed as follows:

        * The actual_cmd parameter is no longer a parameter to the

          plan_update_all function.  Instead that information is stored in the

          global_settings object.  It's used when looking for the trust anchors

          of the image from which pkg was run.

Version 45:

Compatible with clients using versions 43-44.

    pkg.client.api.ImageInterface has changed as follows:

        * A new planning function, plan_update, has been added which

          allows in place downgrades of packages.

Version 44:

Compatible with clients using version 43.

    pkg.client.api.ImageInterface has changed as follows:

        * A new property 'last_modified' was added that returns a UTC

          datetime object representing the time the image's metadata

          was last changed.

Version 43:

Incompatible with clients using versions 0-42.

    pkg.client.api.ImageInterface has changed as follows:

        * A new boot environment will now only be created if required

          for image-modifying operations (except for plan_update_all

          which continues to always create one by default).

        * The verbose parameter has been removed from the plan_*

          functions.

        * All plan_* functions now accept an additional boolean named

          'new_be' that indicates whether a new boot environment should

          be created for the operation.  This overrides the deafult

          behaviour that only creates one if needed.

    pkg.client.api.PlanDescription has changed as follows:

        * get_services(), get_varcets(), and get_actions() were added

          to allow clients more access to plan information.

        * A boolean property named new_be was added that indicates

          whether the planned operation will requires a new boot

          environment.

Version 42:

Incompatible with clients using versions 0-41.

    pkg.client.api_errors has changed as follows:

        * The MainDictParsingException class was removed

        * The BadPublisherAlias and IndexLockedException

          exceptions were added.

    pkg.client.publisher has changed as follows:

        * The inter_certs property was renamed to intermediate_certs.

Version 41:

Compatible with clients using versions 40-41.

    Allows the client to handle signed packages.  This includes the

    addition of a large number of optional parameters to the

    client/publisher class.  It also makes changes to image creation to

    allow image properties to be set during the process.  New subclasses

    of ApiException were created to indicate different error conditions

    associated with signing failures.

Version 40:

Incompatible with clients using versions 0-39.

    The pkg.client.api ImageInterface has changed as follows:

        * The info() method no longer detects and returns multiple

          matches for patterns and instead will return all matches

          for a given pattern.

        * The ImageInterface.INFO_MULTI_MATCH property has been

          removed.

        * The PackageInfo.PREF_PUBLISHER attribute and data has been

          removed.

        * Illegal patterns will cause info() to raise an exception

          immediately.

Version 39:

Compatible with clients using versions 36-38.

    Introduces the notion of a system repository to the publisher

    heirarchy.  This specific type of repository is a subclass of

    RepositoryURI.  A few new api exceptions are added, too.

Version 38:

Compatible with clients using versions 36-37.

    The pkg.client.api now supports file-based repository access for all

    operations.  All related classes have been updated to support URIs

    that use the 'file' scheme.

Version 37:

Compatible with clients using version 36.

    The pkg.client.api ImageInterface has changed as follows:

        * Whenever an unexpected change in the state or structure

          of the image is encountered during install, remove, or

          update operations (such as a missing file, directory,

          or inability to remove an item) and it cannot be

          recovered from without user intervention, an

          ActionExecutionError exception is raised.

Version 36:

Incompatible with clients using versions 0-35.

    The interface for pkg.client.api.remote_search has changed as follows:

        * A new parameter, prune_versions, has been added which, when true,

          causes remote search to remove versions a user is unlikely to be

          interested in.

        * The return type of remote_search and local_search has changed.  Where

          the string representation used to be returned, a FMRI object is now

          returned.

Version 35:

Compatible with clients using version 34.

    The ImageInterface class has changed as follows:

        * A new method named parse_fmri_patterns has been added to

          help clients parse user input and transform any valid patterns

          into FMRI objects that can be used for comparison.  See pydoc

          'pkg.client.api' for details.

        * New constants for the parse_fmri_patterns method were added:

          MATCH_EXACT, MATCH_FMRI, and MATCH_GLOB.

Version 34:

Incompatible with clients using versions 0-33.

    The pkg.client.publisher.Publisher class has changed as follows:

        * The deprecated get_ssl_creds() and set_origin() methods

          were removed.  These functions have been marked as

          deprecated since the client API was first versioned

          and should not have been used by any clients.

Version 33:

Compatible with clients using version 32.

    The ImageInterface class has changed as follows:

        * file and directory actions will now have their mode validated

          if failure occurs during plan execution to determine if bad

          package metadata was the cause of execution failure.  In

          addition, the client API will catch failures due to corrupt

          or invalid package metadata and re-raise them as an

          InvalidPackageErrors exception.

    The pkg.client.api_errors module has changed as follows:

        * The InvalidPackageErrors exception was added.  See 'pydoc

          pkg.client.api_errors' for details.

Version 32:

Incompatible with clients using versions 0-31.

    The ImageInterface class has changed as follows:

        * The add_publisher and update_publisher methods now validate

          the image's publisher configuration against the origins of

          the publisher.  If any of the origins are found to not match,

          an UnknownRepositoryPublishers exception will be raised.

          If one of the new repository origins does not provide

          publisher configuration information or it is incomplete,

          a RepoPubConfigUnavailable exception will be raised.

    The pkg.client.api module has changed as follows:

        * A new method named image_create has been added.  See 'pydoc

          pkg.client.api' for details.

    The pkg.client.api_errors module has changed as follows:

        * UnknownRepositoryPublishers, RepoPubConfigUnavailable, and

          UnknownErrors expections have been added for use by the

          pkg.client.api.  API consumers are reminded that they should

          catch all ApiException class exceptions, although catching

          specific exception subclasses for case-by-case handling in

          addition to that is acceptable.

Version 31:

Compatible with clients using version 30.

    All image-modifying operations now lock the image for exclusive use

    by the current thread and process.  If the lock cannot be obtained,

    an ImageLockedError exception will be raised.

    The ImageInterface class has changed as follows:

        * A new property named 'blocking_locks' has been added to allow

          clients to control image locking behaviour.  See 'pydoc

          pkg.client.api.ImageInterface' for details.

        * The prepare() and execute_plan() methods will now raise an

          InvalidPlanError if the image state has changed since the

          plan was originally created.  This is likely the result of

          another client or process modifying the image.

Version 30:

Incompatible with clients using versions 0-29:

    The ProgressTracker class has changed as follows:

        * ver_output_warning() and ver_output_info() were added so that

          callers can choose to output warning and info verification

          messages separately from errors.

Version 29:

Incompatible with clients using versions 0-28:

    The ImageInterface class has changed as follows:

        * set_plan_license_status() was added.  This is used to indicate

          whether licenses for the packages being operated on have been

          accepted or displayed.  Clients must do this if the related

          license requires acceptance or display.

    The LicenseInfo class has changed as follows:

        * get_text() may now trigger a remote retrieval of the license

          payload if needed to return the text.

        * The related package FMRI and license attributes are now

          properties: fmri, license, must_accept, and must_display.

    The PlanDescription class has changed as follows:

        * get_changes() is now a generator function.

        * get_licenses() was added to allow clients to retrieve the

          list of licenses related to the plan's operations as well

          as the current accepted and displayed status of each.

Version 28:

Incompatible with clients using versions 0-27:

    CatalogRefreshException.message was changed to

    CatalogRefreshException.errmessage to work around a change

    introduced in python2.5 and removed in python2.6 (Exception.message,

    if used, triggers a deprecation warning).

Version 27:

Compatible with clients using versions 25-26:

    The get_manifest function has been added to the api to allow clients

    to retrieve the manifest directly.

Version 26:

Compatible with clients using version 25.

    The client API has changed such that an immediate refresh is always

    performed when the 'refresh_catalogs' parameter is True for install,

    update, and change variant operations.

Version 25:

Incompatible with clients using versions 0-24:

Changes:

    The PackageInfo class has changed as follows:

        * The NOT_INSTALLED constant has been removed as checking

          for the presence of INSTALLED should be sufficient.

        * A new constant named 'KNOWN' has been added.  It indicates

          that the package is currently available from a publisher's

           repository.

         * A new constant named 'UPGRADABLE' has been added. It

           indicates that a new version of the package is available.

     The following new api functions were added to ImageInterface (see

     'pydoc pkg.client.api.ImageInterface' for more information):

         * get_pkg_categories

         * get_pkg_list