]> Pileus Git - ~andy/gtk/commitdiff
Update README files to refer to git
authorMatthias Clasen <mclasen@redhat.com>
Tue, 31 Mar 2009 22:49:48 +0000 (18:49 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 31 Mar 2009 22:49:48 +0000 (18:49 -0400)
Update various README files to refer to git instead of svn.
Also discontinue ChangeLog files.

ChangeLog
HACKING
README
README.commits
contrib/gdk-pixbuf-xlib/ChangeLog
docs/reference/ChangeLog
gdk-pixbuf/ChangeLog
modules/engines/pixbuf/ChangeLog
modules/other/gail/ChangeLog
po-properties/ChangeLog
po/ChangeLog

index 898a5696f8ee13fad1084ae182e797b0412985a9..2d6465afeca43044a6a07440d68adaac22e40249 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, GTK+ 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  Christian Persch  <chpe@gnome.org>
 
        Bug 577224 – crash when setting new icon after setting icon in
diff --git a/HACKING b/HACKING
index 4a3ea44d36c5d8b4b8f4c95962a00dfabac6d1e2..54c2baea8bcd9655aeead7a1d3b9d2b8658e7460 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -15,45 +15,45 @@ can be found here:
 
         http://developer.gnome.org
 
-including information about using Subversion with GNOME:
+Information about using git with GNOME can be found here:
 
-        http://developer.gnome.org/tools/svn.html
+        http://live.gnome.org/GitMigration
 
-In order to get SVN gtk+ installed on your system, you need to have
-the most recent SVN versions of glib, pango, and atk installed as well.
+In order to get GIT gtk+ installed on your system, you need to have
+the most recent GIT versions of glib, pango, and atk installed as well.
 The installation process of these libraries is similar to that of gtk+, but
 needs to be fulfilled prior to installation of gtk+.
 
-If at all possible, please use SVN to get the latest development version of
-gtk+ and glib.  You can do the following to get glib and gtk+ from SVN:
+If at all possible, please use GIT to get the latest development version of
+gtk+ and glib. You can do the following to get glib and gtk+ from GIT:
 
-        $ svn checkout http://svn.gnome.org/svn/glib/trunk glib
-        $ svn checkout http://svn.gnome.org/svn/pango/trunk pango
-        $ svn checkout http://svn.gnome.org/svn/atk/trunk atk
-        $ svn checkout http://svn.gnome.org/svn/gtk+/trunk gtk+
+        $ git clone git://git.gnome.org/glib
+        $ git clone git://git.gnome.org/pango
+        $ git clone git://git.gnome.org/atk
+        $ git clone git://git.gnome.org/gtk+
 
-To compile the SVN version of gtk+ on your system, you will need to take
+To compile the GIT version of gtk+ on your system, you will need to take
 several steps to setup the tree for compilation.  You can do all these
 steps at once by running:
 
         gtk+$ ./autogen.sh
-   
+
 Basically this does the following for you:
 
         gtk+$ aclocal; automake; autoconf
 
 The above commands create the `configure' script.  Now you
-run the `configure' script in `gtk+/' to create all Makefiles.  
+run the `configure' script in `gtk+/' to create all Makefiles.
 More information about that in `INSTALL'.
 
-Before running `autogen.sh' or `configure', make sure you have libtool 
-in your path.  
+Before running `autogen.sh' or `configure', make sure you have libtool
+in your path.
 
 Note that autogen.sh runs configure for you.  If you wish to pass
 options like `--prefix=/usr' to `configure' you can give those options
 to `autogen.sh' and they will be passed on to `configure'.
 
-For information about submitting patches and committing changes
-to SVN, see the `README' and `README.commits' files. In particular, 
-don't, under any circumstances, commit anything to SVN before
+For information about submitting patches and pushing changes
+to GIT, see the `README' and `README.commits' files. In particular,
+don't, under any circumstances, push anything to GIT before
 reading and understanding `README.commmits'.
diff --git a/README b/README
index cd795d8084c1f9ec7fc930d8894714933b5b6fc9..260361a02b8a58c6a43a207d7716398feca8fae9 100644 (file)
--- a/README
+++ b/README
@@ -52,7 +52,7 @@ Release notes for 2.14
   range [lower, upper - page_size]. This has always been the documented
   behaviour, and the recommended practice is to set page_size to 0
   when using adjustments for simple scalar values, like in a slider
-  or spin button. 
+  or spin button.
 
 * gdk-pixbuf will use GIO for mime type detection if possible. For
   this to work, shared-mime-info needs to be installed and XDG_DATA_DIRS
@@ -97,38 +97,38 @@ Release notes for 2.12
 * The gtk_notebook_set/get_group_id() functions were found to be insufficient
   and have been deprecated in favour of gtk_notebook_set/get_group().
 
-* The move-focus signal has been moved to GtkWidget, to unify the 
-  various implementations of this signal in specific widgets. Great care 
+* The move-focus signal has been moved to GtkWidget, to unify the
+  various implementations of this signal in specific widgets. Great care
   has been taken to make sure that all code using this signal continues
   to work.
 
-* An unused and hardly visible GtkFrame has been removed from the menu 
-  widget hierarchy when GtkComboBox::appears-as-list style property is 
-  set. Any RC file applying a different style to any widget below the 
-  widget path "gtk-combobox-popup-window.GtkFrame" should take into 
+* An unused and hardly visible GtkFrame has been removed from the menu
+  widget hierarchy when GtkComboBox::appears-as-list style property is
+  set. Any RC file applying a different style to any widget below the
+  widget path "gtk-combobox-popup-window.GtkFrame" should take into
   account that the frame no longer exists.
 
-* The external print preview application used by GtkPrintOperationPreview 
-  is now passed the print settings on the command line with the 
-  --print-settings parameter pointing to a temp file containing the 
-  settings. The preview application assumes ownership of the file and 
-  should delete it once it does not need it anymore. The --print-settings 
-  commandline option is understood by Evince 0.9.0 and newer. To use a 
-  different print preview application, change the gtk-print-preview-command 
+* The external print preview application used by GtkPrintOperationPreview
+  is now passed the print settings on the command line with the
+  --print-settings parameter pointing to a temp file containing the
+  settings. The preview application assumes ownership of the file and
+  should delete it once it does not need it anymore. The --print-settings
+  commandline option is understood by Evince 0.9.0 and newer. To use a
+  different print preview application, change the gtk-print-preview-command
   setting in your gtkrc file, e.g. gtk-print-preview-command = "ggv %f"
 
-* GtkMenuShell is now defined as an abstract type. It was already 
-  documented as an abstract class, and there is little reason to 
+* GtkMenuShell is now defined as an abstract type. It was already
+  documented as an abstract class, and there is little reason to
   instantiate it.
 
 * The GtkTooltips struct (this is the old tooltips API) is now considered
   private. Code that used to access this struct, in particular the
   tips_data_list field, will need to change. All of the old tooltips
   API has been deprecated in favour of a new implementation and
-  API. This affects all of the gtk_tooltips_ functions, and functions 
+  API. This affects all of the gtk_tooltips_ functions, and functions
   which take a GtkTooltips argument, such as gtk_tool_item_set_tooltip()
   and gtk_menu_tool_button_set_arrow_tooltip().
-  
+
 * The memory management of the GtkRecentManager object has been changed,
   as using the screen didn't guarantee that the singleton instance was
   correctly destroyed. The screen-related functions have been deprecated,
@@ -136,14 +136,14 @@ Release notes for 2.12
   the gtk_recent_manager_get_default() function is guaranteed to be valid
   for the entire lifetime of an application.
 
-* A number of interfaces that have been superseded by newer interfaces for 
-  a long time have finally been deprecated. This includes 
+* A number of interfaces that have been superseded by newer interfaces for
+  a long time have finally been deprecated. This includes
   gtk_widget_ref/unref(), gtk_rc_style_ref/unref() and the old file selector.
 
 * The various coordinate systems in use in GtkTreeView widgets have
-  been clarified in the documentation, and in the cause of doing so, 
+  been clarified in the documentation, and in the cause of doing so,
   the functions gtk_tree_view_widget_to_tree_coords() and
-  gtk_tree_view_tree_to_widget_coords() have been deprecated in 
+  gtk_tree_view_tree_to_widget_coords() have been deprecated in
   favour of a new family of gtk_tree_view_convert_ functions.
 
 * gtk_menu_item_remove_submenu() has been deprecated in favour of
@@ -187,14 +187,14 @@ Release notes for 2.10
   gtk_range_set_[upper/lower]_stepper_sensitivity() functions to
   prevent the arrows from being rendered insensitive.
 
-* GtkObject now uses the "floating reference" support in GObject. 
+* GtkObject now uses the "floating reference" support in GObject.
   GTK_OBJECT_IS_FLOATING() will still work, but direct checking
-  of the GTK_FLOATING flag will no longer detect the floating 
+  of the GTK_FLOATING flag will no longer detect the floating
   reference. Details about floating references can be found in the docs:
   http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#floating-ref
 
-* Accelerators like (_F) are now stripped from labels when they are 
-  displayed in toolbars. If this is not wanted, the feature can be 
+* Accelerators like (_F) are now stripped from labels when they are
+  displayed in toolbars. If this is not wanted, the feature can be
   suppressed by inserting a Unicode control character, e.g ZWNJ.
 
 * The pixbuf theme engine can now customize expanders (in GtkTreeView
@@ -207,14 +207,14 @@ Release notes for 2.10
 
 * Several new signals have been added to GtkNotebook. Care has been taken
   to choose signal names which do not collide with signals added by well-known
-  derived classes. The names which can no longer be used for signals in 
+  derived classes. The names which can no longer be used for signals in
   objects derived from GtkNotebook are page-reordered, page-removed and
   page-added.
 
-* Due to the interface changes in the file chooser backend interface, 
-  the GTK+ ABI version has been bumped to 2.10.0. Third-party filesystem 
-  backends have to be ported to the new interface, other modules, such as 
-  theme engines, input method modules or pixbuf loaders have to be rebuilt 
+* Due to the interface changes in the file chooser backend interface,
+  the GTK+ ABI version has been bumped to 2.10.0. Third-party filesystem
+  backends have to be ported to the new interface, other modules, such as
+  theme engines, input method modules or pixbuf loaders have to be rebuilt
   so that they are installed in the right place for GTK+ to find them.
 
 
@@ -273,19 +273,19 @@ Release notes for 2.6
   a clipboard manager following the specification at
   http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
   must be running. A sample implementation of such a clipboard manager
-  is available at 
+  is available at
   http://people.imendio.com/andersca/archives/clipboard-manager-0.3.tar.gz
-  Applications can use the function gdk_display_supports_clipboard_persistence() 
+  Applications can use the function gdk_display_supports_clipboard_persistence()
   to find out if clipboard persistence is available.
 
-* Notification on clipboard ownership changes via GdkOwnerChange events 
+* Notification on clipboard ownership changes via GdkOwnerChange events
   requires the XFIXES X extension. Applications can use the function
   gdk_display_supports_selection_notification() to find out if ownerchip
   change notification is available.
 
-* The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
-  specification. Setting the XDG_DATA_DIRS environtment variable may be 
-  necessary if your icons aren't installed in the default location 
+* The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme
+  specification. Setting the XDG_DATA_DIRS environtment variable may be
+  necessary if your icons aren't installed in the default location
   /usr/share/icons.
 
 * The icon theme code in GTK+ 2.6 can make use of mmap()able cache files
@@ -293,49 +293,49 @@ Release notes for 2.6
   gtk-update-icon-cache to generate these cache files. For further details,
   see the gtk-update-icon-cache man page or the GTK+ documentation.
 
-* To reduce code size and improve efficiency, GTK+, when compiled 
-  with the GNU toolchain, has separate internal and external entry 
-  points for exported functions. The internal names, which begin with 
+* To reduce code size and improve efficiency, GTK+, when compiled
+  with the GNU toolchain, has separate internal and external entry
+  points for exported functions. The internal names, which begin with
   IA__, may be seen when debugging a GTK+ program.
 
 * The following functions have been deprecated in GTK+ 2.6:
   gdk_pango_context_set_colormap
   gtk_cell_renderer_editing_canceled
 
-* The new GtkFileChooser widget emphasizes simplicity and thus does 
-  not provide a navigation entry by default when opening files. 
+* The new GtkFileChooser widget emphasizes simplicity and thus does
+  not provide a navigation entry by default when opening files.
   Experienced command line users will likely want to make heavy use of
   the location dialog brought up by the Control-L key shortcut.
 
 * The GTK+ libraries use 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 _gtk, _gdk, and _pango will be exported
   from the library, on others not. In no case can applications
   use these private symbols. In addition to that, GTK+ 2.6 makes several
   symbols private which were not in any installed header files and
   were never intended to be exported.
 
-* The gdk_pixbuf_xlib library included in the contrib/ directory 
+* The gdk_pixbuf_xlib library included in the contrib/ directory
   and the framebuffer GDK backend included in the gdk/linux-fb directory
-  of GTK+ are provided on an as-is basis and have not been tested at all. 
+  of GTK+ are provided on an as-is basis and have not been tested at all.
   No guarantees about the degree of workingness or about future
   compatibility are provided.
 
-* On Unix, the assumption of GLib and GTK+ by default is that filenames on 
+* On Unix, the assumption of GLib and GTK+ by default is that filenames on
   the filesystem are encoded in UTF-8 rather than the encoding of the locale;
   the GTK+ developers consider that having filenames whose interpretation
   depends on the current locale is fundamentally a bad idea.
 
-  If you have filenames encoded in the encoding of your locale, then you 
+  If you have filenames encoded in the encoding of your locale, then you
   may want to set the G_FILENAME_ENCODING environment variable:
-  
+
    G_FILENAME_ENCODING=@locale
    export G_FILENAME_ENCODING
 
   (Earlier versions of GLib 2.x required a different environment variable
-  setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this 
+  setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this
   is still supported, but G_FILENAME_ENCODING is preferred.)
-  Best integration of GTK+ 2.6 with the environment is achieved by 
+  Best integration of GTK+ 2.6 with the environment is achieved by
   using a UTF-8 locale.
 
   On Windows, filenames passed to GTK+ should always be in UTF-8, as
@@ -346,7 +346,7 @@ Release notes for 2.6
 
   When compiling against GTK+ 2.6, applications intended to be
   portable to Windows must take the UTF-8 file name encoding into
-  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 GTK+ or GLib.
 
 
@@ -356,9 +356,9 @@ How to report bugs
 Bugs should be reported to the GNOME bug tracking system.
 (http://bugzilla.gnome.org, product gtk+.) You will need to create an
 account for yourself.
-  
+
 In the bug report please include:
-  
+
 * Information about your system. For instance:
 
    - What operating system and version
@@ -367,12 +367,12 @@ In the bug report please include:
 
   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 tests or demos built with GTK+, 
-  such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise, 
-  please include a short test program that exhibits the behavior. As a 
-  last resort, you can also provide a pointer to a larger piece of software 
+  If you can reproduce it with one of the tests or demos built with GTK+,
+  such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise,
+  please include a short test program that exhibits the behavior. As a
+  last resort, you can also provide a pointer to a larger piece of software
   that can be downloaded.
 
 * If the bug was a crash, the exact text that was printed out when the
@@ -397,5 +397,5 @@ the patch to that bug report.
 Bug reports containing patches should include the PATCH keyword in their
 keyword fields. If the patch adds to or changes the GTK+ programming
 interface, the API keyword should also be included.
-  
+
 Patches should be in unified diff form. (The -u option to GNU diff.)
index 4eeeaa5016da0f5372d0cb1a17d5c3992e5dd06e..392b7acdf44d07eccfe9e5257dfb098d76a45a3b 100644 (file)
@@ -1,11 +1,11 @@
-GTK+ is part of the GNOME Subversion repository. At the current time, any
+GTK+ is part of the GNOME git repository. At the current time, any
 person with write access to the GNOME repository, can make changes to
 GTK+. This is a good thing, in that it encourages many people to work
 on GTK+, and progress can be made quickly. However, GTK+ 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 GTK+ that has been built up over the last 4 years, we'd like
-to ask people commiting to GTK+ to follow a few rules:
+to ask people committing to GTK+ 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
@@ -14,9 +14,9 @@ to ask people commiting to GTK+ to follow a few rules:
    somebody may know a better way to do things.
 
    If you are making changes to GTK+, you should be subscribed
-   to gtk-devel-list@gnome.org. (Subscription address:  
+   to gtk-devel-list@gnome.org. (Subscription address:
    gtk-devel-list-request@gnome.org.) This is a good place to ask
-   about intended changes. 
+   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,
@@ -25,30 +25,48 @@ to ask people commiting to GTK+ to follow a few rules:
 
 1) Ask _first_.
 
-2) There must be a ChangeLog for every commit. (If you discover that
-   you only committed half the files you meant to and need to fix that
-   up, or something, you don't need a new ChangeLog entry. But in general,
-   ChangeLog entries are mandatory.) Changes without ChangeLog entries
-   will be reverted.
-
-3) There _must_ be a ChangeLog for every commit.
+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:
 
-* If you are going to be changing many files in an experimental fashion,
-  it probably is a good idea to create a separate branch for your changes.
+* When developing larger features or complicated bug fixes, it is
+  advisable to work in a branch in your own cloned GTK+ 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 ===
 
-* The ChangeLog entries should preferably match in date format
-  with the existing entries. You can set how emacs does this
-  by using customize mode:
+  - 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).
 
-  - M-x customize
-  - set Programming/Tools/ChangeLog/Add Log Time Format to
-    'Old Format'
+  - 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.
 
- Or, set the add-log-time-format to 'current-time-string in
- your .emacs file.
 
 Owen Taylor
 13 Aug 1998
 17 Apr 2001
+
+Matthias Clasen
+31 Mar 2009
index 5b470cc840f1e7e6a8e1dfc3a93a70930a6c78cf..58ae652f63c1fe350d93dcc7bacdc961354376b2 100644 (file)
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, GTK+ 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>
 
        * === Released 2.16.0 ===
index f677e6e77c794e1a4fd35c9e66df04400eaebe6f..2447903bdc42f07a8888241d76814dba53f8eddb 100644 (file)
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, GTK+ 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-25   Paul Bolle <pebolle@tiscali.nl>
 
        Bug 562863 - GtkVscrollbar is hardly documented
index 8f6d6a2702b7dd5c75b303ceaff9997debdf3d23..d8431db13a6bdfda89b6c569ed5e7ba4807a865e 100644 (file)
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, GTK+ 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>
 
        * === Released 2.16.0 ===
index 00975e8093fc088ea0de06ff629db6e426d5d227..8764d38bcc61f34477d7ca85d32e6af1c22b1e5e 100644 (file)
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, GTK+ 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>
 
        * === Released 2.16.0 ===
index eea65f1bd10418d30e8e204207509cecc97c4dae..6ea385398e1be0e6ae10dff3076100219df7af49 100644 (file)
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, GTK+ 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-25  Tor Lillqvist  <tml@novell.com>
 
        Bug 575644 - Cygwin gail build patch
index 951fe675c315b2adae96d360eb1353945621e386..4dc0c7c5ab41e777d9accffb97e31e13d678cbde 100644 (file)
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, GTK+ 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>
 
        * or.po:  Updated Oriya Translation
index ff6d45f32b3c5d04f4f2b5ac34c4385dbbe7e372..204ee356810b18543f087bdeb4b2febdfdb367a4 100644 (file)
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, GTK+ 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-28  Jorge Gonzalez  <jorgegonz@svn.gnome.org>
 
        * es.po: Fixed wrong string.