Add a comment outlining the discovery process.HEADmaster

1 files changed, 13 insertions, 0 deletions

diff --git a/src/gypsy-discovery.c b/src/gypsy-discovery.c
index 70788b5..07a2857 100644
--- a/src/gypsy-discovery.c
+++ b/src/gypsy-discovery.c
@@ -27,6 +27,19 @@
 
 /*
  * GypsyDiscovery - GPS device discovery service
+ *
+ * This is the part of gypsy-daemon that watches udev for new USB
+ * devices showing up, and BlueZ's DBus messags for new bluetooth
+ * devices showing up, and adds them to to the list of available
+ * devices if they probe successfully.
+ *
+ * For USB devices, we look for TTY devices with a USB device parent
+ * with a knonw USB vendor/device ID.  For bluetooth, we look for
+ * devices with the "Positioning" flag in its "Class" property.
+ *
+ * Note that discovery only applies to gypsy_discovery_list_devices().
+ * Any device node in the gypsy.conf AllowedDeviceGlobs can still be
+ * manually requested by the client.
  */
 #include "config.h"