From: Gerhard Sittig <redacted>
Date: Tue, 17 Dec 2019 11:57:52 +0000 (+0100)
Subject: drivers: update comment on "driver list" linker section
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=d829239749d1cf2934a067080e78eeb4ef1913f5;p=libsigrok.git

drivers: update comment on "driver list" linker section

Update and slightly extend the comment on the "__sr_driver_list"
linker section which holds a list of all drivers which were built
into the libsigrok library.
---

diff --git a/src/drivers.c b/src/drivers.c
index 30d6308a..bf3f0b04 100644
--- a/src/drivers.c
+++ b/src/drivers.c
@@ -25,11 +25,12 @@
 #include "libsigrok-internal.h"
 
 /*
- * sr_driver_list is a special section contains pointers to all the hardware
- * drivers built into the library. The __start and __stop symbols are
- * created from driver_list_start.c and driver_list_stop.c, and point to the
- * start and end of the section. They are used to iterate over the list of
- * all drivers.
+ * The special __sr_driver_list section contains pointers to all hardware
+ * drivers which were built into the library according to its configuration
+ * (will depend on the availability of dependencies, as well as user provided
+ * specs). The __start and __stop symbols point to the start and end of the
+ * section. They are used to iterate over the list of all drivers which were
+ * included in the library.
  */
 SR_PRIV extern const struct sr_dev_driver *sr_driver_list__start[];
 SR_PRIV extern const struct sr_dev_driver *sr_driver_list__stop[];