keysyms-update: Add deprecation guards to the deprecated header

[profile/ivi/clutter.git] / README.in

diff --git a/README.in b/README.in
index 332f822..4d0a34c 100644 (file)
--- a/README.in
+++ b/README.in
@@ -161,8 +161,11 @@ Clutter has additional command line options for the configure script:
         Build Clutter with profiling instrumentation. Requires the GNU
         C Compiler and the UProf library.
 
- --enable-conform=[yes/no]
-        Build the Clutter conformance test suite.
+ --disable-tests
+        Disable building the Clutter tests suite.
+
+ --disable-examples
+        Disable building the Clutter API reference examples.
 
  --enable-deprecated=[yes/no]
         Whether deprecated symbols should be available when compiling Clutter.
@@ -240,7 +243,7 @@ In the report you should include:
 
   • what system you're running Clutter on;
   • which version of Clutter you are using;
-  • which version of GLib and OpenGL (or OpenGL ES) you are using;
+  • which version of GLib, Cogl, and OpenGL (or OpenGL ES) you are using;
   • which video card and which drivers you are using, including output of
     glxinfo and xdpyinfo (if applicable);
   • how to reproduce the bug.
@@ -279,6 +282,15 @@ Which is available here:
 
   http://git.fishsoup.net/cgit/git-bz/
 
+Patches submitted against Clutter have to pass the conformance test suite, or,
+if possible, add new unit tests for the conformance test suite in case of new
+features. Ensure you run the conformance test suite every for every patch you
+wish to submit, by using:
+
+  cd tests/conform && make test
+
+and verifying that the test suite passes.
+
 RELEASE NOTES
 -------------------------------------------------------------------------------
 
@@ -286,16 +298,59 @@ Relevant information for developers with existing Clutter applications
 wanting to port to newer releases (see NEWS for general information on new
 features).
 
+Release Notes for Clutter 1.12
+-------------------------------------------------------------------------------
+
+• ClutterBinLayout no longer requests or allocates size for children that are
+  not visible, which is how the other layout managers work.
+
+• The expansion and alignment layout properties in all the layout managers
+  that provide them have been deprecated in favour of the equivalent ones
+  on ClutterActor; the ClutterLayoutManager implementations provided by
+  Clutter have been updated to honour the ClutterActor:x-expand,
+  ClutterActor:y-expand, ClutterActor:x-align, and ClutterActor:y-align
+  properties, if set.
+
+• Setting the ClutterActor:fixed-position-set to FALSE will reset any
+  currently set fixed position to (0, 0).
+
 Release Notes for Clutter 1.10
 -------------------------------------------------------------------------------
 
+• The ClutterActor::paint, ClutterActor::queue-redraw, and
+  ClutterActor::queue-relayout signals are now annotated as not allowing
+  signal emission hooks; this enables some optimization inside GLib, and
+  given the amount of emissions these three signals have, we want to get
+  through all the fast paths we can.
+
+• The ClutterActorBox parameter of the ClutterActor::allocation-changed
+  signal is now marked as G_SIGNAL_TYPE_STATIC_SCOPE.
+
+• The clutter-stage-window.h header is not installed any more; this header
+  was never meant to be public in the first place, and nothing could have
+  been implementing the ClutterStageWindow interface and use it with Clutter.
+
+• ClutterActor will call its unmap() implementation when it is removed from
+  its parent. This may happen after the ClutterActor::destroy signal has been
+  emitted, i.e. during its dispose(). Prior to 1.10, calling the
+  clutter_actor_destroy() function would unmap the actor first, and then
+  emit the destroy signal. This means that extra care should be used when
+  overriding the map() and unmap() virtual functions, to avoid dereferencing
+  NULL pointers. It is also worthy of note that since Clutter 1.8, overriding
+  map() or unmap() is not required any more for subclasses of ClutterActor
+  that have children, as ClutterActor will automatically do the right thing
+  inside its own implementation, and map or unmap its children when needed.
+
 • ClutterBox and ClutterGroup have been deprecated. ClutterActor should be
-  used directly, instead.
+  used directly, instead. Since ClutterStage inherits from ClutterGroup, the
+  instance and class structures are still available, but subclassing Group
+  is strongly disencouraged.
 
 • ClutterContainer provides default implementations for add(), remove(),
-  and foreach(); this means that overriding these methods is now deprecated,
-  and that developers should only implement ClutterContainer for classes
-  providing child properties.
+  foreach(), raise(), lower(), and sort_depth_order(); this means that
+  overriding these virtual functions is now deprecated, and developers
+  should only implement ClutterContainer for classes providing child
+  properties.
 
 • ClutterActor is not an abstract type any more, and can be instantiated
   either through clutter_actor_new() or through g_object_new().