Version 82:

Compatible with clients using versions 72-81.

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

        * added a new field 'last_install' to record the package last install time

        * added a new field 'last_update' to record the package last update time

Version 81:

Compatible with clients using versions 72-80.

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

        * Introduced new non-linked image interfaces:

                gen_plan_dehydrate()

                gen_plan_rehydrate()

                gen_plan_fix()

        * Added a new function to get the list of dehydrated publishers:

                get_dehydrated_publishers()

    pkg.client.api_errors has changed as follows:

        * Added a no_repo_pubs property to PlanCreationException

          that contains a list of publishers that have no package

          repository configured.

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

        * Added methods:

                add_item_message()

                extend_item_messages()

                gen_item_messages()

    pkg.client.progress has changed as follows:

        * Removed methods from ProgressTracker:

                verify_start()

                verify_start_pkg()

                verify_add_progress()

                verify_yield_error()

                verify_yield_warning()

                verify_yield_info()

                verify_end_pkg()

                verify_done()

Version 80:

Compatible with clients using versions 72-79.

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

	* Added optional 'implicit' parameter to gen_facets() and

	  gen_variants() methods to get effective value of facets and

	  boolean variants.

Version 79:

Compatible with clients using versions 72-78.

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

        * Added get_editable_changes() function to return the list of

	  "editable" files that will be moved, removed, installed, or

	  updated during the planned operation.

Version 78:

Compatible with clients using versions 72-77.

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

        * Added 'li_recurse' parameter to

            - gen_plan_update()

            - gen_plan_uninstall()

            - gen_plan_install()

            - gen_plan_change_varcets()

          These allow to run the above operations recursively in linked images.

        * Added 'ignore_missing' parameter to

             - gen_plan_uninstall()

             - gen_plan_update()

          This changes the behavior of uninstall and update to not fail if a

          package for the requested operation is not found.

Version 77:

Compatible with clients using versions 72-76.

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

        * Added 'act_timeout' parameter to

            - gen_plan_update()

            - gen_plan_uninstall()

            - gen_plan_install()

            - gen_plan_change_varcets()

          These allow to use synchronous SMF actuators including a timeout. 

Version 76:

Compatible with clients using versions 72-75 [1].

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

	* The generator functions 'gen_facets()' has been updated to

	  give more information about what facets are changing.

	  Previously a 2 value tuple was returned, now a 4 value tuple

	  is returned.

	* [1] This is actually an incompatible change to the old

	  'gen_facets()' behavior, but since gen_facets was only

	  introduced in the previous version of the client API it's

	  unlikely that anyone outside of the pkg gate has adopted it's

	  use.  But since we'd like to avoid an incompatible client API

	  change we're going to ignore this issue.

	* The parsable package plan output format for facet changes has

	  been changed.  Previously a tuple with 2 values was returned;

	  now a tuple with 6 values is returned.

	* Added 'li_parent_sync' parameter to 'gen_plan_uninstall()'.

	* Added 'li_md_only' and 'li_pkg_updates' parameters to

	  'gen_plan_detach()' and 'detach_linked_children()'

Version 75:

Compatible with clients using versions 72-74.

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

	* New generator functions 'gen_variants()' and 'gen_facets()' to

	  retrieve the current list of facets or variants currently

	  (implicitly or explicitly) set in the image.  See 'pydoc

	  pkg.client.api' for details.

Version 74:

Compatible with clients using versions 72-74.

     The PlanDescription now has interfaces to

     determine whether or not release notes were generated

     for this operation, whether or not they must be displayed,

     and a method of retrieving the release notes line by

     line.

Version 73:

Compatible with clients using version 72.

     A per-origin/mirror property has been added, and the transport

     updated to allow for multiple paths to a given URI.

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

        * proxies attribute has been added, allowing origins

          and mirrors to be specified with individual HTTP proxies,

          each represented by a pkg.client.publisher.ProxyURI object.

          Multiple proxies for the same URI may not be configured

          at present.

        * proxy attribute is now deprecated, and attempts to set

          both 'proxies' and 'proxy' in the constructor will result

          in an error.

    pkg.client.api_errors has changed as follows:

        * UnknownRepositoryOrigin and UnknownRepositoryMirror

          exceptions have been changed to include a message

          when a RepositoryURI with a proxy is being used,

          printing that proxy.

        * The Exceptions DuplicateSyspubOrigin and

          DuplicateSyspubMirror have been added for cases where we

          attempt to add a user-origin or user-mirror that is already

          provided by the system publisher.

        * The Exceptions RemoveSyspubOrigin and RemoveSyspubMirror

          have been added for cases where we attempt to remove origins

          or mirrors that are proxied by the system publisher.

Version 72:

Incompatible with clients using versions 0-71.

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

        * New functions added: img_plandir(), is_active_liveroot_be(),

            isparent(), linked_publisher_check(), load_plan(), set_alt_repos()

        * Functions removed: set_stage()

        * Removed "runid" parameter from: __init__()

        * Removed "accept" parameter from: gen_plan_*()

        * Removed "show_licenses" parameter from: gen_plan_*()

        * Added "pubcheck" parameter to:

            gen_plan_sync(), gen_plan_update()

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

        * Removed __init__() parameters: img, backup_be, backup_be_name,

            new_be, be_activate, be_name

        * Added __init__() parameters: op

        * Removed methods: get_parsable_mediators(), get_parsable_varcets(),

            get_salvaged(), get_services()

        * Removed properties: is_active_root_be

        * Added methods: getstate(), setstate(), fromstate()

        * Added properties: executed, services, mediators, varcets,

            plan_desc, salvaged, plan_type, update_index

Version 71:

Compatible with clients using versions 66-70.

    pkg.client.api_errors has changed as follows:

        * Added UnprivilegedUserError to indicate when the current user

          does not have sufficient privileges to modify the image.

Version 70:

Compatible with clients using versions 66-69.

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

        * A new boolean property named is_liveroot has been added to

          allow API consumers to determine if the image to be modified

          is for the live system root.

Version 69:

Compatible with clients using versions 66-68.

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

        * get_pkg_list() and info() now have an optional boolean

          parameter named 'ranked' that controls whether only

          packages for the highest-ranked matching publisher should

          be returned. See 'pydoc pkg.client.api' for details.

Version 68:

Compatible with clients using versions 66-67.

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

        * New functions for managing client history have been added:

          abort(), gen_history(), clear_history(), and purge_history().

          See 'pydoc pkg.client.api' for details.

        * New constants for decoding history entries have been added

          named after the pattern RESULT_*.  See 'pydoc pkg.client.api'

          for details.

    pkg.client.api_errors has changed as follows:

        * New exceptions for bad history requests or history parsing

          errors have been added. (HistoryLoadException, etc.)

Version 67:

Compatible with clients using version 66.

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

        * planning functions such as gen_plan_install that allow

          specifying a be_name now also support specifying a

          backup_be_name, and the ability to create a backup BE

          by setting backup_be=True.

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

        * New properties named 'backup_be' and 'backup_be_name' have been

          added to allow callers to determine whether a backup BE will be

          created and what name was specified for it.

        * The new property 'is_active_root_be' has been added to allow

          consumers to determine if the image being modified is for the

          live, active root BE.

Version 66:

Incompatible with clients using versions 0-63.

    The incompatible change is that attach_linked_child, audit_linked,

    audit_linked_children, and detach_linked_children now return a tuple

    containing the return value, any errors, and either None or a dictionary

    representing the parsable output for the operation. All the *_rvdict2rv

    functions have been changed similar except they return a list of

    dictionaries.

    The following are the compatible changes:

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

        * gen_plan_* now takes an optional argument, parsable version, which is

          either None or contains the version of parsable output to generate.

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

        * get_parsable_mediators and get_parsable_varcets have been added as

          functions which return the raw structures for mediators, variants, and

          facets rather than the formatted strings which get_mediators and

          get_varcets do.

Version 65:

Incompatible with clients using versions 0-64.

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

        * get_pkg_list() yields five values instead of four; the fifth is a

          dictionary of package attributes.

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

        * added get_attr_values() to return the values of named package

          attributes.

Version 64:

Incompatible with clients using versions 0-63.

    pkg.client.api_errors has changed as follows:

       * The ImageLocationAmbiguous exception has been removed.  The client

         API no longer requires the image to be found at '/' on Solaris.

         Clients are free to enforce whatever restrictions on image root

         they desire.

Version 63:

Compatible with clients using version 62.

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

        * added new 'mediators' property has been added

          to get a dictionary of the configured mediation

          information.

        * added gen_available_mediators() to get the list of

          available mediations for installed packages.

        * added gen_plan_set_mediators() for planning an

          operation to set link mediation.

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

        * added get_mediators() method to get a list of

          strings describing the mediation changes for a plan.

    pkg.client.api_errors has changed as follows:

        * added an invalid_mediations property to PlanCreationException

          that contains a dictionary of any mediations found to be

          invalid for the plan with a key set for each aspect that was

          faulty.

Version 62:

Incompatible with clients using versions 0-61.

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

        * the 'fmri' property is now a PkgFmri object instead of a

          string.

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

        * get_services() now returns a list of tuples of strings,

          see pkg.client.api for details.

Version 61:

Compatible with clients using version 60.

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

        * Added the following new interfaces

                get_bytes_added()

                get_cbytes_added()

                get_bytes_avail()

                get_cbytes_avail()

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

        * may now raise api_errors.ImageInsufficientSpace exception

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

        * may now raise api_errors.ImageInsufficientSpace exception

Version 60:

Incompatible with clients using versions 0-59.

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

        * Uninstall no longer supports recursive removal.  As such,

          the recursive_removal parameter of plan_uninstall and

          gen_plan_uninstall has been removed.

Version 59:

Compatible with clients using versions 57-59.

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

        * introduced new linked image interfaces:

                attach_linked_child()

                audit_linked()

                audit_linked_children()

                audit_linked_rvdict2rv()

                detach_linked_children()

                detach_linked_rvdict2rv()

                gen_plan_attach()

                gen_plan_detach()

                gen_plan_sync()

                get_linked_name()

                get_linked_props()

                ischild()

                list_linked()

                parse_linked_name()

                parse_linked_name_list()

                sync_linked_children()

                sync_linked_rvdict2rv()

        * introduced new non-linked image interfaces:

                gen_plan_change_varcets()

                gen_plan_install()

                gen_plan_revert()

                gen_plan_uninstall()

                gen_plan_update()

                solaris_image()

        * deprecated:

                plan_change_varcets()

                plan_install()

                plan_revert()

                plan_uninstall()

                plan_update()

                plan_update_all()

    pkg.client.api_errors has changed as follows:

        * introduced LinkedImageException

        * updated PlanCreationException

Version 58:

Compatible with clients using version 57:

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

        * added a 'be_activate' parameter to all plan_*() functions to

          allow clients to control whether any new BE created during

          operations is set as the active one on next boot.

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

        * added 'activate_be' boolean property so clients can determine

          whether be activation was requested at planning time.

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: