2007-07-30 Matthew Allum <mallum@openedhand.com>

* AUTHORS:
        * HACKING:
        * README:
        Various updates and improvements.

        * configure.ac:
        Remove --disable-fast-fp-conversions
This commit is contained in:
Matthew Allum 2007-07-30 16:28:53 +00:00
parent 936fea0b37
commit e7c2b250b1
5 changed files with 146 additions and 55 deletions

View File

@ -2,4 +2,5 @@ Matthew Allum <mallum@o-hand.com> - primary authour
Emmanuele Bassi <ebassi@o-hand.com> - python bindings, gobject/glib mastery
Iain Holmes <iain@o-hand.com> - GTK Clutter widget
Jorn Baayen <jorn@o-hand.com> - Gstreamer bits
Tomas Frydrych <tf@o-hand.com> - Fixed point magic
Tomas Frydrych <tf@o-hand.com> - Fixed point + behaviour + maths magic
Neil Patel <neil@o-hand.com> - ClutterEntry, lots of API stress testing.

View File

@ -1,3 +1,13 @@
2007-07-30 Matthew Allum <mallum@openedhand.com>
* AUTHORS:
* HACKING:
* README:
Various updates and improvements.
* configure.ac:
Remove --disable-fast-fp-conversions
2007-07-30 Tomas Frydrych <tf@openedhand.com>
* clutter/clutter-behaviour-ellipse:

38
HACKING
View File

@ -1,9 +1,14 @@
GENERAL
=======
General notes and rules on clutter core hacking;
- GNU style indentation, please wrap at 80 chars.
- All non static public API funcs should be documented in the .c via gtk-doc
- All public functions with float parameters should also provide a fixed
point version.
point version. Fixed point should be used internally.
- Propertys should always be float (never fixed).
@ -13,3 +18,34 @@ General notes and rules on clutter core hacking;
- Dont add direct GL calls but wrap with cogl (also adding GL ES Version)
- Use CLUTTER_NOTE() macro for debug statements.
- New features should also include an exhaustive test in tests/
RELEASES
========
In making a new release;
- Check out a fresh copy from SVN.
- verify versioning in configure.ac, increasing relevant
clutter_major_version/clutter_minor_version/clutter_micro_version
value.
- Update NEWS (New feature details, bug #'s), README (Any API changes
relevant to developers + version), AUTHORS if relevant.
- Add a Release entry to the ChangeLog noting version.
- make distcheck and fix if fails.
- commit.
- Make tarballs, upload.
- Announce release to waiting world on blog and mailing list.
- Release any dependant add-ons following similar rules to above.
Dont forget to check *.pc file version deps!

130
README
View File

@ -25,15 +25,109 @@ New bug page on Bugzilla:
Clutter is LGPL licensed.
INSTALLATION
====
See the INSTALL file
See the INSTALL file. Info on specific Clutter options;
--enable-debug=[no/minimum/yes]
Turn on debugging (default=yes):
yes: All glib asserts, checks and runtime clutter verbose messages.
minimum: Just glib cast checks and runtime clutter verbose messagaes.
no: No glib asserts or checks and no runtime clutter verbose messages
(Only really of use in extreme performance cases)
--enable-maintainer-flags=[no/yes]
Use strict compiler flags (default=no)
--enable-gtk-doc
use gtk-doc to build API documentation (default=no). Requires gtk-doc
present on system
--enable-manual=[no/yes]
Build application developers manual. Requires jw and xmlto binaries.
Presently incomplete.
--without-fpu
Assume target hardware has no floating point unit. Useful only
for embedded targets such as ARM.
--with-flavour=[glx/eglx/eglnative/sdl]
Select the Clutter backend: (defualt=glx)
glx: Fully featured GLX backend. Using Open GL.
eglx: EGL/Open GL ES backend for EGL on X windows implementations
(experimental)
eglnative: EGL/Open GL ES backend on 'native windowing system' - i.e
raw framebuffer. Expects EGL implementation to provide a
createNativeWindow () call. Also optionally supports
tslib for touchscreen events.
(experimental)
sdl: Basic SDL backend, using Open GL. Should provide portability
to windows and possibly other OS's.
VERSIONING
====
Clutter uses the common "Linux kernel" versioning system, where
even-numbered minor versions are stable and odd-numbered minor
versions are development snapshots.
Different Minor versions break both API and ABI but are paralell
installable. The same Minor version with differing Micro version is
expected to be ABI compatible with other micro versions. Though this
is not guarenteed, especially for odd numbered minor releases, we'll
try our very hardest (promise).
HACKING
====
If you want to hack on and improve clutter check the contained TODO
file for pending tasks and HACKING for general coding guidelines.
BUGS
====
Bugs should be reported to the OpenedHand Bugzilla at:
http://bugzilla.o-hand.com/enter_bug.cgi?product=Clutter
You will need an account.
In the report you should include:
* what system you're running Clutter on;
* which version of GLib, GdkPixbuf and OpenGL you are using;
* which video card and which drivers you are using, including output of
glxinfo and xdpyinfo.
* how to reproduce the bug.
If you cannot reproduce the bug with one of the tests that come with Clutter
source code, you should include a small test case displaying the bad
behaviour.
If the bug exposes a crash, the exact text printed out and a stack trace
obtained using gdb are greatly appreciated.
PATCHES
====
Patches should be submitted using Bugzilla. Patches fixing a bug should be
attached to the bug report; patches for new features or for fixing bugs not
yet reported should be attached to a newly opened bug. Patches should always
be in the unified diff format.
RELEASE NOTES
====
Relevant information for developers with existing Clutter applications
wanting to port to newer releases;
wanting to port to newer releases (See NEWS for general new feature info).
Release Notes for Clutter 0.3.1
-------------------------------
@ -109,35 +203,3 @@ Release Notes for Clutter 0.3
ClutterContainer::actor-added and ClutterContainer::actor-removed should
be used instead.
HACKING
====
If you want to hack on and improve clutter check the TODO file.
BUGS
====
Bugs should be reported to the OpenedHand Bugzilla at:
http://bugzilla.o-hand.com/enter_bug.cgi?product=Clutter
You will need an account.
In the report you should include:
* what system you're running Clutter on;
* which version of GLib, GdkPixbuf and OpenGL you are using;
* which video card and which drivers you are using, including output of
glxinfo and xdpyinfo.
* how to reproduce the bug.
If you cannot reproduce the bug with one of the tests that come with Clutter
source code, you should include a small test case displaying the bad
behaviour.
If the bug exposes a crash, the exact text printed out and a stack trace
obtained using gdb are greatly appreciated.
PATCHES
====
Patches should be submitted using Bugzilla. Patches fixing a bug should be
attached to the bug report; patches for new features or for fixing bugs not
yet reported should be attached to a newly opened bug. Patches should always
be in the unified diff format.

View File

@ -299,22 +299,6 @@ fi
AC_SUBST(CLUTTER_DEBUG_CFLAGS)
dnl = Disable fast floating point conversions ==============================
AC_ARG_ENABLE(fast-fp-conversions,
AC_HELP_STRING([--disable-fast-fp-conversions=@<:@no/yes@:>@],
[Turn off fast conversion from floating point to int. no: fast floating point conversion are enabled. yes: fast floating point conversions are disabled. @<:@default=no@:>@]),
,
enable_fast_fp_conversions=yes)
if test "x$enable_fast_fp_conversions" = "xno"; then
FIXED_POINT_CFLAGS="$FIXED_POINT_CFLAGS -DCFX_NO_FAST_CONVERSIONS"
else
FIXED_POINT_CFLAGS="$FIXED_POINT_CFLAGS -UCFX_NO_FAST_CONVERSIONS"
fi
AC_SUBST(FIXED_POINT_CFLAGS)
dnl = Enable strict compiler flags =========================================
# use strict compiler flags only on development releases
@ -360,9 +344,7 @@ dnl ========================================================================
AC_SUBST(GCC_FLAGS)
CLUTTER_CFLAGS="$SDL_CFLAGS $EGL_CFLAGS $GLX_CFLAGS $CLUTTER_DEPS_CFLAGS \
$FIXED_POINT_CFLAGS"
CLUTTER_CFLAGS="$SDL_CFLAGS $EGL_CFLAGS $GLX_CFLAGS $CLUTTER_DEPS_CFLAGS "
CLUTTER_LIBS="$SDL_LIBS $EGL_LIBS $GLX_LIBS $CLUTTER_DEPS_LIBS"
AC_SUBST(CLUTTER_CFLAGS)