Blame README.in

Packit ae235b
General Information
Packit ae235b
===================
Packit ae235b
Packit ae235b
This is GLib version @GLIB_VERSION@. GLib is the low-level core
Packit ae235b
library that forms the basis for projects such as GTK+ and GNOME. It
Packit ae235b
provides data structure handling for C, portability wrappers, and
Packit ae235b
interfaces for such runtime functionality as an event loop, threads,
Packit ae235b
dynamic loading, and an object system.
Packit ae235b
Packit ae235b
The official download locations are:
Packit ae235b
  ftp://ftp.gtk.org/pub/glib
Packit ae235b
  http://download.gnome.org/sources/glib
Packit ae235b
Packit ae235b
The official web site is:
Packit ae235b
  http://www.gtk.org/
Packit ae235b
Packit ae235b
Information about mailing lists can be found at
Packit ae235b
  http://www.gtk.org/mailing-lists.php
Packit ae235b
Packit ae235b
To subscribe, send mail to gtk-list-request@gnome.org
Packit ae235b
with the subject "subscribe".
Packit ae235b
Packit ae235b
Installation
Packit ae235b
============
Packit ae235b
Packit ae235b
See the file 'INSTALL'
Packit ae235b
Packit ae235b
How to report bugs
Packit ae235b
==================
Packit ae235b
Packit ae235b
Bugs should be reported to the GNOME bug tracking system.
Packit ae235b
(http://bugzilla.gnome.org, product glib.) You will need
Packit ae235b
to create an account for yourself.
Packit ae235b
Packit ae235b
In the bug report please include:
Packit ae235b
Packit ae235b
* Information about your system. For instance:
Packit ae235b
Packit ae235b
   - What operating system and version
Packit ae235b
   - For Linux, what version of the C library
Packit ae235b
Packit ae235b
  And anything else you think is relevant.
Packit ae235b
Packit ae235b
* How to reproduce the bug.
Packit ae235b
Packit ae235b
  If you can reproduce it with one of the test programs that are built
Packit ae235b
  in the tests/ subdirectory, that will be most convenient.  Otherwise,
Packit ae235b
  please include a short test program that exhibits the behavior.
Packit ae235b
  As a last resort, you can also provide a pointer to a larger piece
Packit ae235b
  of software that can be downloaded.
Packit ae235b
Packit ae235b
* If the bug was a crash, the exact text that was printed out
Packit ae235b
  when the crash occured.
Packit ae235b
Packit ae235b
* Further information such as stack traces may be useful, but
Packit ae235b
  is not necessary.
Packit ae235b
Packit ae235b
Patches
Packit ae235b
=======
Packit ae235b
Packit ae235b
Patches should also be submitted to bugzilla.gnome.org. If the
Packit ae235b
patch fixes an existing bug, add the patch as an attachment
Packit ae235b
to that bug report.
Packit ae235b
Packit ae235b
Otherwise, enter a new bug report that describes the patch,
Packit ae235b
and attach the patch to that bug report.
Packit ae235b
Packit ae235b
Patches should be in unified diff form. (The -up option to GNU diff.)
Packit ae235b
Packit ae235b
Notes about GLib 2.48
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* The system copy of PCRE is now used by default to implement GRegex.
Packit ae235b
  Configure with --with-pcre=internal if a system PCRE version
Packit ae235b
  is unavailable or undesired.
Packit ae235b
Packit ae235b
Notes about GLib 2.46
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* GTask no longer imposes a fixed limit on the number of tasks that
Packit ae235b
  can be run_in_thread() simultaneously, since doing this inevitably
Packit ae235b
  results in deadlocks in some use cases. Instead, it now has a base
Packit ae235b
  number of threads that can be used "for free", but will gradually
Packit ae235b
  add more threads to the pool if too much time passes without any
Packit ae235b
  tasks completing.
Packit ae235b
Packit ae235b
  The exact behavior may continue to change in the future, and it's
Packit ae235b
  possible that some future version of GLib may not do any
Packit ae235b
  rate-limiting at all. As a result, you should no longer assume that
Packit ae235b
  GTask will rate-limit tasks itself (or, by extension, that calls to
Packit ae235b
  certain async gio methods will automatically be rate-limited for
Packit ae235b
  you). If you have a very large number of tasks to run, and don't
Packit ae235b
  want them to all run at once, you should rate-limit them yourself.
Packit ae235b
Packit ae235b
Notes about GLib 2.40
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* g_test_run() no longer runs tests in exactly the order they are
Packit ae235b
  registered; instead, it groups them according to test suites (ie,
Packit ae235b
  path components) like the documentation always claimed it did. In
Packit ae235b
  some cases, this can result in a sub-optimal ordering of tests,
Packit ae235b
  relative to the old behavior. The fix is to change the test paths to
Packit ae235b
  properly group together the tests that should run together. (eg, if
Packit ae235b
  you want to run test_foo_simple(), test_bar_simple(), and
Packit ae235b
  test_foo_using_bar() in that order, they should have test paths like
Packit ae235b
  "/simple/foo", "/simple/bar", "/complex/foo-using-bar", not
Packit ae235b
  "/foo/simple", "/bar/simple", "/foo/using-bar" (which would result
Packit ae235b
  in test_foo_using_bar() running before test_bar_simple()).
Packit ae235b
Packit ae235b
  (The behavior actually changed in GLib 2.36, but it was not
Packit ae235b
  documented at the time, since we didn't realize it mattered.)
Packit ae235b
Packit ae235b
Notes about GLib 2.36
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* It is no longer necessary to call g_type_init().  If you are
Packit ae235b
  loading GLib as a dynamic module, you should be careful to avoid
Packit ae235b
  unloading it, then subsequently loading it again.  This never
Packit ae235b
  really worked before, but it is now explicitly undefined behavior.
Packit ae235b
  Note that if g_type_init() was the only explicit use of a GObject
Packit ae235b
  API and you are using linker flags such as --no-add-needed, then
Packit ae235b
  you may have to artificially use some GObject call to keep the
Packit ae235b
  linker from optimizing away -lgobject. We recommend to use
Packit ae235b
  g_type_ensure (G_TYPE_OBJECT) for this purpose.
Packit ae235b
Packit ae235b
* This release contains an incompatible change to the g_get_home_dir()
Packit ae235b
  function.  Previously, this function would effectively ignore the HOME
Packit ae235b
  environment variable and always return the value from /etc/password.
Packit ae235b
  As of this version, the HOME variable is used if it is set and the
Packit ae235b
  value from /etc/passwd is only used as a fallback.
Packit ae235b
Packit ae235b
* The 'flowinfo' and 'scope_id' fields of GInetSocketAddress
Packit ae235b
  (introduced in GLib 2.32) have been fixed to be in host byte order
Packit ae235b
  rather than network byte order. This is an incompatible change, but
Packit ae235b
  the previous behavior was clearly broken, so it seems unlikely that
Packit ae235b
  anyone was using it.
Packit ae235b
Packit ae235b
Notes about GLib 2.34
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* GIO now looks for thumbnails in XDG_CACHE_HOME, following a
Packit ae235b
  recent alignment of the thumbnail spec with the basedir spec.
Packit ae235b
Packit ae235b
* The default values for GThreadPools max_unused_threads and
Packit ae235b
  max_idle_time settings have been changed to 2 and 15*1000,
Packit ae235b
  respectively.
Packit ae235b
Packit ae235b
Notes about GLib 2.32
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* It is no longer necessary to use g_thread_init() or to link against
Packit ae235b
  libgthread.  libglib is now always thread-enabled. Custom thread
Packit ae235b
  system implementations are no longer supported (including errorcheck
Packit ae235b
  mutexes).
Packit ae235b
Packit ae235b
* The thread and synchronisation APIs have been updated.
Packit ae235b
  GMutex and GCond can be statically allocated without explicit
Packit ae235b
  initialisation, as can new types GRWLock and GRecMutex.  The
Packit ae235b
  GStatic_______ variants of these types have been deprecated.  GPrivate
Packit ae235b
  can also be statically allocated and has a nicer API (deprecating
Packit ae235b
  GStaticPrivate).  Finally, g_thread_create() has been replaced with a
Packit ae235b
  substantially simplified g_thread_new().
Packit ae235b
Packit ae235b
* The g_once_init_enter()/_leave() functions have been replaced with
Packit ae235b
  macros that allow for a pointer to any gsize-sized object, not just a
Packit ae235b
  gsize*.  The assertions to ensure that a pointer to a correctly-sized
Packit ae235b
  object is being used will not work with generic pointers (ie: (void*)
Packit ae235b
  and (gpointer) casts) which would have worked with the old version.
Packit ae235b
Packit ae235b
* It is now mandatory to include glib.h instead of individual headers.
Packit ae235b
Packit ae235b
* The -uninstalled variants of the pkg-config files have been dropped.
Packit ae235b
Packit ae235b
* For a long time, gobject-2.0.pc mistakenly declared a public
Packit ae235b
  dependency on gthread-2.0.pc (when the dependency should have been
Packit ae235b
  private).  This means that programs got away with calling
Packit ae235b
  g_thread_init() without explicitly listing gthread-2.0.pc among their
Packit ae235b
  dependencies.
Packit ae235b
Packit ae235b
  gthread has now been removed as a gobject dependency, which will cause
Packit ae235b
  such programs to break.
Packit ae235b
Packit ae235b
  The fix for this problem is either to declare an explicit dependency
Packit ae235b
  on gthread-2.0.pc (if you care about compatibility with older GLib
Packit ae235b
  versions) or to stop calling g_thread_init().
Packit ae235b
Packit ae235b
* g_debug() output is no longer enabled by default.  It can be enabled
Packit ae235b
  on a per-domain basis with the G_MESSAGES_DEBUG environment variable
Packit ae235b
  like
Packit ae235b
    G_MESSAGES_DEBUG=domain1,domain2
Packit ae235b
  or
Packit ae235b
    G_MESSAGES_DEBUG=all
Packit ae235b
Packit ae235b
Notes about GLib 2.30
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* GObject includes a generic marshaller, g_cclosure_marshal_generic.
Packit ae235b
  To use it, simply specify NULL as the marshaller in g_signal_new().
Packit ae235b
  The generic marshaller is implemented with libffi, and consequently
Packit ae235b
  GObject depends on libffi now.
Packit ae235b
Packit ae235b
Notes about GLib 2.28
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* The GApplication API has changed compared to the version that was
Packit ae235b
  included in the 2.25 development snapshots. Existing users will need
Packit ae235b
  adjustments.
Packit ae235b
Packit ae235b
Notes about GLib 2.26
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* Nothing noteworthy.
Packit ae235b
Packit ae235b
Notes about GLib 2.24
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* It is now allowed to call g_thread_init(NULL) multiple times, and
Packit ae235b
  to call glib functions before g_thread_init(NULL) is called
Packit ae235b
  (although the later is mainly a change in docs as this worked before
Packit ae235b
  too). See the GThread reference documentation for the details.
Packit ae235b
Packit ae235b
* GObject now links to GThread and threads are enabled automatically
Packit ae235b
  when g_type_init() is called.
Packit ae235b
Packit ae235b
* GObject no longer allows to call g_object_set() on construct-only properties
Packit ae235b
  while an object is being initialized. If this behavior is needed, setting a
Packit ae235b
  custom constructor that just chains up will re-enable this functionality.
Packit ae235b
Packit ae235b
* GMappedFile on an empty file now returns NULL for the contents instead of
Packit ae235b
  returning an empty string. The documentation specifically states that code
Packit ae235b
  may not rely on nul-termination here so any breakage caused by this change
Packit ae235b
  is a bug in application code.
Packit ae235b
Packit ae235b
Notes about GLib 2.22
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* Repeated calls to g_simple_async_result_set_op_res_gpointer used
Packit ae235b
  to leak the data. This has been fixed to always call the provided
Packit ae235b
  destroy notify.
Packit ae235b
Packit ae235b
Notes about GLib 2.20
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* The functions for launching applications (e.g. g_app_info_launch() +
Packit ae235b
  friends) now passes a FUSE file:// URI if possible (requires gvfs
Packit ae235b
  with the FUSE daemon to be running and operational). With gvfs 2.26,
Packit ae235b
  FUSE file:// URIs will be mapped back to gio URIs in the GFile
Packit ae235b
  constructors. The intent of this change is to better integrate
Packit ae235b
  POSIX-only applications, see bug #528670 for the rationale.  The
Packit ae235b
  only user-visible change is when an application needs to examine an
Packit ae235b
  URI passed to it (e.g. as a positional parameter). Instead of
Packit ae235b
  looking at the given URI, the application will now need to look at
Packit ae235b
  the result of g_file_get_uri() after having constructed a GFile
Packit ae235b
  object with the given URI.
Packit ae235b
Packit ae235b
Notes about GLib 2.18
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* The recommended way of using GLib has always been to only include the
Packit ae235b
  toplevel headers glib.h, glib-object.h and gio.h. GLib enforces this by
Packit ae235b
  generating an error when individual headers are directly included.
Packit ae235b
  To help with the transition, the enforcement is not turned on by
Packit ae235b
  default for GLib headers (it is turned on for GObject and GIO).
Packit ae235b
  To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES.
Packit ae235b
Packit ae235b
Notes about GLib 2.16
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* GLib now includes GIO, which adds optional dependencies against libattr
Packit ae235b
  and libselinux for extended attribute and SELinux support. Use
Packit ae235b
  --disable-xattr and --disable-selinux to build without these.
Packit ae235b
Packit ae235b
Notes about GLib 2.10
Packit ae235b
=====================
Packit ae235b
Packit ae235b
* The functions g_snprintf() and g_vsnprintf() have been removed from
Packit ae235b
  the gprintf.h header, since they are already declared in glib.h. This
Packit ae235b
  doesn't break documented use of gprintf.h, but people have been known
Packit ae235b
  to include gprintf.h without including glib.h.
Packit ae235b
Packit ae235b
* The Unicode support has been updated to Unicode 4.1. This adds several
Packit ae235b
  new members to the GUnicodeBreakType enumeration.
Packit ae235b
Packit ae235b
* The support for Solaris threads has been retired. Solaris has provided
Packit ae235b
  POSIX threads for long enough now to have them available on every
Packit ae235b
  Solaris platform.
Packit ae235b
Packit ae235b
* 'make check' has been changed to validate translations by calling
Packit ae235b
  msgfmt with the -c option. As a result, it may fail on systems with
Packit ae235b
  older gettext implementations (GNU gettext < 0.14.1, or Solaris gettext).
Packit ae235b
  'make check' will also fail on systems where the C compiler does not
Packit ae235b
  support ELF visibility attributes.
Packit ae235b
Packit ae235b
* The GMemChunk API has been deprecated in favour of a new 'slice
Packit ae235b
  allocator'. See the g_slice documentation for more details.
Packit ae235b
Packit ae235b
* A new type, GInitiallyUnowned, has been introduced, which is
Packit ae235b
  intended to serve as a common implementation of the 'floating reference'
Packit ae235b
  concept that is e.g. used by GtkObject. Note that changing the
Packit ae235b
  inheritance hierarchy of a type can cause problems for language
Packit ae235b
  bindings and other code which needs to work closely with the type
Packit ae235b
  system. Therefore, switching to GInitiallyUnowned should be done
Packit ae235b
  carefully. g_object_compat_control() has been added to GLib 2.8.5
Packit ae235b
  to help with the transition.
Packit ae235b
Packit ae235b
Notes about GLib 2.6.0
Packit ae235b
======================
Packit ae235b
Packit ae235b
* GLib 2.6 introduces the concept of 'GLib filename encoding', which is the
Packit ae235b
  on-disk encoding on Unix, but UTF-8 on Windows. All GLib functions
Packit ae235b
  returning or accepting pathnames have been changed to expect
Packit ae235b
  filenames in this encoding, and the common POSIX functions dealing
Packit ae235b
  with pathnames have been wrapped. These wrappers are declared in the
Packit ae235b
  header <glib/gstdio.h> which must be included explicitly; it is not
Packit ae235b
  included through <glib.h>.
Packit ae235b
Packit ae235b
  On current (NT-based) Windows versions, where the on-disk file names
Packit ae235b
  are Unicode, these wrappers use the wide-character API in the C
Packit ae235b
  library. Thus applications can handle file names containing any
Packit ae235b
  Unicode characters through GLib's own API and its POSIX wrappers,
Packit ae235b
  not just file names restricted to characters in the system codepage.
Packit ae235b
Packit ae235b
  To keep binary compatibility with applications compiled against
Packit ae235b
  older versions of GLib, the Windows DLL still provides entry points
Packit ae235b
  with the old semantics using the old names, and applications
Packit ae235b
  compiled against GLib 2.6 will actually use new names for the
Packit ae235b
  functions. This is transparent to the programmer.
Packit ae235b
Packit ae235b
  When compiling against GLib 2.6, applications intended to be
Packit ae235b
  portable to Windows must take the UTF-8 file name encoding into
Packit ae235b
  consideration, and use the gstdio wrappers to access files whose
Packit ae235b
  names have been constructed from strings returned from GLib.
Packit ae235b
Packit ae235b
* Likewise, g_get_user_name() and g_get_real_name() have been changed
Packit ae235b
  to return UTF-8 on Windows, while keeping the old semantics for
Packit ae235b
  applications compiled against older versions of GLib.
Packit ae235b
Packit ae235b
* The GLib uses an '_' prefix to indicate private symbols that
Packit ae235b
  must not be used by applications. On some platforms, symbols beginning
Packit ae235b
  with prefixes such as _g will be exported from the library, on others not.
Packit ae235b
  In no case can applications use these private symbols. In addition to that,
Packit ae235b
  GLib+ 2.6 makes several symbols private which were not in any installed
Packit ae235b
  header files and were never intended to be exported.
Packit ae235b
Packit ae235b
* To reduce code size and improve efficiency, GLib, when compiled
Packit ae235b
  with the GNU toolchain, has separate internal and external entry
Packit ae235b
  points for exported functions. The internal names, which begin with
Packit ae235b
  IA__, may be seen when debugging a GLib program.
Packit ae235b
Packit ae235b
* On Windows, GLib no longer opens a console window when printing
Packit ae235b
  warning messages if stdout or stderr are invalid, as they are in
Packit ae235b
  "Windows subsystem" (GUI) applications. Simply redirect stdout or
Packit ae235b
  stderr if you need to see them.
Packit ae235b
Packit ae235b
* The child watch functionality tends to reveal a bug in many
Packit ae235b
  thread implementations (in particular the older LinuxThreads
Packit ae235b
  implementation on Linux) where it's not possible to call waitpid()
Packit ae235b
  for a child created in a different thread. For this reason, for
Packit ae235b
  maximum portability, you should structure your code to fork all
Packit ae235b
  child processes that you want to wait for from the main thread.
Packit ae235b
Packit ae235b
* A problem was recently discovered with g_signal_connect_object();
Packit ae235b
  it doesn't actually disconnect the signal handler once the object being
Packit ae235b
  connected to dies, just disables it. See the API docs for the function
Packit ae235b
  for further details and the correct workaround that will continue to
Packit ae235b
  work with future versions of GLib.