Update README files to refer to git

Update various README files to refer to git instead of svn.
Add a README.commits that is pretty much a copy of the same file
in GTK+. Also discontinue ChangeLog files.
This commit is contained in:
Matthias Clasen 2009-03-31 19:39:16 -04:00
parent b5ef6da3c3
commit 785bed2e18
11 changed files with 157 additions and 42 deletions

View File

@ -1,3 +1,9 @@
=== ChangeLog discontinued ===
With the move to git, GLib is switching from a ChangeLog file
to relying on commit messages to provide change history. Please
see README.commits for guidance on the expected message format.
2009-03-29 Matthias Clasen <mclasen@redhat.com> 2009-03-29 Matthias Clasen <mclasen@redhat.com>
Bug 577137 g_logv() will crash if given format args and multiple Bug 577137 g_logv() will crash if given format args and multiple

View File

@ -3,7 +3,7 @@ following packages installed:
- GNU autoconf 2.54 - GNU autoconf 2.54
- GNU automake 1.7 - GNU automake 1.7
- GNU libtool 1.4 - GNU libtool 1.4
- GNU gettext 0.10.40 - GNU gettext 0.10.40
- gtk-doc - gtk-doc
@ -15,7 +15,7 @@ several steps to setup the tree for compilation. You can do all these
steps at once by running: steps at once by running:
cvsroot/glib# ./autogen.sh cvsroot/glib# ./autogen.sh
Basically this does the following for you: Basically this does the following for you:
cvsroot/glib# aclocal; automake; autoconf cvsroot/glib# aclocal; automake; autoconf
@ -24,8 +24,8 @@ Basically this does the following for you:
can run the configure script in cvsroot/glib to create all can run the configure script in cvsroot/glib to create all
the Makefiles. the Makefiles.
Before running autogen.sh or configure, make sure you have libtool Before running autogen.sh or configure, make sure you have libtool
in your path. in your path.
Note that autogen.sh runs configure for you. If you wish to pass Note that autogen.sh runs configure for you. If you wish to pass
options like --prefix=/usr to configure you can give those options options like --prefix=/usr to configure you can give those options

View File

@ -28,6 +28,7 @@ EXTRA_DIST += \
NEWS.pre-1-3 \ NEWS.pre-1-3 \
acglib.m4 \ acglib.m4 \
sanity_check \ sanity_check \
README.commits \
README.in \ README.in \
INSTALL.in \ INSTALL.in \
README.win32 \ README.win32 \

76
README
View File

@ -27,7 +27,7 @@ See the file 'INSTALL'
Notes about GLib 2.20 Notes about GLib 2.20
===================== =====================
^ The functions for launching applications (e.g. g_app_info_launch() + * The functions for launching applications (e.g. g_app_info_launch() +
friends) now passes a FUSE file:// URI if possible (requires gvfs friends) now passes a FUSE file:// URI if possible (requires gvfs
with the FUSE daemon to be running and operational). With gvfs 2.26, with the FUSE daemon to be running and operational). With gvfs 2.26,
FUSE file:// URIs will be mapped back to gio URIs in the GFile FUSE file:// URIs will be mapped back to gio URIs in the GFile
@ -43,17 +43,17 @@ Notes about GLib 2.18
===================== =====================
* The recommended way of using GLib has always been to only include the * The recommended way of using GLib has always been to only include the
toplevel headers glib.h, glib-object.h and gio.h. GLib enforces this by toplevel headers glib.h, glib-object.h and gio.h. GLib enforces this by
generating an error when individual headers are directly included. generating an error when individual headers are directly included.
To help with the transition, the enforcement is not turned on by To help with the transition, the enforcement is not turned on by
default for GLib headers (it is turned on for GObject and GIO). default for GLib headers (it is turned on for GObject and GIO).
To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES. To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES.
Notes about GLib 2.16 Notes about GLib 2.16
===================== =====================
* GLib now includes GIO, which adds optional dependencies against libattr * GLib now includes GIO, which adds optional dependencies against libattr
and libselinux for extended attribute and SELinux support. Use and libselinux for extended attribute and SELinux support. Use
--disable-xattr and --disable-selinux to build without these. --disable-xattr and --disable-selinux to build without these.
Notes about GLib 2.10 Notes about GLib 2.10
@ -67,18 +67,18 @@ Notes about GLib 2.10
* The Unicode support has been updated to Unicode 4.1. This adds several * The Unicode support has been updated to Unicode 4.1. This adds several
new members to the GUnicodeBreakType enumeration. new members to the GUnicodeBreakType enumeration.
* The support for Solaris threads has been retired. Solaris has provided * The support for Solaris threads has been retired. Solaris has provided
POSIX threads for long enough now to have them available on every POSIX threads for long enough now to have them available on every
Solaris platform. Solaris platform.
* 'make check' has been changed to validate translations by calling * 'make check' has been changed to validate translations by calling
msgfmt with the -c option. As a result, it may fail on systems with msgfmt with the -c option. As a result, it may fail on systems with
older gettext implementations (GNU gettext < 0.14.1, or Solaris gettext). older gettext implementations (GNU gettext < 0.14.1, or Solaris gettext).
'make check' will also fail on systems where the C compiler does not 'make check' will also fail on systems where the C compiler does not
support ELF visibility attributes. support ELF visibility attributes.
* The GMemChunk API has been deprecated in favour of a new 'slice * The GMemChunk API has been deprecated in favour of a new 'slice
allocator'. See the g_slice documentation for more details. allocator'. See the g_slice documentation for more details.
* A new type, GInitiallyUnowned, has been introduced, which is * A new type, GInitiallyUnowned, has been introduced, which is
intended to serve as a common implementation of the 'floating reference' intended to serve as a common implementation of the 'floating reference'
@ -117,20 +117,20 @@ Notes about GLib 2.6.0
consideration, and use the gstdio wrappers to access files whose consideration, and use the gstdio wrappers to access files whose
names have been constructed from strings returned from GLib. names have been constructed from strings returned from GLib.
* Likewise, g_get_user_name() and g_get_real_name() have been changed * Likewise, g_get_user_name() and g_get_real_name() have been changed
to return UTF-8 on Windows, while keeping the old semantics for to return UTF-8 on Windows, while keeping the old semantics for
applications compiled against older versions of GLib. applications compiled against older versions of GLib.
* The GLib uses an '_' prefix to indicate private symbols that * The GLib uses an '_' prefix to indicate private symbols that
must not be used by applications. On some platforms, symbols beginning must not be used by applications. On some platforms, symbols beginning
with prefixes such as _g will be exported from the library, on others not. with prefixes such as _g will be exported from the library, on others not.
In no case can applications use these private symbols. In addition to that, In no case can applications use these private symbols. In addition to that,
GLib+ 2.6 makes several symbols private which were not in any installed GLib+ 2.6 makes several symbols private which were not in any installed
header files and were never intended to be exported. header files and were never intended to be exported.
* To reduce code size and improve efficiency, GLib, when compiled * To reduce code size and improve efficiency, GLib, when compiled
with the GNU toolchain, has separate internal and external entry with the GNU toolchain, has separate internal and external entry
points for exported functions. The internal names, which begin with points for exported functions. The internal names, which begin with
IA__, may be seen when debugging a GLib program. IA__, may be seen when debugging a GLib program.
* On Windows, GLib no longer opens a console window when printing * On Windows, GLib no longer opens a console window when printing
@ -139,22 +139,22 @@ Notes about GLib 2.6.0
stderr if you need to see them. stderr if you need to see them.
* The child watch functionality tends to reveal a bug in many * The child watch functionality tends to reveal a bug in many
thread implementations (in particular the older LinuxThreads thread implementations (in particular the older LinuxThreads
implementation on Linux) where it's not possible to call waitpid() implementation on Linux) where it's not possible to call waitpid()
for a child created in a different thread. For this reason, for for a child created in a different thread. For this reason, for
maximum portability, you should structure your code to fork all maximum portability, you should structure your code to fork all
child processes that you want to wait for from the main thread. child processes that you want to wait for from the main thread.
* A problem was recently discovered with g_signal_connect_object(); * A problem was recently discovered with g_signal_connect_object();
it doesn't actually disconnect the signal handler once the object being it doesn't actually disconnect the signal handler once the object being
connected to dies, just disables it. See the API docs for the function connected to dies, just disables it. See the API docs for the function
for further details and the correct workaround that will continue to for further details and the correct workaround that will continue to
work with future versions of GLib. work with future versions of GLib.
How to report bugs How to report bugs
================== ==================
Bugs should be reported to the GNOME bug tracking system. Bugs should be reported to the GNOME bug tracking system.
(http://bugzilla.gnome.org, product glib.) You will need (http://bugzilla.gnome.org, product glib.) You will need
to create an account for yourself. to create an account for yourself.
@ -167,12 +167,12 @@ In the bug report please include:
And anything else you think is relevant. And anything else you think is relevant.
* How to reproduce the bug. * How to reproduce the bug.
If you can reproduce it with one of the test programs that are built If you can reproduce it with one of the test programs that are built
in the tests/ subdirectory, that will be most convenient. Otherwise, in the tests/ subdirectory, that will be most convenient. Otherwise,
please include a short test program that exhibits the behavior. please include a short test program that exhibits the behavior.
As a last resort, you can also provide a pointer to a larger piece As a last resort, you can also provide a pointer to a larger piece
of software that can be downloaded. of software that can be downloaded.
* If the bug was a crash, the exact text that was printed out * If the bug was a crash, the exact text that was printed out
@ -192,7 +192,7 @@ Otherwise, enter a new bug report that describes the patch,
and attach the patch to that bug report. and attach the patch to that bug report.
Bug reports containing patches should include the PATCH keyword Bug reports containing patches should include the PATCH keyword
in their keyword fields. If the patch adds to or changes the GLib in their keyword fields. If the patch adds to or changes the GLib
programming interface, the API keyword should also be included. programming interface, the API keyword should also be included.
Patches should be in unified diff form. (The -u option to GNU Patches should be in unified diff form. (The -u option to GNU

72
README.commits Normal file
View File

@ -0,0 +1,72 @@
GLib is part of the GNOME git repository. At the current time, any
person with write access to the GNOME repository, can make changes to
GLib. This is a good thing, in that it encourages many people to work
on GLib, and progress can be made quickly. However, GLib is a fairly
large and complicated package that many other things depend on, so to
avoid unnecessary breakage, and to take advantage of the knowledge
about GLib that has been built up over the years, we'd like to ask
people committing to GLib to follow a few rules:
0) Ask first. If your changes are major, or could possibly break existing
code, you should always ask. If your change is minor and you've
been working on GLib for a while it probably isn't necessary
to ask. But when in doubt, ask. Even if your change is correct,
somebody may know a better way to do things.
If you are making changes to GLib, you should be subscribed
to gtk-devel-list@gnome.org. (Subscription address:
gtk-devel-list-request@gnome.org.) This is a good place to ask
about intended changes.
#gtk+ on GIMPNet (irc.gimp.org, irc.us.gimp.org, irc.eu.gimp.org, ...)
is also a good place to find GTK+ developers to discuss changes with,
however, email to gtk-devel-list is the most certain and preferred
method.
1) Ask _first_.
2) With git, we no longer maintain a ChangeLog file, but you are expected
to produce a meaningful commit message. Changes without a sufficient
commit message will be reverted. See below for the expected format
of commit messages.
Notes:
* When developing larger features or complicated bug fixes, it is
advisable to work in a branch in your own cloned GLib repository.
You may even consider making your repository publically available
so that others can easily test and review your changes.
* The expected format for git commit messages is as follows:
=== begin example commit ===
Short explanation of the commit
Longer explanation explaining exactly what's changed, whether any
external or private interfaces changed, what bugs were fixed (with bug
tracker reference if applicable) and so forth. Be concise but not too brief.
=== end example commit ===
- Always add a brief description of the commit to the _first_ line of
the commit and terminate by two newlines (it will work without the
second newline, but that is not nice for the interfaces).
- First line (the brief description) must only be one sentence and
should start with a capital letter unless it starts with a lowercase
symbol or identifier. Don't use a trailing period either. Don't exceed
72 characters.
- The main description (the body) is normal prose and should use normal
punctuation and capital letters where appropriate. Normally, for patches
sent to a mailing list it's copied from there.
- When committing code on behalf of others use the --author option, e.g.
git commit -a --author "Joe Coder <joe@coder.org>" and --signoff.
Owen Taylor
13 Aug 1998
17 Apr 2001
Matthias Clasen
31 Mar 2009

View File

@ -1,3 +1,9 @@
=== ChangeLog discontinued ===
With the move to git, GLib is switching from a ChangeLog file
to relying on commit messages to provide change history. Please
see README.commits for guidance on the expected message format.
2009-03-13 Matthias Clasen <mclasen@redhat.com> 2009-03-13 Matthias Clasen <mclasen@redhat.com>
* === Released 2.20.0 === * === Released 2.20.0 ===

View File

@ -1,3 +1,9 @@
=== ChangeLog discontinued ===
With the move to git, GLib is switching from a ChangeLog file
to relying on commit messages to provide change history. Please
see README.commits for guidance on the expected message format.
2009-03-26 Carlos Garnacho <carlosg@gnome.org> 2009-03-26 Carlos Garnacho <carlosg@gnome.org>
Bug 575270 GVolumeMonitor::mount-pre-unmount not being emitted Bug 575270 GVolumeMonitor::mount-pre-unmount not being emitted

View File

@ -1,3 +1,9 @@
=== ChangeLog discontinued ===
With the move to git, GLib is switching from a ChangeLog file
to relying on commit messages to provide change history. Please
see README.commits for guidance on the expected message format.
2009-03-13 Matthias Clasen <mclasen@redhat.com> 2009-03-13 Matthias Clasen <mclasen@redhat.com>
* === Released 2.20.0 === * === Released 2.20.0 ===

View File

@ -1,3 +1,9 @@
=== ChangeLog discontinued ===
With the move to git, GLib is switching from a ChangeLog file
to relying on commit messages to provide change history. Please
see README.commits for guidance on the expected message format.
2009-03-13 Kristian Rietveld <kris@imendio.com> 2009-03-13 Kristian Rietveld <kris@imendio.com>
* gsignal.c (signal_lookup_closure): when defaulting to the only * gsignal.c (signal_lookup_closure): when defaulting to the only

View File

@ -1,3 +1,9 @@
=== ChangeLog discontinued ===
With the move to git, GLib is switching from a ChangeLog file
to relying on commit messages to provide change history. Please
see README.commits for guidance on the expected message format.
2009-03-13 Matthias Clasen <mclasen@redhat.com> 2009-03-13 Matthias Clasen <mclasen@redhat.com>
* === Released 2.20.0 === * === Released 2.20.0 ===

View File

@ -1,3 +1,9 @@
=== ChangeLog discontinued ===
With the move to git, GLib is switching from a ChangeLog file
to relying on commit messages to provide change history. Please
see README.commits for guidance on the expected message format.
2009-03-30 Manoj Kumar Giri <mgiri@redhat.com> 2009-03-30 Manoj Kumar Giri <mgiri@redhat.com>
* or.po: Updated Oriya Translation. * or.po: Updated Oriya Translation.