HACKING

   1 dconf is split into a large number of small modules.  This is required
   2 because of the client/server architecture as well as the wide variety of
   3 situations that dconf is used in on the client side.
   4
   5 gvdb/:
   6
   7   This code implements the GVDB file format used for the on-disk
   8   database.  GVDB is shared with a number of other users and lives in a
   9   separate 'gvdb' module on git.gnome.org.
  10
  11   Changes should never be made to this directory.  Instead, they should
  12   be made against the 'gvdb' module and merged using git.
  13
  14   The code is split into a reader and a writer (builder).
  15
  16   This directory doesn't produce any libraries.  The source files are
  17   included into other libraries and executables by direct inclusion of
  18   these source files into the Makefiles of other directories.
  19
  20 common/:
  21
  22   Sources in this directory are used in both the dconf-service and
  23   client-side library implementations.
  24
  25   This directory produces two libraries: libdconf-common.a and
  26   libdconf-common-shared.a.  They are exactly the same, except that
  27   libdconf-common-shared.a was compiled with -fPIC.
  28
  29 engine/:
  30
  31   This directory contains most of the core logic for implementing the
  32   client-side of dconf.
  33
  34   The engine code requires (but does not contain) glue code for speaking
  35   to D-Bus.  All users of the engine must therefore include a module
  36   that implements this glue.
  37
  38   This directory produces one library: libdconf-engine.a.  This library
  39   includes the gvdb-reader.
  40
  41 gdbus/:
  42
  43   This directory contains the glue code for dconf over GDBus.
  44
  45   This directory produces one library: libdconf-gdbus.a.
  46
  47 client/:
  48
  49   This is the standard GObject client-side library used for direct access to
  50   dconf.  It uses the GDBus glue from the gdbus/ directory above.
  51
  52   This directory produces the libdconf.so shared library.
  53
  54 gsettings/:
  55
  56   This is the GSettings backend for dconf.  It also uses GDBus.
  57
  58   This directory produces the libdconfsettings.so GIOModule.
  59
  60 dbus-1/:
  61
  62   This directory contains a client-side library based on libdbus-1.  It
  63   also contains the D-Bus glue code for libdbus-1 (since it is the only
  64   client-side library that is using it).
  65
  66   This directory produces the libdconf-dbus-1.so shared library.
  67
  68 bin/:
  69
  70   This is the 'dconf' commandline tool.  It uses the library from
  71   client/ above.
  72
  73 editor/:
  74
  75   This is the graphical dconf-editor.  It also uses the client/ library.
  76
  77 service/:
  78
  79   This is the dconf-service required for any client side library to do
  80   writes.