From ec5fc441e38e59a57cd508abf420e30fc3c28e0d Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Sun, 21 Aug 2022 13:52:19 +0200 Subject: 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. --- srd.c | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'srd.c') diff --git a/srd.c b/srd.c index 273b6bc..6bff918 100644 --- 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(); -- cgit v1.2.3-70-g09d2