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

A comment in the srd.c implementation suggests that the environment
variable SIGROKDECODE_DIR would serve debugging purposes and would
override other incarnations of available decoders. I disagree with
either of these interpretations. Add a TODO comment, the phrase may
need an update or rework.

diff --git a/srd.c b/srd.c
index 273b6bce797e2b80b67d782fc97c193238842db7..6bff9188aea68a4466340297d20122fd0973e4fe 100644 (file)
--- a/srd.c
+++ b/srd.c
@@ -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();