Merge lp:~alan-griffiths/mir/optional-deprecations into lp:~mir-team/mir/0.26-old

[Alan Griffiths]

Make deprecations optional and default to off for builds on 16.04LTS

We want to push 0.26 to 16.04LTS

libmirserver dependencies will break, but we don't need them. We can just replace the packages.

libmirclient dependencies don't have an ABI break, but we have deprecated APIs they may use.

The intent of this MP is to avoid these deprecations when building for 16.04LTS

[Alberto Aguirre (albaguirre)]

The pragmatic approach, yeah.

So will this be a 0.26.4 ? We had a 0.26.3 version ready in lp:mir/0.26 that was not released at all.

review: Approve

[Alan Griffiths (alan-griffiths)]

> The pragmatic approach, yeah.
>
> So will this be a 0.26.4 ? We had a 0.26.3 version ready in lp:mir/0.26 that
> was not released at all.

Oh right. I see no harm including that.

[Brandon Schaefer (brandontschaefer)]

Sweet, this lgtm

review: Approve

[Alan Griffiths (alan-griffiths)]

I've tried installing this onto a 16.04 laptop and building a few of the downstream packages from source it doesn't appear to break anything at runtime.

=== modified file 'debian/changelog'
--- debian/changelog	2017-03-30 06:38:36 +0000
+++ debian/changelog	2017-04-25 09:32:38 +0000
@@ -1,6 +1,8 @@
 mir (0.26.3-0ubuntu1) UNRELEASED; urgency=medium
 
   * New upstream release 0.26.3 (https://launchpad.net/mir/+milestone/0.26.3)
+    - Enhancements:
+      . Make deprecations optional (and default to off for builds on 16.04LTS)
     - Bugs fixed:
       . unity-system-compositor crashed with SIGSEGV in
         libinput_device_config_accel_is_available() from
 
=== modified file 'include/client/mir_toolkit/client_types.h'
--- include/client/mir_toolkit/client_types.h	2017-03-16 16:47:21 +0000
+++ include/client/mir_toolkit/client_types.h	2017-04-25 09:32:38 +0000
@@ -23,6 +23,7 @@
 
 #include <mir_toolkit/events/event.h>
 #include <mir_toolkit/common.h>
+#include <mir_toolkit/deprecations.h>
 
 #include <stddef.h>
 
@@ -38,15 +39,15 @@
 typedef void* MirEGLNativeWindowType;
 typedef void* MirEGLNativeDisplayType;
 typedef struct MirConnection MirConnection;
-typedef struct MirSurface MirSurface __attribute__((deprecated("Use MirWindow instead")));
+typedef struct MirSurface MirSurface MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindow instead");
 typedef struct MirSurface MirWindow;
-typedef struct MirSurfaceSpec MirSurfaceSpec __attribute__((deprecated("Use MirWindowSpec instead")));
+typedef struct MirSurfaceSpec MirSurfaceSpec MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowSpec instead");
 typedef struct MirSurfaceSpec MirWindowSpec;
 typedef struct MirScreencast MirScreencast;
 typedef struct MirScreencastSpec MirScreencastSpec;
 typedef struct MirPromptSession MirPromptSession;
 typedef struct MirBufferStream MirBufferStream;
-typedef struct MirPersistentId MirPersistentId __attribute((deprecated("Use MirWindowId instead")));
+typedef struct MirPersistentId MirPersistentId MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowId instead");
 typedef struct MirPersistentId MirWindowId;
 typedef struct MirBlob MirBlob;
 typedef struct MirDisplayConfig MirDisplayConfig;
@@ -54,7 +55,7 @@
 typedef struct MirPresentationChain MirPresentationChain;
 typedef struct MirBuffer MirBuffer;
 typedef struct MirRenderSurface MirRenderSurface
-__attribute__((deprecated("This type is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This type is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Descriptor for an output connection.
@@ -82,7 +83,7 @@
 typedef void (*MirConnectedCallback)(
     MirConnection *connection, void *client_context);
 typedef MirConnectedCallback mir_connected_callback
-    __attribute__((deprecated("Use MirConnectedCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirConnectedCallback instead");
 
 /**
  * Callback to be passed when calling window functions :
@@ -102,7 +103,7 @@
 typedef void (*MirBufferStreamCallback)(
     MirBufferStream *stream, void *client_context);
 typedef MirBufferStreamCallback mir_buffer_stream_callback
-    __attribute__((deprecated("Use MirBufferStreamCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirBufferStreamCallback instead");
 
 /**
  * Callback for handling of window events.
@@ -124,7 +125,7 @@
 typedef void (*MirLifecycleEventCallback)(
     MirConnection* connection, MirLifecycleState state, void* context);
 typedef MirLifecycleEventCallback mir_lifecycle_event_callback
-    __attribute__((deprecated("Use MirLifecycleEventCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirLifecycleEventCallback instead");
 
 /**
  * Callback called when the server pings for responsiveness testing.
@@ -136,7 +137,7 @@
 typedef void (*MirPingEventCallback)(
     MirConnection* connection, int32_t serial, void* context);
 typedef MirPingEventCallback mir_ping_event_callback
-    __attribute__((deprecated("Use MirPingEventCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirPingEventCallback instead");
 
 /**
  * Callback called when a display config change has occurred
@@ -147,7 +148,7 @@
 typedef void (*MirDisplayConfigCallback)(
     MirConnection* connection, void* context);
 typedef MirDisplayConfigCallback mir_display_config_callback
-    __attribute__((deprecated("Use MirDisplayConfigCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirDisplayConfigCallback instead");
 
 /**
  * Callback called when a request for client file descriptors completes
@@ -162,7 +163,7 @@
 typedef void (*MirClientFdCallback)(
     MirPromptSession *prompt_session, size_t count, int const* fds, void* context);
 typedef MirClientFdCallback mir_client_fd_callback
-    __attribute__((deprecated("Use MirClientFdCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirClientFdCallback instead");
 
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
@@ -201,7 +202,7 @@
      * use the value mir_display_output_id_invalid.
      */
     uint32_t output_id;
-} MirSurfaceParameters __attribute__((deprecated("Use MirWindowParameters instead")));
+} MirSurfaceParameters MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowParameters instead");
 
 enum { mir_platform_package_max = 32 };
 
@@ -214,7 +215,7 @@
  * \todo This should be removed from the public API at the next API break.
  */
 #ifndef __cplusplus
-__attribute__ ((deprecated))
+MIR_FOR_REMOVAL_IN_VERSION_1("Use of this type is inherently non-portable")
 #endif
 typedef enum MirPlatformType
 {
@@ -429,7 +430,7 @@
 typedef void (*MirScreencastCallback)(
     MirScreencast *screencast, void *client_context);
 typedef MirScreencastCallback mir_screencast_callback
-    __attribute__((deprecated("Use MirScreencastCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirScreencastCallback instead");
 
 /**
  * Callback member of MirPromptSession for handling of prompt sessions.
@@ -439,7 +440,7 @@
 typedef void (*MirPromptSessionCallback)(
     MirPromptSession* prompt_provider, void* context);
 typedef MirPromptSessionCallback mir_prompt_session_callback
-    __attribute__((deprecated("Use MirPromptSessionCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirPromptSessionCallback instead");
 
 /**
  * Callback member of MirPromptSession for handling of prompt sessions events.
@@ -452,7 +453,7 @@
     void* context);
 typedef MirPromptSessionStateChangeCallback
         mir_prompt_session_state_change_callback
-    __attribute__((deprecated("Use MirPromptSessionStateChangeCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirPromptSessionStateChangeCallback instead");
 
 /**
  * Callback called when a platform operation completes.
@@ -467,7 +468,7 @@
 typedef void (*MirPlatformOperationCallback)(
     MirConnection* connection, MirPlatformMessage* reply, void* context);
 typedef MirPlatformOperationCallback mir_platform_operation_callback
-    __attribute__((deprecated("Use MirPlatformOperationCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirPlatformOperationCallback instead");
 
 /**
  * Callback called when a change of input devices has occurred
@@ -479,7 +480,7 @@
 typedef void (*MirInputConfigCallback)(
     MirConnection* connection, void* context);
 typedef MirInputConfigCallback mir_input_config_callback
-    __attribute__((deprecated("Use MirInputConfigCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirInputConfigCallback instead");
 
 typedef void (*MirBufferCallback)(MirBuffer*, void* context);
 
@@ -539,24 +540,24 @@
 typedef void (*MirErrorCallback)(
     MirConnection* connection, MirError const* error, void* context);
 typedef MirErrorCallback mir_error_callback
-    __attribute__((deprecated("Use MirErrorCallback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirErrorCallback instead");
 
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 
 typedef void (*mir_surface_callback)(MirSurface *surface, void *client_context)
-__attribute__((deprecated("Use MirWindowCallback instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowCallback instead");
 
 typedef void (*mir_surface_event_callback)(
     MirSurface* surface, MirEvent const* event, void* context)
-__attribute__((deprecated("Use MirWindowEventCallback instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowEventCallback instead");
 
 typedef void (*mir_surface_id_callback)(
     MirSurface* surface, MirPersistentId* id, void* context)
-__attribute__((deprecated("Use MirWindowIdCallback instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use MirWindowIdCallback instead");
 
 typedef void (*MirRenderSurfaceCallback)(MirRenderSurface*, void* context)
-__attribute__((deprecated("This type is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This type is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 typedef MirSurfaceParameters MirWindowParameters;
 
 
=== modified file 'include/client/mir_toolkit/debug/surface.h'
--- include/client/mir_toolkit/debug/surface.h	2017-01-18 04:43:15 +0000
+++ include/client/mir_toolkit/debug/surface.h	2017-04-25 09:32:38 +0000
@@ -19,6 +19,7 @@
 #define MIR_CLIENT_LIBRARY_DEBUG_H
 
 #include <mir_toolkit/mir_client_library.h>
+#include <mir_toolkit/deprecations.h>
 
 /* This header defines debug interfaces that aren't expected to be generally useful
  * and do not have the same API-stability guarantees that the main API has */
@@ -65,13 +66,13 @@
 bool mir_debug_surface_coords_to_screen(MirSurface *surface,
                                        int x, int y,
                                        int* screen_x, int* screen_y)
-__attribute__((deprecated("Use mir_extension_window_coordinate_translation instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_extension_window_coordinate_translation instead");
 
 int mir_debug_surface_id(MirSurface *surface)
-__attribute__((deprecated("Use mir_debug_window_id() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_debug_window_id() instead");
 
 uint32_t mir_debug_surface_current_buffer_id(MirSurface *surface)
-__attribute__((deprecated("Use mir_debug_window_current_buffer_id() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_debug_window_current_buffer_id() instead");
 
 #pragma GCC diagnostic pop
 
 
=== modified file 'include/client/mir_toolkit/events/event.h'
--- include/client/mir_toolkit/events/event.h	2017-01-25 08:12:00 +0000
+++ include/client/mir_toolkit/events/event.h	2017-04-25 09:32:38 +0000
@@ -22,6 +22,7 @@
 #include <stddef.h>
 #include <stdint.h>
 #include "mir_toolkit/common.h"
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -58,24 +59,24 @@
 #pragma GCC diagnostic pop
 
 typedef struct MirSurfaceEvent MirSurfaceEvent
-    __attribute__ ((deprecated("use MirWindowEvent instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowEvent instead");
 typedef struct MirSurfaceEvent MirWindowEvent;
 typedef struct MirResizeEvent MirResizeEvent;
 typedef struct MirPromptSessionEvent MirPromptSessionEvent;
 typedef struct MirOrientationEvent MirOrientationEvent;
 typedef struct MirCloseSurfaceEvent MirCloseSurfaceEvent
-    __attribute__ ((deprecated("use MirCloseWindowEvent instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("use MirCloseWindowEvent instead");
 typedef struct MirCloseSurfaceEvent MirCloseWindowEvent;
 typedef struct MirInputEvent MirInputEvent;
 typedef struct MirKeymapEvent MirKeymapEvent;
 typedef struct MirInputConfigurationEvent MirInputConfigurationEvent 
-    __attribute__ ((deprecated("Use MirInputDeviceStateEvent and the MirInputConfig callback instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Use MirInputDeviceStateEvent and the MirInputConfig callback instead");
 typedef struct MirSurfaceOutputEvent MirSurfaceOutputEvent
-    __attribute__ ((deprecated("use MirWindowOutputEvent instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowOutputEvent instead");
 typedef struct MirSurfaceOutputEvent MirWindowOutputEvent;
 typedef struct MirInputDeviceStateEvent MirInputDeviceStateEvent;
 typedef struct MirSurfacePlacementEvent MirSurfacePlacementEvent
-    __attribute__ ((deprecated("use MirWindowPlacementEvent instead")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowPlacementEvent instead");
 typedef struct MirSurfacePlacementEvent MirWindowPlacementEvent;
 
 typedef struct MirCookie MirCookie;
@@ -136,7 +137,7 @@
  * \return           The associated MirSurfaceEvent
  */
 MirSurfaceEvent const* mir_event_get_surface_event(MirEvent const* event)
-__attribute__ ((deprecated("use mir_event_get_window_event instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_event_get_window_event instead");
 
 /**
  * Retrieve the MirWindowEvent associated with a MirEvent of
@@ -195,7 +196,7 @@
  * \return           The associated MirCloseSurfaceEvent
  */
 /// @cond
-__attribute__ ((deprecated))
+MIR_FOR_REMOVAL_IN_VERSION_1("Use of this function is pointless as there is no way to use the return value")
 /// @endcond
 MirCloseSurfaceEvent const* mir_event_get_close_surface_event(MirEvent const* event);
 #pragma GCC diagnostic pop
@@ -223,7 +224,7 @@
  * \return           The associated MirInputConfigurationEvent
  */
 /// @cond
-__attribute__((deprecated))
+MIR_FOR_REMOVAL_IN_VERSION_1("Input devices and changes to the input devices are indicated via the MirInputConfigCallback")
 /// @endcond
 MirInputConfigurationEvent const* mir_event_get_input_configuration_event(MirEvent const* event);
 #pragma GCC diagnostic pop
@@ -242,7 +243,7 @@
  * \return           The associated MirSurfaceOutputEvent
  */
 MirSurfaceOutputEvent const* mir_event_get_surface_output_event(MirEvent const* event)
-__attribute__((deprecated("use mir_event_get_window_output_event")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_event_get_window_output_event");
 
 /**
  * Retrieve the MirWindowOutputEvent associated with a MirEvent of type
@@ -279,7 +280,7 @@
  * \return           The associated MirSurfacePlacementEvent
  */
 MirSurfacePlacementEvent const* mir_event_get_surface_placement_event(MirEvent const* event)
-__attribute__((deprecated("use mir_event_get_window_placement_event")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_event_get_window_placement_event");
 
 /**
  * Retrieve the MirWindowPlacementEvent associated with a MirEvent of
 
=== modified file 'include/client/mir_toolkit/events/input_configuration_event.h'
--- include/client/mir_toolkit/events/input_configuration_event.h	2017-01-20 16:27:50 +0000
+++ include/client/mir_toolkit/events/input_configuration_event.h	2017-04-25 09:32:38 +0000
@@ -20,6 +20,7 @@
 #define MIR_TOOLKIT_EVENTS_INPUT_CONFIGURATION_EVENT_H_
 
 #include <mir_toolkit/events/event.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -45,7 +46,7 @@
     mir_input_configuration_action_configuration_changed,
     mir_input_configuration_action_device_reset
 } MirInputConfigurationAction
-__attribute__((deprecated));
+MIR_FOR_REMOVAL_IN_VERSION_1("Input devices and changes to the input devices are indicated via the MirInputConfigCallback");
 
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
@@ -55,7 +56,8 @@
  * \param[in] ev The input configuration event
  * \return       The action
  */
-MirInputConfigurationAction mir_input_configuration_event_get_action(MirInputConfigurationEvent const* ev) __attribute__((deprecated));
+MirInputConfigurationAction mir_input_configuration_event_get_action(MirInputConfigurationEvent const* ev)
+MIR_FOR_REMOVAL_IN_VERSION_1("Input devices and changes to the input devices are indicated via the MirInputConfigCallback");
 
 /**
  * Retreive the time associated with a MirInputConfiguration event
@@ -63,7 +65,8 @@
  * \param[in] ev The input configuration event
  * \return       The time in nanoseconds since epoch
  */
-int64_t mir_input_configuration_event_get_time(MirInputConfigurationEvent const* ev) __attribute__((deprecated));
+int64_t mir_input_configuration_event_get_time(MirInputConfigurationEvent const* ev)
+MIR_FOR_REMOVAL_IN_VERSION_1("Input devices and changes to the input devices are indicated via the MirInputConfigCallback");
 
 /**
  * Retreive the device id associated with a MirInputConfiguration event
@@ -71,7 +74,8 @@
  * \param[in] ev The input configuration event
  * \return       The device id or -1 if not applicable to events of this action
  */
-MirInputDeviceId mir_input_configuration_event_get_device_id(MirInputConfigurationEvent const* ev) __attribute__((deprecated));
+MirInputDeviceId mir_input_configuration_event_get_device_id(MirInputConfigurationEvent const* ev)
+MIR_FOR_REMOVAL_IN_VERSION_1("Input devices and changes to the input devices are indicated via the MirInputConfigCallback");
 #pragma GCC diagnostic pop
 
 #ifdef __cplusplus
 
=== modified file 'include/client/mir_toolkit/events/surface_event.h'
--- include/client/mir_toolkit/events/surface_event.h	2017-01-23 03:38:33 +0000
+++ include/client/mir_toolkit/events/surface_event.h	2017-04-25 09:32:38 +0000
@@ -20,6 +20,7 @@
 #define MIR_TOOLKIT_EVENTS_SURFACE_EVENT_H_
 
 #include <mir_toolkit/events/event.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -39,7 +40,7 @@
  * \return           The associated attribute
  */
 MirSurfaceAttrib mir_surface_event_get_attribute(MirSurfaceEvent const* event)
-__attribute__ ((deprecated("use mir_window_event_get_attribute instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_event_get_attribute instead");
 
 /**
  * Retrieve the new value of the associated attribute for a given MirSurfaceEvent
@@ -48,7 +49,7 @@
  * \return           The associated attribute value
  */
 int mir_surface_event_get_attribute_value(MirSurfaceEvent const* event)
-__attribute__ ((deprecated("use make_event with mir_window_event_get_attribute_value instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use make_event with mir_window_event_get_attribute_value instead");
 #pragma GCC diagnostic pop
 
 #ifdef __cplusplus
 
=== modified file 'include/client/mir_toolkit/events/surface_output_event.h'
--- include/client/mir_toolkit/events/surface_output_event.h	2017-01-23 03:38:33 +0000
+++ include/client/mir_toolkit/events/surface_output_event.h	2017-04-25 09:32:38 +0000
@@ -20,6 +20,7 @@
 #define MIR_TOOLKIT_SURFACE_OUTPUT_EVENT_H_
 
 #include <mir_toolkit/events/event.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -39,7 +40,7 @@
  * \return          The new DPI value for the surface is primarily on.
  */
 int mir_surface_output_event_get_dpi(MirSurfaceOutputEvent const* ev)
-__attribute__ ((deprecated("use mir_window_output_event_get_dpi instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_dpi instead");
 
 /**
  * Retrieve the form factor of the new output configuration of a MirSurfaceOutputEvent
@@ -48,7 +49,7 @@
  * \return          The new form factor of the output the surface is primarily on.
  */
 MirFormFactor mir_surface_output_event_get_form_factor(MirSurfaceOutputEvent const* ev)
-__attribute__ ((deprecated("use mir_window_output_event_get_form_factor instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_form_factor instead");
 
 /**
  * Retrieve the suggested scaling factor of the new output configuration of a
@@ -58,7 +59,7 @@
  * \return          The new scaling factor of the output the surface is primarily on.
  */
 float mir_surface_output_event_get_scale(MirSurfaceOutputEvent const* ev)
-__attribute__ ((deprecated("use mir_window_output_event_get_scale instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_scale instead");
 
 /**
  * Retrieve the maximum refresh rate of the output(s) associated with a
@@ -70,7 +71,7 @@
  * \return          The refresh rate in Hz
  */
 double mir_surface_output_event_get_refresh_rate(MirSurfaceOutputEvent const* ev)
-__attribute__ ((deprecated("use mir_window_output_event_get_refresh_rate instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_refresh_rate instead");
 
 /**
  * Retrieve the ID of the output this surface is on from a MirSurfaceOutputEvent
@@ -80,7 +81,7 @@
  *                  (From MirDisplayOutput::output_id)
  */
 uint32_t mir_surface_output_event_get_output_id(MirSurfaceOutputEvent const *ev)
-__attribute__ ((deprecated("use mir_window_output_event_get_output_id instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_output_id instead");
 
 #pragma GCC diagnostic pop
 
 
=== modified file 'include/client/mir_toolkit/events/surface_placement.h'
--- include/client/mir_toolkit/events/surface_placement.h	2017-01-19 05:30:03 +0000
+++ include/client/mir_toolkit/events/surface_placement.h	2017-04-25 09:32:38 +0000
@@ -20,6 +20,7 @@
 #define MIR_TOOLKIT_SURFACE_PLACEMENT_H_
 
 #include <mir_toolkit/client_types.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -38,7 +39,7 @@
  * \return            The position relative to the parent surface
  */
 MirRectangle mir_surface_placement_get_relative_position(MirSurfacePlacementEvent const* event)
-__attribute__ ((deprecated("use mir_window_placement_get_relative_position instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_placement_get_relative_position instead");
 
 #ifdef __cplusplus
 }
 
=== modified file 'include/client/mir_toolkit/mir_blob.h'
--- include/client/mir_toolkit/mir_blob.h	2017-01-19 05:30:03 +0000
+++ include/client/mir_toolkit/mir_blob.h	2017-04-25 09:32:38 +0000
@@ -19,6 +19,7 @@
 #define MIR_TOOLKIT_MIR_BLOB_H_
 
 #include <mir_toolkit/client_types.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -35,7 +36,7 @@
  * \return                 A blob
  */
 MirBlob* mir_blob_from_display_configuration(MirDisplayConfiguration* configuration)
-__attribute__ ((deprecated("use mir_blob_from_display_config instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_blob_from_display_config instead");
 
 /**
  * Create a blob from a display config
@@ -65,7 +66,7 @@
  * \return                 A display configuration
  */
 MirDisplayConfiguration* mir_blob_to_display_configuration(MirBlob* blob)
-__attribute__ ((deprecated("use mir_blob_to_display_config instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_blob_to_display_config instead");
 
 /**
  * Create a blob from a display config
 
=== modified file 'include/client/mir_toolkit/mir_buffer_stream.h'
--- include/client/mir_toolkit/mir_buffer_stream.h	2017-01-24 07:49:13 +0000
+++ include/client/mir_toolkit/mir_buffer_stream.h	2017-04-25 09:32:38 +0000
@@ -20,6 +20,7 @@
 
 #include <mir_toolkit/mir_native_buffer.h>
 #include <mir_toolkit/client_types.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -141,7 +142,8 @@
  *                            mir_platform_type_gbm
  */
 /// @cond
-__attribute__ ((deprecated))
+MIR_FOR_REMOVAL_IN_VERSION_1("To identify the graphics platform use mir_connection_get_graphics_module(). \n"
+                             "To safely interpret the buffer contents use mir_buffer_stream_get_graphics_region()")
 /// @endcond
 MirPlatformType mir_buffer_stream_get_platform_type(MirBufferStream *stream);
 
 
=== modified file 'include/client/mir_toolkit/mir_connection.h'
--- include/client/mir_toolkit/mir_connection.h	2017-01-24 19:53:45 +0000
+++ include/client/mir_toolkit/mir_connection.h	2017-04-25 09:32:38 +0000
@@ -20,6 +20,7 @@
 
 #include <mir_toolkit/client_types.h>
 #include <mir_toolkit/common.h>
+#include <mir_toolkit/deprecations.h>
 
 #include <stdbool.h>
 
@@ -93,7 +94,7 @@
  *   \param [out] platform_package  Structure to be populated
  */
 void mir_connection_get_platform(MirConnection *connection, MirPlatformPackage *platform_package)
-__attribute__((deprecated("use platform extensions instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use platform extensions instead");
 
 /**
  * Query graphics platform module.
@@ -105,7 +106,7 @@
  *   \param [out] properties    Structure to be populated
  */
 void mir_connection_get_graphics_module(MirConnection *connection, MirModuleProperties *properties)
-__attribute__((deprecated("use graphics module extension instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use graphics module extension instead");
 
 /**
  * Register a callback to be called when a Lifecycle state change occurs.
@@ -156,7 +157,7 @@
  *   \return                        structure that describes the display configuration
  */
 MirDisplayConfiguration* mir_connection_create_display_config(MirConnection *connection)
-__attribute__ ((deprecated("use mir_connection_create_display_configuration instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_connection_create_display_configuration instead");
 
 /**
  * Query the display
@@ -188,7 +189,7 @@
  *   \param [in] display_configuration  The display_configuration information resource to be destroyed
  */
 void mir_display_config_destroy(MirDisplayConfiguration* display_configuration)
-__attribute__ ((deprecated("use mir_display_config_release instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_display_config_release instead");
 
 /**
  * Apply the display configuration
@@ -204,7 +205,7 @@
  *   \return                            A handle that can be passed to mir_wait_for
  */
 MirWaitHandle* mir_connection_apply_display_config(MirConnection *connection, MirDisplayConfiguration* display_configuration)
-__attribute__ ((deprecated("use mir_connection_apply_session_display_config instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_connection_apply_session_display_config instead");
 
 /**
  * Apply the display config for the connection
@@ -254,7 +255,7 @@
 MirWaitHandle* mir_connection_set_base_display_config(
     MirConnection* connection,
     MirDisplayConfiguration const* display_configuration)
-__attribute__ ((deprecated("use mir_connection_preview_base_display_configuration/mir_connection_confirm_base_display_configuration")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_connection_preview_base_display_configuration/mir_connection_confirm_base_display_configuration");
 
 
 /**
@@ -379,7 +380,7 @@
     MirConnection* connection,
     MirPlatformMessage const* request,
     MirPlatformOperationCallback callback, void* context)
-__attribute__ ((deprecated("use platform specific extensions instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use platform specific extensions instead");
 
 /**
  * Create a snapshot of the attached input devices and device configurations.
@@ -399,7 +400,7 @@
  * \param [in] config  The input configuration
  */
 void mir_input_config_destroy(MirInputConfig const* config)
-__attribute__ ((deprecated("use mir_input_config_release instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_input_config_release instead");
 
 /**
  * Release this snapshot of the input configuration.
 
=== modified file 'include/client/mir_toolkit/mir_cursor_configuration.h'
--- include/client/mir_toolkit/mir_cursor_configuration.h	2017-01-18 02:29:37 +0000
+++ include/client/mir_toolkit/mir_cursor_configuration.h	2017-04-25 09:32:38 +0000
@@ -20,6 +20,7 @@
 
 #include <mir_toolkit/common.h>
 #include <mir_toolkit/client_types.h>
+#include <mir_toolkit/deprecations.h>
 
 /**
  * Opaque structure containing cursor parameterization. Create with mir_cursor* family.
@@ -53,7 +54,7 @@
  *            to_mir_cursor_configuration_destroy
  */
 /// @cond
-__attribute__ ((deprecated))
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_cursor_name()")
 /// @endcond
 MirCursorConfiguration *mir_cursor_configuration_from_name(char const* name);
 
 
=== modified file 'include/client/mir_toolkit/mir_display_configuration.h'
--- include/client/mir_toolkit/mir_display_configuration.h	2017-02-20 05:36:21 +0000
+++ include/client/mir_toolkit/mir_display_configuration.h	2017-04-25 09:32:38 +0000
@@ -20,6 +20,7 @@
 #define MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_
 
 #include "client_types.h"
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -60,7 +61,7 @@
  */
 int mir_display_config_get_max_simultaneous_outputs(
     MirDisplayConfig const* config)
-    __attribute__((deprecated("Not accurate in Mir 0.26 and later. May be removed in future.")));
+    MIR_FOR_REMOVAL_IN_VERSION_1("Not accurate in Mir 0.26 and later. May be removed in future.");
 
 /**
  * Get the number of outputs available in this display configuration.
@@ -268,7 +269,7 @@
  * \returns           The name of the output type.
  */
 char const* mir_display_output_type_name(MirDisplayOutputType type)
-__attribute__((deprecated("use mir_output_type_name instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_output_type_name instead");
 
 /**
  * Get the textual name of an output type.
 
=== modified file 'include/client/mir_toolkit/mir_persistent_id.h'
--- include/client/mir_toolkit/mir_persistent_id.h	2017-02-02 19:52:04 +0000
+++ include/client/mir_toolkit/mir_persistent_id.h	2017-04-25 09:32:38 +0000
@@ -19,6 +19,7 @@
 #define MIR_TOOLKIT_MIR_PERSISTENT_ID_H_
 
 #include <mir_toolkit/client_types.h>
+#include <mir_toolkit/deprecations.h>
 
 #include <stdbool.h>
 
@@ -39,7 +40,7 @@
  * \note This does not guarantee that the ID refers to a currently valid object.
  */
 bool mir_persistent_id_is_valid(MirPersistentId* id)
-__attribute__((deprecated("Use mir_window_id_is_valid() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_id_is_valid() instead");
 
 /**
  * \brief Free a MirPersistentId
@@ -48,7 +49,7 @@
  *       object referred to by \arg id.
  */
 void mir_persistent_id_release(MirPersistentId* id)
-__attribute__((deprecated("Use mir_window_id_release() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_id_release() instead");
 
 /**
  * \brief Get a string representation of a MirSurfaceId
@@ -59,7 +60,7 @@
  * \see mir_surface_id_from_string
  */
 char const* mir_persistent_id_as_string(MirPersistentId* id)
-__attribute__((deprecated("Use mir_window_id_as_string() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_id_as_string() instead");
 
 /**
  * \brief Deserialise a string representation of a MirSurfaceId
@@ -67,7 +68,7 @@
  * \return The deserialised MirSurfaceId
  */
 MirPersistentId* mir_persistent_id_from_string(char const* string_representation)
-__attribute__((deprecated("Use mir_window_id_from_string() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_id_from_string() instead");
 
 #pragma GCC diagnostic pop
 
 
=== modified file 'include/client/mir_toolkit/mir_platform_message.h'
--- include/client/mir_toolkit/mir_platform_message.h	2017-01-18 02:29:37 +0000
+++ include/client/mir_toolkit/mir_platform_message.h	2017-04-25 09:32:38 +0000
@@ -19,6 +19,7 @@
 #define MIR_TOOLKIT_MIR_PLATFORM_MESSAGE_H_
 
 #include <sys/types.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -51,7 +52,7 @@
  *   \param [in] opcode    The platform message opcode
  *   \return               The created MirPlatformMessage
  */
-__attribute__((deprecated("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")))
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")
 MirPlatformMessage* mir_platform_message_create(unsigned int opcode);
 
 /**
@@ -59,7 +60,7 @@
  *
  *   \param [in] message   The MirPlatformMessage
  */
-__attribute__((deprecated("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")))
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")
 void mir_platform_message_release(MirPlatformMessage const* message);
 
 /**
@@ -71,7 +72,7 @@
  *   \param [in] data       Pointer to the data
  *   \param [in] data_size  The size of the data in bytes
  */
-__attribute__((deprecated("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")))
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")
 void mir_platform_message_set_data(MirPlatformMessage* message, void const* data, size_t data_size);
 
 /**
@@ -89,7 +90,7 @@
  *   \param [in] fds       Pointer to the array of fds
  *   \param [in] num_fds   The number of fds
  */
-__attribute__((deprecated("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")))
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")
 void mir_platform_message_set_fds(MirPlatformMessage* message, int const* fds, size_t num_fds);
 
 /**
@@ -98,7 +99,7 @@
  *   \param [in] message   The MirPlatformMessage
  *   \return               The opcode
  */
-__attribute__((deprecated("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")))
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")
 unsigned int mir_platform_message_get_opcode(MirPlatformMessage const* message);
 
 /**
@@ -111,7 +112,7 @@
  *   \param [in] message   The MirPlatformMessage
  *   \return               The data
  */
-__attribute__((deprecated("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")))
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")
 MirPlatformMessageData mir_platform_message_get_data(MirPlatformMessage const* message);
 
 /**
@@ -128,7 +129,7 @@
  *   \param [in] message   The MirPlatformMessage
  *   \return               The fds
  */
-__attribute__((deprecated("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")))
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_extension_mesa_drm_auth or mir_extension_set_gbm_device")
 MirPlatformMessageFds mir_platform_message_get_fds(MirPlatformMessage const* message);
 
 #ifdef __cplusplus
 
=== modified file 'include/client/mir_toolkit/mir_screencast.h'
--- include/client/mir_toolkit/mir_screencast.h	2017-01-19 05:30:03 +0000
+++ include/client/mir_toolkit/mir_screencast.h	2017-04-25 09:32:38 +0000
@@ -18,6 +18,7 @@
 #define MIR_TOOLKIT_MIR_SCREENCAST_H_
 
 #include <mir_toolkit/client_types.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -143,7 +144,7 @@
 MirScreencast* mir_connection_create_screencast_sync(
     MirConnection* connection,
     MirScreencastParameters* parameters)
-__attribute__ ((deprecated("use mir_screencast_create_sync instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_screencast_create_sync instead");
 
 /**
  * Release the specified screencast.
 
=== modified file 'include/client/mir_toolkit/mir_surface.h'
--- include/client/mir_toolkit/mir_surface.h	2017-01-24 11:06:35 +0000
+++ include/client/mir_toolkit/mir_surface.h	2017-04-25 09:32:38 +0000
@@ -22,6 +22,7 @@
 #include <mir_toolkit/client_types.h>
 #include <mir_toolkit/common.h>
 #include <mir_toolkit/mir_cursor_configuration.h>
+#include <mir_toolkit/deprecations.h>
 
 #include <stdbool.h>
 
@@ -40,7 +41,7 @@
 MirSurfaceSpec* mir_connection_create_spec_for_normal_surface(MirConnection* connection,
                                                               int width, int height,
                                                               MirPixelFormat format)
-__attribute__((deprecated("Use mir_create_normal_window_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_normal_window_spec() instead");
 
 MirSurfaceSpec*
 mir_connection_create_spec_for_menu(MirConnection* connection,
@@ -50,7 +51,7 @@
                                     MirSurface* parent,
                                     MirRectangle* rect,
                                     MirEdgeAttachment edge)
-__attribute__((deprecated("Use mir_specify_menu() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_specify_menu() instead");
 
 MirSurfaceSpec*
 mir_connection_create_spec_for_tooltip(MirConnection* connection,
@@ -58,7 +59,7 @@
                                        MirPixelFormat format,
                                        MirSurface* parent,
                                        MirRectangle* zone)
-__attribute__((deprecated("Use mir_create_tip_window_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_tip_window_spec() instead");
 
 MirSurfaceSpec*
 mir_connection_create_spec_for_tip(MirConnection* connection,
@@ -67,30 +68,30 @@
                                    MirSurface* parent,
                                    MirRectangle* rect,
                                    MirEdgeAttachment edge)
-__attribute__((deprecated("Use mir_create_tip_window_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_tip_window_spec() instead");
 
 MirSurfaceSpec*
 mir_connection_create_spec_for_modal_dialog(MirConnection* connection,
                                             int width, int height,
                                             MirPixelFormat format,
                                             MirSurface* parent)
-__attribute__((deprecated("Use mir_create_modal_dialog_window_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_modal_dialog_window_spec() instead");
 
 MirSurfaceSpec*
 mir_connection_create_spec_for_dialog(MirConnection* connection,
                                       int width, int height,
                                       MirPixelFormat format)
-__attribute__((deprecated("Use mir_create_dialog_window_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_dialog_window_spec() instead");
 
 MirSurfaceSpec* mir_create_surface_spec(MirConnection* connection)
-__attribute__((deprecated("Use mir_create_window_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_window_spec() instead");
 
 MirSurfaceSpec*
 mir_connection_create_spec_for_changes(MirConnection* connection)
-__attribute__((deprecated("Use mir_create_window_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_create_window_spec() instead");
 
 void mir_surface_spec_set_parent(MirSurfaceSpec* spec, MirSurface* parent)
-__attribute__((deprecated("Use mir_window_spec_set_parent() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_set_parent() instead");
 
 /**
  *\deprecated This will soon be a property of the backing content.
@@ -103,77 +104,77 @@
  *                        was removed by use of mir_window_spec_set_streams().
  */
 int mir_surface_get_swapinterval(MirSurface* surface)
-__attribute__((deprecated("This will soon be a property of the backing content")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This will soon be a property of the backing content");
 
 void mir_surface_spec_set_type(MirSurfaceSpec* spec, MirSurfaceType type)
-__attribute__((deprecated("use mir_window_spec_set_type() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_type() instead");
 
 void mir_surface_spec_set_name(MirSurfaceSpec* spec, char const* name)
-__attribute__((deprecated("use mir_window_spec_set_name() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_name() instead");
 
 void mir_surface_spec_set_width(MirSurfaceSpec* spec, unsigned width)
-__attribute__((deprecated("use mir_window_spec_set_width() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_width() instead");
 
 void mir_surface_spec_set_height(MirSurfaceSpec* spec, unsigned height)
-__attribute__((deprecated("use mir_window_spec_set_height() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_height() instead");
 
 void mir_surface_spec_set_width_increment(MirSurfaceSpec* spec, unsigned width_inc)
-__attribute__((deprecated("use mir_window_spec_set_width_increment() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_width_increment() instead");
 
 void mir_surface_spec_set_height_increment(MirSurfaceSpec* spec, unsigned height_inc)
-__attribute__((deprecated("use mir_window_spec_set_height_increment() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_height_increment() instead");
 
 void mir_surface_spec_set_min_width(MirSurfaceSpec* spec, unsigned min_width)
-__attribute__((deprecated("use mir_window_spec_set_min_width() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_min_width() instead");
 
 void mir_surface_spec_set_min_height(MirSurfaceSpec* spec, unsigned min_height)
-__attribute__((deprecated("use mir_window_spec_set_min_height() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_min_height() instead");
 
 void mir_surface_spec_set_max_width(MirSurfaceSpec* spec, unsigned max_width)
-__attribute__((deprecated("use mir_window_spec_set_max_width() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_max_width() instead");
 
 void mir_surface_spec_set_max_height(MirSurfaceSpec* spec, unsigned max_height)
-__attribute__((deprecated("use mir_window_spec_set_max_height() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_max_height() instead");
 
 void mir_surface_spec_set_min_aspect_ratio(MirSurfaceSpec* spec, unsigned width, unsigned height)
-__attribute__((deprecated("use mir_window_spec_set_min_aspect_ratio() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_min_aspect_ratio() instead");
 
 void mir_surface_spec_set_max_aspect_ratio(MirSurfaceSpec* spec, unsigned width, unsigned height)
-__attribute__((deprecated("use mir_window_spec_set_max_aspect_ratio() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_max_aspect_ratio() instead");
 
 void mir_surface_spec_set_fullscreen_on_output(MirSurfaceSpec* spec, uint32_t output_id)
-__attribute__((deprecated("use mir_window_spec_set_fullscreen_on_output() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_fullscreen_on_output() instead");
 
 void mir_surface_spec_set_preferred_orientation(MirSurfaceSpec* spec, MirOrientationMode mode)
-__attribute__((deprecated("use mir_window_spec_set_preferred_orientation() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_preferred_orientation() instead");
 
 bool mir_surface_spec_attach_to_foreign_parent(MirSurfaceSpec* spec,
                                                MirPersistentId* parent,
                                                MirRectangle* attachment_rect,
                                                MirEdgeAttachment edge)
-__attribute__((deprecated("use mir_window_spec_attach_to_foreign_parent() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_attach_to_foreign_parent() instead");
 
 void mir_surface_spec_set_state(MirSurfaceSpec* spec, MirSurfaceState state)
-__attribute__((deprecated("use mir_window_spec_set_state() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_state() instead");
 
 void mir_surface_spec_release(MirSurfaceSpec* spec)
-__attribute__((deprecated("use mir_window_spec_release() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_release() instead");
 
 void mir_surface_spec_set_input_shape(MirSurfaceSpec* spec,
                                       MirRectangle const *rectangles,
                                       size_t n_rects)
-__attribute__((deprecated("use mir_window_spec_set_input_shape() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_input_shape() instead");
 
 void mir_surface_spec_set_event_handler(MirSurfaceSpec* spec,
                                         mir_surface_event_callback callback,
                                         void* context)
-__attribute__((deprecated("use mir_window_spec_set_event_handler() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_event_handler() instead");
 
 void mir_surface_spec_set_shell_chrome(MirSurfaceSpec* spec, MirShellChrome style)
-__attribute__((deprecated("use mir_window_spec_set_shell_chrome() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_shell_chrome() instead");
 
 void mir_surface_spec_set_pointer_confinement(MirSurfaceSpec* spec, MirPointerConfinementState state)
-__attribute__((deprecated("use mir_window_spec_set_pointer_confinement() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_pointer_confinement() instead");
 
 void mir_surface_spec_set_placement(MirSurfaceSpec*     spec,
                                     const MirRectangle* rect,
@@ -182,69 +183,69 @@
                                     MirPlacementHints   placement_hints,
                                     int                 offset_dx,
                                     int                 offset_dy)
-__attribute__((deprecated("use mir_window_spec_set_placement() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_placement() instead");
 
 MirSurfaceSpec* mir_connection_create_spec_for_input_method(MirConnection* connection,
                                                             int width, int height,
                                                             MirPixelFormat format)
-__attribute__((deprecated("use mir_create_input_method_window_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_create_input_method_window_spec() instead");
 
 void mir_surface_spec_set_pixel_format(MirSurfaceSpec* spec, MirPixelFormat format)
-__attribute__((deprecated("use mir_window_spec_set_pixel_format() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_pixel_format() instead");
 
 void mir_surface_spec_set_buffer_usage(MirSurfaceSpec* spec, MirBufferUsage usage)
-__attribute__((deprecated("use mir_window_spec_set_buffer_usage() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_buffer_usage() instead");
 
 void mir_surface_spec_set_streams(MirSurfaceSpec* spec,
                                   MirBufferStreamInfo* streams,
                                   unsigned int num_streams)
-__attribute__((deprecated("use mir_window_spec_set_streams() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_spec_set_streams() instead");
 
 void mir_surface_apply_spec(MirSurface* surface, MirSurfaceSpec* spec)
-__attribute__((deprecated("use mir_window_apply_spec() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_apply_spec() instead");
 
 bool mir_surface_is_valid(MirSurface *surface)
-__attribute__((deprecated("use mir_window_is_valid() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_is_valid() instead");
 
 MirWaitHandle* mir_surface_create(MirSurfaceSpec* requested_specification,
                                   mir_surface_callback callback, void* context)
-__attribute__((deprecated("use mir_create_window() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_create_window() instead");
 
 MirSurface* mir_surface_create_sync(MirSurfaceSpec* requested_specification)
-__attribute__((deprecated("use mir_create_window_sync() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_create_window_sync() instead");
 
 MirWaitHandle *mir_surface_release(
     MirSurface *surface,
     mir_surface_callback callback,
     void *context)
-__attribute__((deprecated("use mir_window_release() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_release() instead");
 
 void mir_surface_release_sync(MirSurface *surface)
-__attribute__((deprecated("use mir_window_release_sync() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_release_sync() instead");
 
 void mir_surface_set_event_handler(MirSurface *surface,
                                    mir_surface_event_callback callback,
                                    void* context)
-__attribute__((deprecated("use mir_window_set_event_handler() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_set_event_handler() instead");
 
 MirBufferStream* mir_surface_get_buffer_stream(MirSurface *surface)
-__attribute__((deprecated("use mir_window_get_buffer_stream() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_buffer_stream() instead");
 
 char const* mir_surface_get_error_message(MirSurface *surface)
-__attribute__((deprecated("use mir_window_get_error_message() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_error_message() instead");
 
 void mir_surface_get_parameters(MirSurface *surface, MirSurfaceParameters *parameters)
-__attribute__((deprecated("use mir_window_get_parameters() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_parameters() instead");
 
 MirSurfaceType mir_surface_get_type(MirSurface* surface)
-__attribute__((deprecated("use mir_window_get_type() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_type() instead");
 
 MirWaitHandle* mir_surface_set_state(MirSurface *surface,
                                      MirSurfaceState state)
-__attribute__((deprecated("use mir_window_set_state() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_set_state() instead");
 
 MirSurfaceState mir_surface_get_state(MirSurface *surface)
-__attribute__((deprecated("use mir_window_get_state() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_state() instead");
 
 /**
  * Set the swapinterval for the default stream.
@@ -260,37 +261,37 @@
  *                        or NULL if the interval could not be supported
  */
 MirWaitHandle* mir_surface_set_swapinterval(MirSurface* surface, int interval)
-__attribute__((deprecated("Swap interval should be set on the backing content")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Swap interval should be set on the backing content");
 
 int mir_surface_get_dpi(MirSurface* surface)
-__attribute__((deprecated("use mir_window_get_dpi() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_dpi() instead");
 
 MirSurfaceFocusState mir_surface_get_focus(MirSurface *surface)
-__attribute__((deprecated("use mir_window_get_focus_state() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_focus_state() instead");
 
 MirSurfaceVisibility mir_surface_get_visibility(MirSurface *surface)
-__attribute__((deprecated("use mir_window_get_visibility() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_visibility() instead");
 
 MirWaitHandle* mir_surface_configure_cursor(MirSurface *surface, MirCursorConfiguration const* parameters)
-__attribute__((deprecated("use mir_window_configure_cursor() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_configure_cursor() instead");
 
 MirOrientation mir_surface_get_orientation(MirSurface *surface)
-__attribute__((deprecated("use mir_window_get_orientation() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_orientation() instead");
 
 MirWaitHandle* mir_surface_set_preferred_orientation(MirSurface *surface, MirOrientationMode orientation)
-__attribute__((deprecated("use mir_window_set_preferred_orientation() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_set_preferred_orientation() instead");
 
 MirOrientationMode mir_surface_get_preferred_orientation(MirSurface *surface)
-__attribute__((deprecated("use mir_window_get_preferred_orientation() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_get_preferred_orientation() instead");
 
 MirWaitHandle* mir_surface_request_persistent_id(MirSurface* surface, mir_surface_id_callback callback, void* context)
-__attribute__((deprecated("use mir_window_request_persistent_id() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_request_persistent_id() instead");
 
 MirPersistentId* mir_surface_request_persistent_id_sync(MirSurface *surface)
-__attribute__((deprecated("use mir_window_request_persistent_id_sync() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_request_persistent_id_sync() instead");
 
 void mir_surface_raise(MirSurface* surface, MirCookie const* cookie)
-__attribute__((deprecated("use mir_window_raise() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_raise() instead");
 
 #pragma GCC diagnostic pop
 
 
=== modified file 'include/client/mir_toolkit/mir_wait.h'
--- include/client/mir_toolkit/mir_wait.h	2017-01-19 23:17:56 +0000
+++ include/client/mir_toolkit/mir_wait.h	2017-04-25 09:32:38 +0000
@@ -19,6 +19,7 @@
 #define MIR_TOOLKIT_MIR_WAIT_H_
 
 #include <mir_toolkit/client_types.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -36,7 +37,7 @@
  *   \param [in] wait_handle  Handle returned by an asynchronous request
  */
 void mir_wait_for(MirWaitHandle *wait_handle)
-__attribute__ ((deprecated("No longer supported - use callbacks or wait for state changes")));
+MIR_FOR_REMOVAL_IN_VERSION_1("No longer supported - use callbacks or wait for state changes");
 
 /**
  * Wait on the supplied handle until one instance of the associated request
@@ -47,7 +48,7 @@
  *   \param [in] wait_handle  Handle returned by an asynchronous request
  */
 void mir_wait_for_one(MirWaitHandle *wait_handle)
-__attribute__ ((deprecated("No longer supported - use callbacks or wait for state changes")));
+MIR_FOR_REMOVAL_IN_VERSION_1("No longer supported - use callbacks or wait for state changes");
 
 
 #ifdef __cplusplus
 
=== modified file 'include/client/mir_toolkit/mir_window.h'
--- include/client/mir_toolkit/mir_window.h	2017-02-03 20:39:06 +0000
+++ include/client/mir_toolkit/mir_window.h	2017-04-25 09:32:38 +0000
@@ -22,6 +22,7 @@
 #include <mir_toolkit/client_types.h>
 #include <mir_toolkit/common.h>
 #include <mir_toolkit/mir_cursor_configuration.h>
+#include <mir_toolkit/deprecations.h>
 
 #include <stdbool.h>
 
@@ -555,7 +556,7 @@
                                         MirRenderSurface* render_surface,
                                         int logical_width, int logical_height,
                                         int displacement_x, int displacement_y)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 #pragma GCC diagnostic pop
 
 /**
@@ -774,7 +775,7 @@
  * \param [in,out] context   User data passed to completion callback.
  */
 void mir_window_request_persistent_id(MirWindow* window, MirWindowIdCallback callback, void* context)
-__attribute__((deprecated("Use mir_window_request_window_id() instead")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_request_window_id() instead");
 void mir_window_request_window_id(MirWindow* window, MirWindowIdCallback callback, void* context);
 
 /**
@@ -784,7 +785,7 @@
  *         be freed with a call to mir_persistent_id_release()
  */
 MirPersistentId* mir_window_request_persistent_id_sync(MirWindow* window)
-__attribute__((deprecated("Use mir_window_request_window_id_sync")));
+MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_request_window_id_sync");
 MirWindowId* mir_window_request_window_id_sync(MirWindow* window);
 #ifdef __cplusplus
 }
 
=== modified file 'include/client/mir_toolkit/rs/mir_render_surface.h'
--- include/client/mir_toolkit/rs/mir_render_surface.h	2017-03-16 16:47:21 +0000
+++ include/client/mir_toolkit/rs/mir_render_surface.h	2017-04-25 09:32:38 +0000
@@ -21,6 +21,7 @@
 #define MIR_TOOLKIT_MIR_RENDER_SURFACE_H_
 
 #include <mir_toolkit/client_types.h>
+#include <mir_toolkit/deprecations.h>
 
 #ifdef __cplusplus
 /**
@@ -49,7 +50,7 @@
     int width, int height,
     MirRenderSurfaceCallback callback,
     void* context)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Create a render surface and wait for the result
@@ -64,7 +65,7 @@
 MirRenderSurface* mir_connection_create_render_surface_sync(
     MirConnection* connection,
     int width, int height)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Get the size of the MirRenderSurface
@@ -76,7 +77,7 @@
 void mir_render_surface_get_size(
     MirRenderSurface* render_surface,
     int* width, int* height)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Set the size of the MirRenderSurface
@@ -88,7 +89,7 @@
 void mir_render_surface_set_size(
     MirRenderSurface* render_surface,
     int width, int height)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Test for a valid render surface
@@ -100,7 +101,7 @@
  */
 bool mir_render_surface_is_valid(
     MirRenderSurface* render_surface)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Retrieve a text description of the error. The returned string is owned by
@@ -113,7 +114,7 @@
  */
 char const *mir_render_surface_get_error_message(
     MirRenderSurface* render_surface)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Release the specified render surface
@@ -122,7 +123,7 @@
  */
 void mir_render_surface_release(
     MirRenderSurface* render_surface)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Obtain the buffer stream backing a given render surface.
@@ -142,7 +143,7 @@
     MirRenderSurface* render_surface,
     int width, int height,
     MirPixelFormat format)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /**
  * Obtain the presentation chain backing a given render surface.
@@ -155,7 +156,7 @@
  */
 MirPresentationChain* mir_render_surface_get_presentation_chain(
     MirRenderSurface* render_surface)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 /** Query whether the server supports a given presentation mode.
  *
@@ -189,7 +190,7 @@
     MirWindowSpec* spec,
     MirRenderSurface* render_surface,
     int hotspot_x, int hotspot_y)
-__attribute__((deprecated("This function is slated for rename due to MirRenderSurface-->MirSurface transition")));
+MIR_FOR_REMOVAL_IN_VERSION_1("This function is slated for rename due to MirRenderSurface-->MirSurface transition");
 
 #pragma GCC diagnostic pop
 
 
=== modified file 'include/core/mir_toolkit/common.h'
--- include/core/mir_toolkit/common.h	2017-01-23 22:29:00 +0000
+++ include/core/mir_toolkit/common.h	2017-04-25 09:32:38 +0000
@@ -21,6 +21,8 @@
 #ifndef MIR_COMMON_H_
 #define MIR_COMMON_H_
 
+#include <mir_toolkit/deprecations.h>
+
 //for clang
 #ifndef __has_feature
   #define __has_feature(x) 0  // Compatibility with non-clang
@@ -35,7 +37,7 @@
     (__has_extension(attribute_deprecated_with_message) && \
      __has_extension(enumerator_attributes))
   #define MIR_DEPRECATED_ENUM(ENUM, INSTEAD) \
-      ENUM __attribute__ ((deprecated("Use " #INSTEAD " instead")))
+      ENUM MIR_FOR_REMOVAL_IN_VERSION_1("Use " #INSTEAD " instead")
 #else
   #define MIR_DEPRECATED_ENUM(ENUM, INSTEAD) \
       ENUM
@@ -65,7 +67,7 @@
     mir_surface_attrib_preferred_orientation,
     /* Must be last */
     mir_surface_attribs
-} MirSurfaceAttrib __attribute__ ((deprecated("use MirWindowAttrib")));
+} MirSurfaceAttrib MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowAttrib");
 
 /**
  * Attributes of a window that the client and server/shell may wish to
@@ -102,7 +104,7 @@
     mir_surface_type_satellite,    /**< AKA "toolbox"/"toolbar"             */
     mir_surface_type_tip,          /**< AKA "tooltip"                       */
     mir_surface_types
-} MirSurfaceType __attribute__ ((deprecated("use MirWindowType")));
+} MirSurfaceType MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowType");
 
 typedef enum MirWindowType
 {
@@ -132,7 +134,7 @@
     mir_surface_state_horizmaximized,
     mir_surface_state_hidden,
     mir_surface_states
-} MirSurfaceState __attribute__ ((deprecated("use MirWindowState")));
+} MirSurfaceState MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowState");
 
 typedef enum MirWindowState
 {
@@ -154,7 +156,7 @@
 {
     mir_surface_unfocused = 0,
     mir_surface_focused
-} MirSurfaceFocusState __attribute__ ((deprecated("use MirWindowFocusState")));
+} MirSurfaceFocusState MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowFocusState");
 
 typedef enum MirWindowFocusState
 {
@@ -166,7 +168,7 @@
 {
     mir_surface_visibility_occluded = 0,
     mir_surface_visibility_exposed
-} MirSurfaceVisibility __attribute__ ((deprecated("use MirWindowFocusState")));
+} MirSurfaceVisibility MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowFocusState");
 
 typedef enum MirWindowVisibility
 {
 
=== added file 'include/core/mir_toolkit/deprecations.h'
--- include/core/mir_toolkit/deprecations.h	1970-01-01 00:00:00 +0000
+++ include/core/mir_toolkit/deprecations.h	2017-04-25 09:32:38 +0000
@@ -0,0 +1,36 @@
+/*
+ * Copyright © 2017 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef MIR_DEPRECATIONS_H_
+#define MIR_DEPRECATIONS_H_
+
+#ifndef MIR_ENABLE_DEPRECATIONS
+    // use __GNUC__ < 6 as a proxy for building on Ubunutu 16.04LTS ("Xenial")
+    #if defined(__clang__) || !defined(__GNUC__) || (__GNUC__ >= 6)
+        #define MIR_ENABLE_DEPRECATIONS 1
+    #else
+        #define MIR_ENABLE_DEPRECATIONS 0
+    #endif
+#endif
+
+#if MIR_ENABLE_DEPRECATIONS > 0
+    #define MIR_FOR_REMOVAL_IN_VERSION_1(message)\
+    __attribute__((deprecated(message)))
+#else
+    #define MIR_FOR_REMOVAL_IN_VERSION_1(message)
+#endif
+
+#endif //MIR_DEPRECATIONS_H_