HACKING

   1 The JHBuild module consists of a package build framework, and a number
   2 of configuration files for building various GNOME releases.  The rules
   3 for checkins differ for each.
   4
   5 Modifications to the build framework should be submitted as bug reports
   6 at http://bugzilla.gnome.org/enter_bug.cgi?product=jhbuild where they
   7 can be reviewed before being committed.  The exception to this is build
   8 sheriff style commits for small errors that prevent people from using
   9 JHBuild.  When in doubt, submit a bug report.
  10
  11 The modulesets/ directory contains configuration files that describe
  12 how to build various versions of GNOME.  The file gnome-*-XY.modules
  13 contains rules needed to build the stable version X.Y of GNOME or the
  14 development branch leading up to that version.  Changes of the
  15 following types can be committed without approval:
  16
  17   - Updating the branch tag for a module if it is incorrect for that
  18     GNOME release.
  19
  20   - Updating to a new version of a tarball for tarball type
  21     definitions, provided the new version is appropriate for that GNOME
  22     release. If updating an external dependency of GNOME, read the
  23     rules at http://live.gnome.org/_version_/ExternalDependencies
  24     where _version_ is the applicable GNOME version. Update the wiki
  25     page if required.
  26
  27   - Adding a definition for a module that is part of the GNOME desktop,
  28     developer platform, 5th toe or bindings release, etc, but is
  29     missing from the module set.
  30
  31   - Removal of module definitions where the associated module has been
  32     removed/obsoleted from the particular GNOME version (eg. acme was
  33     removed from gnome26 when it got integrated into control-center).
  34
  35 A number of modules that fall outside of a GNOME release but are
  36 related to GNOME are also included in the module set.  This includes
  37 software that may be under development and not ready for general use.
  38
  39 If you would like to add a module to one of the standard module sets,
  40 submit a bug report as detailed above.  If it is GNOME related, it
  41 will probably get accepted in the gnome-world modules.
  42
  43 Modules that are not GNOME related are to be entered into the modules
  44 within the 'other' directory.  Keep in mind that JHBuild supports
  45 external module sets that are identified by a full URI, which allows
  46 third parties to maintain module sets independently.
  47
  48
  49 James Henstridge.