From 1adb147f6d2e7b7e3ac0d47ba1d9d33720992d92 Mon Sep 17 00:00:00 2001
From: Thomas Hindoe Paaboel Andersen <phomes@gmail.com>
Date: Wed, 27 Sep 2017 21:43:59 +0200
Subject: [PATCH] expand documentation of probe call

Add a comment that drivers are expected to initialize and
read all profiles in the probe callback.

Fixes #333
---
 src/libratbag-private.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/libratbag-private.h b/src/libratbag-private.h
index 9acc93a0..8f6b58b5 100644
--- a/src/libratbag-private.h
+++ b/src/libratbag-private.h
@@ -135,6 +135,10 @@ struct ratbag_driver {
 	 *
 	 * Return -ENODEV to ignore the device and let other drivers
 	 * probe the device. Any other error code will stop the probing.
+	 *
+	 * If a matching driver is found it should initialize itself
+	 * and synchronize all profiles with the current state on the device
+	 * in this callback.
 	 */
 	int (*probe)(struct ratbag_device *device);