srd: add TODO comment on the SIGROKDECODE_DIR env var's motivation

[libsigrokdecode.git] / srd.c

diff --git a/srd.c b/srd.c
index 22f47fcf26a869ad8856e90b6f7f34bc76be5741..6bff9188aea68a4466340297d20122fd0973e4fe 100644 (file)
--- a/srd.c
+++ b/srd.c
@@ -67,8 +67,8 @@ extern SRD_PRIV int max_session_id;
  * @section sec_irc IRC
  *
  * You can find the sigrok developers in the
- * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
- * IRC channel on Freenode.
+ * <a href="ircs://irc.libera.chat/#sigrok">\#sigrok</a>
+ * IRC channel on Libera.Chat.
  *
  * @section sec_website Website
  *
@@ -270,6 +270,15 @@ SRD_API int srd_init(const char *path)
        }
 
        /* Environment variable overrides everything, for debugging. */
+       /*
+        * TODO
+        * Is the comment still applicable and correct or up to date?
+        * This implementation adds paths which were specified by the
+        * env var. Which can shadow files in other locations, or can
+        * extend the set of available decoders. Which need not only
+        * serve for development, it is as beneficial to regular users.
+        * Without shadowing all other files still are found.
+        */
        if ((env_path = g_getenv("SIGROKDECODE_DIR"))) {
                if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
                        Py_Finalize();