[gnome-settings-daemon] wacom: Add README about configuration storage

[Bastien Nocera <hadess src gnome org>]

commit 956d9e2fdc5bc201821ca7fdb39263f953d9f667
Author: Bastien Nocera <hadess hadess net>
Date:   Tue Mar 13 18:17:13 2012 +0100

    wacom: Add README about configuration storage

 plugins/wacom/Makefile.am           |    2 +-
 plugins/wacom/README.config-storage |   47 +++++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+), 1 deletions(-)
---
diff --git a/plugins/wacom/Makefile.am b/plugins/wacom/Makefile.am
index 640a394..7ebb214 100644
--- a/plugins/wacom/Makefile.am
+++ b/plugins/wacom/Makefile.am
@@ -123,7 +123,7 @@ plugin_in_files = wacom.gnome-settings-plugin.in
 
 plugin_DATA = $(plugin_in_files:.gnome-settings-plugin.in=.gnome-settings-plugin)
 
-EXTRA_DIST += $(plugin_in_files)
+EXTRA_DIST += $(plugin_in_files) README.config-storage
 CLEANFILES =						\
 	$(plugin_DATA)					\
 	org.gnome.settings-daemon.plugins.wacom.policy	\
diff --git a/plugins/wacom/README.config-storage b/plugins/wacom/README.config-storage
new file mode 100644
index 0000000..167a341
--- /dev/null
+++ b/plugins/wacom/README.config-storage
@@ -0,0 +1,47 @@
+Configuration storage for Wacom tablets and styli
+
+Tablets
+-------
+
+Configuration is stored on a per-device model basis, meaning that it's
+possible to use the same device, with same configuration on 2 machines
+with a shared home directory, or replace a malfunctioning device with the
+same model and have the same configuration.
+
+It does not allow having 2 separate tablets of the same model to have different
+configurations, whether on a single machine, or using a shared home directory.
+
+The configuration scheme is:
+schema: org.gnome.settings-daemon.peripherals.wacom
+path: /org/gnome/settings-daemon/peripherals/wacom/<device ID>/
+
+where <device ID> is a unique identifier for the tablet.
+
+Stylus
+------
+
+Styli use a similar configuration scheme. The identifier for each stylus
+is the tool ID, for professional ranges, and a generic identifier for
+the consumer ranges that do not support tool ID.
+
+schema: org.gnome.settings-daemon.peripherals.wacom.stylus
+or:     org.gnome.settings-daemon.peripherals.wacom.eraser
+
+path: /org/gnome/settings-daemon/peripherals/wacom/<device ID>/<tool ID>/
+
+So each tool can be configured per tablet (so the compatible airbrush stylus
+will have different configurations on a Cintiq and an Intuos tablet)
+
+Buttons
+-------
+
+schema: org.gnome.settings-daemon.peripherals.wacom.tablet-button
+path: /org/gnome/settings-daemon/peripherals/wacom/<device ID>/<button ID>
+
+Testing
+-------
+
+You can see all the metadata held about tablets, styli and buttons using
+list-wacom, as available in the gnome-settings-daemon sources.
+
+An example output is available at: https://gist.github.com/1688632