Fix for #92 causes ABI break

[sur5r]

0285479 introduced a new field comment in the middle of struct cfg_t which causes an ABI break.

See

• Error with i3status no such option i3/i3status#224
• https://bugs.debian.org/872078

Seems #81 does not catch this.

[DaveDavenport]

It is mentioned here in the 3.1 release. (but as medium)

Is something like libtool versioning not smart to use?

[wRAR]

Unfortunately, the libtool doc doesn't teach which changes are backward compatible and which aren't. Changing field offsets in a struct isn't.

[DaveDavenport]

No it does not. (But it still has added value as it provide more info for the rt linker.)

[troglobit]

So, move the comment field to the end and keep the ABI version or bump it for a v3.2.1 bug fix release?

[sur5r]

As both 3.1 and 3,2 are "out there" I would consider a bump the correct fix. That aside, I would not move the comment field around unless there are other reasons to do so.

[DaveDavenport]

I would strongly recommend against an abi break to fix an abi break.
IMHO a bump would be the right fix.

(p.s. thanks for the great library).

[troglobit]

OK, ABI bump for v3.2.1 seemed the sane choice for me as well. But with so many interested parties I thought it only prudent to ask.

I'll get right on the release work in a day or two.

It's going to be the last release in a while, so if you guys have anything else you want fixed, it's time to pipe up :)

Otherwise, thanks for the awesome report and the kind words!

[sur5r]

OT for this issue, but, as you asked and before I open a new one:

There is Debian #462251 sitting around and I can't find it among the closed github issues.

[troglobit]

@sur5r Ah, that one ... yeah someone should double check that myvar = "${HOME}/path" is still an issue before we at least file a corresponding issue here.

[troglobit]

I've checked this now, Debian #462251 was fixed by @fhunleth in commit 80fad81, which was released in libConfuse v2.8. We even have a unit test for it.

Debian has some catching up to do. I'll send an update to the Debian bug shortly.

[troglobit]

There, fixed and relased v3.2.1.

Big thank you to everyone that contributed to to this!