API/ABI changes review for Tesseract #793

lvc · 2017-03-28T06:20:02Z

The review of API/ABI changes for Tesseract since 3.00 version: https://abi-laboratory.pro/tracker/timeline/tesseract/

Hope it will be helpful for users and maintainers of the library.

Created with the help of open-source abi-tracker tool: https://github.com/lvc/abi-tracker

The tool checks all API symbols declared in header files (doesn't take docs into account), so there may be some false positives.

Thank you.

Environment

Linux x86_64
GCC 4.9
Tesseract 3.00 and higher

zdenop · 2017-03-28T06:34:44Z

Why you put this on in the issue tracker?

lvc · 2017-03-28T06:38:45Z

To take attention of library developers on the results first.

Thank you.

Shreeshrii · 2017-03-28T06:40:58Z

@lvc Thanks! I have added info to the documentation wiki at

https://github.com/tesseract-ocr/tesseract/wiki/Documentation

amitdo · 2017-03-28T08:10:53Z

@lvc,
Thanks for the info.

3.01 and 3.03 are missing from the report.

The bottom line is that we break the ABI in almost every release.

amitdo · 2017-03-28T10:50:43Z

@lvc,
FYI, since 3.02 there is an "--enable-visibility" option for the configure script.

zdenop · 2017-03-28T10:59:53Z

@lvc : Thanks, but there is place for this: tesseract developer forum.
@amitdo : Broken ABI is know issue ;-) Even API is not stable. See dev forum.

lvc · 2017-03-29T12:10:30Z

@amitdo,

3.01 and 3.03 are missing from the report

Added 3.01 and 3.03 versions to the report: https://abi-laboratory.pro/tracker/timeline/tesseract/

Thank you.

Shreeshrii · 2017-05-08T03:29:28Z

@lvc If possible, instead of current version, add 'master' and '3.05' branch. Thanks!

lvc · 2017-05-08T11:13:28Z

@Shreeshrii,

Done: https://abi-laboratory.pro/tracker/timeline/tesseract/

Please let me know when it should be switched to 3.06 or 4.0.

Shreeshrii · 2017-05-08T11:30:59Z

Thanks. Actually, 3.05 and master 4.0 are going to be two parralel tracks for a while. Zdenko is going to tag 3.05.01 release soon, so that should be compared with 3.05.0 for changes. Any changes after that on 3.05 branch should follow as current in that sequence. Similarly, 4.0.0alpha may be followed by a beta or release, plus changes in master branch. If not possible to do in same table, you can make a separate one for 4.0. Thanks.

…

On May 8, 2017 4:43 PM, "ABI Laboratory" ***@***.***> wrote: @Shreeshrii <https://github.com/Shreeshrii>, Done: https://abi-laboratory.pro/tracker/timeline/tesseract/ Please let me know when it should be switched to 3.06 or 4.0. [image: tesseract-5] <https://cloud.githubusercontent.com/assets/1517837/25801811/724dac08-3400-11e7-9af3-ff379784aeaf.png> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#793 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AE2_o8RhIVFBMs9UWv8yY7aXzTrDJZwmks5r3vjigaJpZM4MrL5o> .

Shreeshrii · 2018-03-26T09:17:07Z

@lvc Please update this for the master branch now, as 4.0.0-beta.1 has been released.

Thanks!

lvc · 2018-03-28T08:08:04Z

Done: https://abi-laboratory.pro/tracker/timeline/tesseract/

Thanks for notifying!

Shreeshrii · 2018-03-28T08:47:40Z

@lvc Thank you for your prompt response.

Will tracker keep getting updated automatically as more commits are made to master branch?

lvc · 2018-03-29T05:19:59Z

@Shreeshrii Yes, it's updated every Mon, Wed and Fri.

Shreeshrii · 2018-03-29T05:39:25Z

Thanks, that's great.

amitdo · 2018-10-29T20:26:19Z

@lvc,
Please add 4.0.0.

zdenop · 2018-10-30T09:25:53Z

I put the link to release notes for easier tracking
@lvc 👍 I have a few requests ;-)

Is it possible to generate table of changes also in format that would be easy to integrate to github wiki (e.g. image)?
Is it possible to include in analyze only released version (e.g. remove 4.0.0-beta.1 prerelease) + the latest master code?

lvc · 2018-10-31T07:26:37Z

@zdenop

I put the link to release notes for easier tracking
@lvc +1 I have a few requests ;-)

1. Is it possible to generate table of changes also in format that would be easy to integrate to github wiki (e.g. image)?

2. Is it possible to include in analyze only released version (e.g. remove 4.0.0-beta.1 prerelease) + the latest master code?

I've added the print url option to hide site headers. Try:

 CutyCapt --url='https://abi-laboratory.pro/?view=timeline&l=tesseract&print=1' --out=tesseract.svg

Done:

Thank you!

zdenop · 2018-10-31T09:23:32Z

@lvc: thanks for prompt replay. Something like
https://abi-laboratory.pro/?view=timeline&l=tesseract&graph.svg?v=1.1 is not possible?
It would be much more easier to integrate online image to wiki (without need to render it locally) and it would allow automatic update of image after update of analyze.

Or is there another way how to integrate your tool to github project (somehing like lgtm or coverity - see Readme.md)?

amitdo · 2018-10-31T10:05:45Z

@lvc,
You removed the beta but didn't add the final 4.0.0.

See also above comment from @zdenop.

zdenop · 2018-10-31T10:11:24Z

@amitdo : see #793 (comment) I expect it will be generated automatically today.

lvc · 2018-10-31T13:32:34Z

@lvc: thanks for prompt replay. Something like
https://abi-laboratory.pro/?view=timeline&l=tesseract&graph.svg?v=1.1 is not possible?
It would be much more easier to integrate online image to wiki (without need to render it locally) and it would allow automatic update of image after update of analyze.

Or is there another way how to integrate your tool to github project (somehing like lgtm or coverity - see Readme.md)?

Good idea!

I'll implement it ASAP as part of the abi-tracker project. Thank you!

lvc · 2018-10-31T13:39:35Z

@lvc,
You removed the beta but didn't add the final 4.0.0.

See also above comment from @zdenop.

Report is updated: https://abi-laboratory.pro/?view=timeline&l=tesseract

Got this image by CutyCapt:

Shreeshrii · 2018-10-31T14:06:19Z

My suggestion is to link the image with the html version so that the links to changelog etc work. Thanks.

…

On Wed, 31 Oct 2018, 09:39 Andrey P. ***@***.*** wrote: @lvc <https://github.com/lvc>, You removed the beta but didn't add the final 4.0.0. See also above comment from @zdenop <https://github.com/zdenop>. Report is updated: https://abi-laboratory.pro/?view=timeline&l=tesseract Got this image by CutyCapt: [image: tesseract] <https://user-images.githubusercontent.com/1517837/47791510-ed09af80-dd2a-11e8-8e29-9272a2a34751.png> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#793 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AE2_o8XnGN2MsW0JVsUCF51PsBrqz4g5ks5uqagrgaJpZM4MrL5o> .

zdenop · 2018-10-31T14:15:24Z

@lvc : table is stored in wiki repository so I need to update it manually; graph is linked directly to your page, but it seem github is caching it: https://camo.githubusercontent.com/ae5fd8a19e16ec27b191716fe3079ecd35ad07d3/68747470733a2f2f6162692d6c61626f7261746f72792e70726f2f747261636b65722f67726170682f7465737365726163742f67726170682e7376673f763d312e31

Shreeshrii · 2019-04-29T14:53:56Z

@lvc Please update the report for https://github.com/tesseract-ocr/tesseract/tree/4.1

4.1 is planned as a bug-fix release. Master is 5.0 alpha.

It will be good to check status of API compatibility for 4.1.

See related discussion at #2249 (comment)

linuxhw · 2019-04-29T19:52:57Z

@Shreeshrii

It will be good to check status of API compatibility for 4.1.

Done.

See https://abi-laboratory.pro/?view=timeline&l=tesseract

stweil · 2019-04-29T20:40:40Z

@linuxhw, most important is currently the API compatibility from 4.0 to 4.1. Can this be checked, too?

linuxhw · 2019-04-30T21:00:48Z

@linuxhw, most important is currently the API compatibility from 4.0 to 4.1. Can this be checked, too?

The report is currently for 4.0 vs git 4.1 branch (instead of master).

Shreeshrii · 2019-05-01T04:02:35Z

@linuxhw Thank you!

Current Status

Git(4.1)	2019-04-3021:43	4	changelog	99%	35 new	0

zdenop · 2019-05-04T13:43:40Z

Yes, it's updated every Mon, Wed and Fri.
@linuxhw @lvc : Is this still valid?

linuxhw · 2019-05-05T06:31:52Z

Yes, it's updated every Mon, Wed and Fri.
@linuxhw @lvc : Is this still valid?

Temporarily not. I'm working currently on restoring the service after the storage failure (since Apr 4). The report for Tesseract was updated manually 4 days ago.

Update it again?

zdenop · 2019-05-05T06:41:11Z

Please update it on Monday - I want to test some commits today evening (European time ;-) )

zdenop · 2019-05-05T18:09:23Z

Thanks. You start update now.

linuxhw · 2019-05-06T18:59:11Z

Report is updated.

zdenop · 2019-06-17T07:40:39Z

@linuxhw: can you please updare reportfor 4.1? Hopefully we created the last rc (3) for 4.1

stweil · 2019-06-17T08:07:14Z

@zdenop, please remember to update the VERSION file when tagging a release.

lvc · 2019-06-17T10:43:45Z

@linuxhw: can you please updare reportfor 4.1? Hopefully we created the last rc (3) for 4.1

Failed to build latest master due to error:

libtool: link: ( cd ".libs" && rm -f "libtesseract.la" && ln -s "../libtesseract.la" "libtesseract.la" )
/bin/sh ../../libtool  --tag=CXX   --mode=link g++  -g -Og -w -fpermissive -fPIC -std=c++14  -L/home/andrey/ABI_Tracker/installed/leptonica/1.74.1/lib -o tesseract tesseract-tesseractmain.o libtesseract.la -L/home/andrey/ABI_Tracker/installed/leptonica/1.74.1/lib -llept  -fopenmp  -larchive   -lrt -lpthread 
libtool: link: g++ -g -Og -w -fpermissive -fPIC -std=c++14 -o .libs/tesseract tesseract-tesseractmain.o -fopenmp  -L/home/andrey/ABI_Tracker/installed/leptonica/1.74.1/lib ./.libs/libtesseract.so -llept -larchive -lrt -lpthread -fopenmp -Wl,-rpath -Wl,/home/andrey/ABI_Tracker/installed/tesseract/current/lib
./.libs/libtesseract.so: undefined reference to `signal_exit(int)'

zdenop · 2019-06-17T11:16:11Z

Can you provide details about environment you use and how did you build tesseract?

lvc · 2019-06-17T12:25:21Z

Can you provide details about environment you use and how did you build tesseract?

./configure --enable-shared --prefix="..." CFLAGS="-g -Og -w -fpermissive -fPIC" CXXFLAGS="-g -Og -w -fpermissive -fPIC" PKG_CONFIG_PATH=/.../leptonica/1.74.1/lib/pkgconfig LIBLEPT_HEADERSDIR=/.../leptonica/1.74.1/include/ LDFLAGS='-L/.../leptonica/1.74.1/lib' CFLAGS='-g -Og -I/.../leptonica/1.74.1/include'
make

Fedora 21, x86_64, GCC 4.9.2 20150212 (Red Hat 4.9.2-6).

The environment is not changed since the last successful build.

stweil · 2019-06-17T12:57:15Z

The linker error was introduced by commit 78ced35. I fixed it in commit 9a5f724.

lvc · 2019-06-17T13:34:55Z

The linker error was introduced by commit 78ced35. I fixed it in commit 9a5f724.

Report is updated: https://abi-laboratory.pro/index.php?view=timeline&l=tesseract (no changes since previous update of the report).

zdenop · 2019-12-26T15:46:07Z

@lvc : 4.1.1 was just released... Can you please update https://abi-laboratory.pro/?view=timeline&l=tesseract and remove 4.1.1-rc2 from that comparison?

linuxhw · 2019-12-27T07:21:50Z

@lvc : 4.1.1 was just released... Can you please update https://abi-laboratory.pro/?view=timeline&l=tesseract and remove 4.1.1-rc2 from that comparison?

Done. Thanks.

zdenop · 2019-12-27T18:34:42Z

thanks!

zdenop · 2019-12-27T18:48:05Z

Hm.. when I run it localy on my linux machine I had 100% backward compatibility...

linuxhw · 2019-12-28T04:30:28Z

Hm.. when I run it localy on my linux machine I had 100% backward compatibility...

Please attach your ABI dumps here for both versions for debugging.

zdenop · 2019-12-28T18:39:49Z

I can provide after 1st of January...

zdenop · 2020-01-01T20:33:35Z

see lvc/abi-dumper#23

Shreeshrii · 2021-11-13T13:48:24Z

@linuxhw please update the tracker for the latest version from main branch. Also a heads-up for upcoming 5.0.0 release.

Shreeshrii · 2022-01-13T12:10:09Z

@lvc Tesseract 5.0 has been released. please update https://abi-laboratory.pro/?view=timeline&l=tesseract

Thanks!

linuxhw · 2022-01-18T19:07:40Z

@lvc Tesseract 5.0 has been released. please update https://abi-laboratory.pro/?view=timeline&l=tesseract

Thanks!

Done

linuxhw · 2022-01-18T19:09:15Z

@lvc Tesseract 5.0 has been released. please update https://abi-laboratory.pro/?view=timeline&l=tesseract

Thanks!

zdenop closed this as completed Mar 28, 2017

Shreeshrii mentioned this issue Mar 26, 2018

RFC: Tesseract 4.0.0 – open tasks #1423

Closed

Shreeshrii reopened this Nov 13, 2021

amitdo added the API label Jan 7, 2022

API/ABI changes review for Tesseract #793

API/ABI changes review for Tesseract #793

Comments

lvc commented Mar 28, 2017

Environment

zdenop commented Mar 28, 2017

lvc commented Mar 28, 2017

Shreeshrii commented Mar 28, 2017

amitdo commented Mar 28, 2017 • edited Loading

amitdo commented Mar 28, 2017

zdenop commented Mar 28, 2017

lvc commented Mar 29, 2017

Shreeshrii commented May 8, 2017

lvc commented May 8, 2017

Shreeshrii commented May 8, 2017 via email

Shreeshrii commented Mar 26, 2018

lvc commented Mar 28, 2018

Shreeshrii commented Mar 28, 2018

lvc commented Mar 29, 2018

Shreeshrii commented Mar 29, 2018

amitdo commented Oct 29, 2018

zdenop commented Oct 30, 2018

lvc commented Oct 31, 2018 • edited Loading

zdenop commented Oct 31, 2018

amitdo commented Oct 31, 2018

zdenop commented Oct 31, 2018

lvc commented Oct 31, 2018

lvc commented Oct 31, 2018

Shreeshrii commented Oct 31, 2018 via email

zdenop commented Oct 31, 2018

Shreeshrii commented Apr 29, 2019

linuxhw commented Apr 29, 2019

stweil commented Apr 29, 2019

linuxhw commented Apr 30, 2019

Shreeshrii commented May 1, 2019

zdenop commented May 4, 2019

linuxhw commented May 5, 2019

zdenop commented May 5, 2019

zdenop commented May 5, 2019

linuxhw commented May 6, 2019

zdenop commented Jun 17, 2019

stweil commented Jun 17, 2019

lvc commented Jun 17, 2019

zdenop commented Jun 17, 2019

lvc commented Jun 17, 2019

stweil commented Jun 17, 2019 • edited Loading

lvc commented Jun 17, 2019

zdenop commented Dec 26, 2019

linuxhw commented Dec 27, 2019 • edited Loading

zdenop commented Dec 27, 2019

zdenop commented Dec 27, 2019

linuxhw commented Dec 28, 2019

zdenop commented Dec 28, 2019

zdenop commented Jan 1, 2020

Shreeshrii commented Nov 13, 2021

Shreeshrii commented Jan 13, 2022

linuxhw commented Jan 18, 2022

linuxhw commented Jan 18, 2022

amitdo commented Mar 28, 2017 •

edited

Loading

lvc commented Oct 31, 2018 •

edited

Loading

stweil commented Jun 17, 2019 •

edited

Loading

linuxhw commented Dec 27, 2019 •

edited

Loading