rename hexdump() to sml_hexdump()

volkszaehler / libsml

Implementation in C of the Smart Message Language (SML) protocol

GNU General Public License v3.0

88 stars 49 forks source link

rename hexdump() to sml_hexdump() #117

Closed mh-er closed 1 year ago

mh-er commented 1 year ago

see issue #113

denis-martin commented 1 year ago

I can confirm that it solves #113 (makes it compatible again with ESP8266 libraries)

r00t- commented 1 year ago

i'm undecided on this. in theory it would require a version bump, as it breaks ABI compatibility. (any program that uses the function will require re-linking to work with the updated library.) OTOH most likely nobody uses the function anyway, and having a public function with such a generic name was probably a bad idea to begin with.

denis-martin commented 1 year ago

An intermediate solution could be to only disable (or rename) hexdump() in an Arduino/ESP8266 environment for now. This way, the API change can be deferred to the next planned major version for all other environments.

For ESP8266, it is currently anyway broken, so the API change might not be critical.

mh-er commented 1 year ago

Well, actually that is what I did when I created the branch for my ESP8266 project. Looking into the libsml source files, I observed

that hexdump() was not used anywhere within the lib
the name of the function does not follow the convention of all the other functions (which have the prefix sml_) I guess it was a bad hack when hexdump() was added. I assume that nobody is using it. Nevertheless - if anybody has to re-compile/re-link his application, it would not be a big thing to adapt to the API change. For me, it is ok to wait for the next "major" version ... (if there is any in the future).

narc-Ontakac2 commented 1 year ago

I'll do a debian release soon. If you want this PR to be a part of it (which IMHO would be good) please merge it.