mqttc: Clean up

Signed-off-by: Vladimir Petrigo <[email protected]>
LiamBindle · Aug 14, 2020 · 886801d · 886801d
1 parent c357305
commit 886801d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/include/mqtt.h b/include/mqtt.h
@@ -29,6 +29,12 @@ SOFTWARE.
 extern "C" {
 #endif
 
+// Users can override mqtt_pal.h with their own configuration by defining
+// MQTTC_PAL_FILE as a header file to include (-DMQTTC_PAL_FILE=my_mqtt_pal.h).
+//
+// If MQTTC_PAL_FILE is used, none of the default utils will be emitted and must be
+// provided by the config file. To start, I would suggest copying mqtt_pal.h
+// and modifying as needed.
 #ifdef MQTTC_PAL_FILE
 #define MQTTC_STR2(x) #x
 #define MQTTC_STR(x) MQTTC_STR2(x)