228250 2021-07-23 14:48:02 -0700 [GTK4] Change API version from webkit2gtk-5.0 to webkitgtk-5.0 2022-09-21 11:55:56 -0700 1 1 1 Unclassified WebKit WebKitGTK WebKit Nightly Build PC Linux RESOLVED FIXED https://bugs.webkit.org/show_bug.cgi?id=245494 P2 Normal --- 244613 244615 210100 1 mcatanzaro mcatanzaro annulen bugs-noreply cgarcia ews-watchlist glenn gyuyoung.kim jbedard mcatanzaro ryuan.choi sergio oldest_to_newest 1779186 0 mcatanzaro 2021-07-23 14:48:02 -0700 I think it would be nice to try to align our API version with the GTK version, to reduce confusion in the future. It's not possible currently because our GTK 3 APIs are webkit2gtk-4.0 and webkit2gtk-4.1, but it *will* be possible in a future GTK 5 API *if* we don't bump our API version to webkit2gtk-5.0 now. Instead, I'd propose calling the GTK 4 API webkit2gtk-4.5, halfway between 4.0 and 5.0. Then we can call the future GTK 5 API webkit2gtk-5.0. We may also want to drop the legacy 2 from the API version, i.e. webkit2gtk-4.5 -> webkitgtk-4.5, to simplify things more. Or we could decide to keep it forever. 1779187 1 434126 mcatanzaro 2021-07-23 14:51:06 -0700 Created attachment 434126 Patch 1779189 2 mcatanzaro 2021-07-23 14:57:36 -0700 Alternatively, we could try to copy distro packaging by adding the GTK version to the middle of the API version. E.g. instead of webkit2gtk-4.0, we could have webkit2gtk4-5.0 (but it feels like too much versioning?). Or we could omit the versioning entirely and just have webkit2gtk5 (but having the version seems nicer to me). What I'm trying to avoid is having to know this arbitrary mapping of WebKitGTK API versions to GTK versions: webkit-1.0 - WebKitGTK for GTK 2 webkitgtk-3.0 - WebKitGTK for GTK 3, LegacyWebKit webkit2gtk-3.0 - WebKitGTK for GTK 3, modern WebKit, version 2.4 and earlier webkit2gtk-4.0 - WebKitGTK for GTK 3, with libsoup 2, version 2.6 and later webkit2gtk-4.1 - WebKitGTK for GTK 3, with libsoup 3 It's not so hard if you're a WebKit developer and have the table in front of you, but for developers using WebKit it's actually quite confusing. 1781609 3 cgarcia 2021-08-03 07:57:04 -0700 I find weird to use 4.5 for a new major API version, 4.1 was used because the API is the same, only binary compatibility was broken, so it's a new version of the 4 series. But a new version breaking the API and removing interfaces should have a new number in my opinion. I'm fine with removing the 2 from the library name, though. We are no breaking the API because of GTK4, but we might need to break the api in the feature before GTK5 is released and we would be out of sync with GTK again. 1781750 4 mcatanzaro 2021-08-03 15:07:35 -0700 (In reply to Carlos Garcia Campos from comment #3) > I find weird to use 4.5 for a new major API version, 4.1 was used because > the API is the same, only binary compatibility was broken, so it's a new > version of the 4 series. But a new version breaking the API and removing > interfaces should have a new number in my opinion. I'm fine with removing > the 2 from the library name, though. We are no breaking the API because of > GTK4, but we might need to break the api in the feature before GTK5 is > released and we would be out of sync with GTK again. Well it's up to you. I don't see a problem with 4.5. If we need an unexpected API bump, we could have webkitgtk-4.6, webkitgtk-4.7, webkitgtk-4.8 etc. so there's plenty of room to avoid desyncing with GTK. But if you prefer 5.0, fine. I can still look into how hard it would be to drop the 2. 1781840 5 cgarcia 2021-08-04 00:05:17 -0700 (In reply to Michael Catanzaro from comment #4) > (In reply to Carlos Garcia Campos from comment #3) > > I find weird to use 4.5 for a new major API version, 4.1 was used because > > the API is the same, only binary compatibility was broken, so it's a new > > version of the 4 series. But a new version breaking the API and removing > > interfaces should have a new number in my opinion. I'm fine with removing > > the 2 from the library name, though. We are no breaking the API because of > > GTK4, but we might need to break the api in the feature before GTK5 is > > released and we would be out of sync with GTK again. > > Well it's up to you. I don't see a problem with 4.5. If we need an > unexpected API bump, we could have webkitgtk-4.6, webkitgtk-4.7, > webkitgtk-4.8 etc. so there's plenty of room to avoid desyncing with GTK. > > But if you prefer 5.0, fine. I can still look into how hard it would be to > drop the 2. I'm not sure, TBH. We still have time to decide. We can start by removing the 2 for now. 1781886 6 mcatanzaro 2021-08-04 08:30:24 -0700 (In reply to Carlos Garcia Campos from comment #5) > We can start by removing the 2 for now. Turns out this is hard. :D pkg-config is easy enough, but there is also: * .so library name * public include path * gtk-doc package * bazillions of internal paths, e.g. derived sources and framework headers We might need to go one at a time.... 1811925 7 mcatanzaro 2021-11-04 11:57:10 -0700 tbh removing the 2 might not be worth the effort. Changing just the API version is a lot easier, since that only needs to be changed in just a couple places. 1886520 8 mcatanzaro 2022-07-25 10:19:33 -0700 (In reply to Michael Catanzaro from comment #0) > I think it would be nice to try to align our API version with the GTK > version, to reduce confusion in the future. Nobody cares. Probably not worth it. > We may also want to drop the legacy 2 from the API version, i.e. > webkit2gtk-4.5 -> webkitgtk-4.5, to simplify things more. Or we could decide > to keep it forever. I'm going to investigate the feasibility of doing this. If it's not easy, then I'll close this bug. 1886561 9 mcatanzaro 2022-07-25 13:12:20 -0700 (In reply to Michael Catanzaro from comment #8) > I'm going to investigate the feasibility of doing this. If it's not easy, > then I'll close this bug. I thought this was going to work, but problem is #includes in public headers, e.g.: #if !defined(__WEBKIT2_H_INSIDE__) && !defined(WEBKIT2_COMPILATION) #error "Only <webkit2/webkit2.h> can be included directly." #endif It may be possible if we adopt Adrian's suggestion to use https://dotat.at/prog/unifdef/. I'll investigate that now. 1895008 10 mcatanzaro 2022-08-30 17:59:42 -0700 Pull request: https://github.com/WebKit/WebKit/pull/3834 1897022 11 ews-feeder 2022-09-08 07:50:01 -0700 Committed 254269@main (5b5c7d2947db): <https://commits.webkit.org/254269@main> Reviewed commits have been landed. Closing PR #3834 and removing active labels. 434126 2021-07-23 14:51:06 -0700 2021-08-09 08:50:13 -0700 Patch bug-228250-20210723165105.patch text/plain 3709 mcatanzaro U3VidmVyc2lvbiBSZXZpc2lvbjogMjgwMjU4CmRpZmYgLS1naXQgYS9Tb3VyY2UvY21ha2UvT3B0 aW9uc0dUSy5jbWFrZSBiL1NvdXJjZS9jbWFrZS9PcHRpb25zR1RLLmNtYWtlCmluZGV4IDNiMGFi NDBkYTUwMDJhMGE3NGVjNDMzMWFhNjVmYjNiNGEzNWY2NjMuLjA5OTZhNTFjNzg4MmNhODliYmVi NmIxMzU3NmQzODQ1YTc1ZjhkMjYgMTAwNjQ0Ci0tLSBhL1NvdXJjZS9jbWFrZS9PcHRpb25zR1RL LmNtYWtlCisrKyBiL1NvdXJjZS9jbWFrZS9PcHRpb25zR1RLLmNtYWtlCkBAIC0yMjQsOCArMjI0 LDggQEAgZW5kaWYgKCkKIGVuZGlmICgpCiAKIGlmIChVU0VfR1RLNCkKLSAgICBzZXQoV0VCS0lU R1RLX0FQSV9WRVJTSU9OIDUuMCkKLSAgICBzZXQoV0VCS0lUR1RLX0FQSV9ET0NfVkVSU0lPTiA1 LjApCisgICAgc2V0KFdFQktJVEdUS19BUElfVkVSU0lPTiA0LjUpCisgICAgc2V0KFdFQktJVEdU S19BUElfRE9DX1ZFUlNJT04gNC41KQogZWxzZWlmIChVU0VfU09VUDIpCiAgICAgc2V0KFdFQktJ VEdUS19BUElfVkVSU0lPTiA0LjApCiAgICAgc2V0KFdFQktJVEdUS19BUElfRE9DX1ZFUlNJT04g NC4wKQpkaWZmIC0tZ2l0IGEvVG9vbHMvQ2hhbmdlTG9nIGIvVG9vbHMvQ2hhbmdlTG9nCmluZGV4 IDI0NzI3OTk1M2ZiMjRhNzNkNjhlNTViZWNjZDM4OWM5YTAyYWYwMzAuLmVjMTM2YzViYjA5YzJm OTIwNjg4NTExNWRjM2Y3N2VjMGU2ZTgxYjMgMTAwNjQ0Ci0tLSBhL1Rvb2xzL0NoYW5nZUxvZwor KysgYi9Ub29scy9DaGFuZ2VMb2cKQEAgLTEsMyArMSwxNiBAQAorMjAyMS0wNy0yMyAgTWljaGFl bCBDYXRhbnphcm8gIDxtY2F0YW56YXJvQGdub21lLm9yZz4KKworICAgICAgICBbR1RLXSBVc2Ug d2Via2l0Mmd0ay00LjUgZm9yIEdUSyA0IEFQSSB2ZXJzaW9uCisgICAgICAgIGh0dHBzOi8vYnVn cy53ZWJraXQub3JnL3Nob3dfYnVnLmNnaT9pZD0yMjgyNTAKKworICAgICAgICBSZXZpZXdlZCBi eSBOT0JPRFkgKE9PUFMhKS4KKworICAgICAgICAqIFNjcmlwdHMvd2Via2l0cHkvcG9ydC9ndGsu cHk6CisgICAgICAgIChHdGtQb3J0Ll9pc19ndGs0X2J1aWxkKToKKyAgICAgICAgKiBTY3JpcHRz L3dlYmtpdHB5L3BvcnQvZ3RrX3VuaXR0ZXN0LnB5OgorICAgICAgICAoR3RrUG9ydFRlc3QudGVz dF9ndGs0X2V4cGVjdGF0aW9uc19iaW5hcnlfb25seSk6CisgICAgICAgIChHdGtQb3J0VGVzdC50 ZXN0X2d0a19leHBlY3RhdGlvbnNfYm90aF9iaW5hcmllcyk6CisKIDIwMjEtMDctMjMgIFRydWl0 dCBTYXZlbGwgIDx0c2F2ZWxsQGFwcGxlLmNvbT4KIAogICAgICAgICBNaWdyYXRlIGlPUyAxNSBl eHBlY3RhdGlvbnMgdG8gT3BlblNvdXJjZSBhbmQgYnVtcCB2ZXJzaW9uIG51bWJlcnMKZGlmZiAt LWdpdCBhL1Rvb2xzL1NjcmlwdHMvd2Via2l0cHkvcG9ydC9ndGsucHkgYi9Ub29scy9TY3JpcHRz L3dlYmtpdHB5L3BvcnQvZ3RrLnB5CmluZGV4IDg0OTJjMDc2OTY2OWIzNzRlNWNkYmIzMzg1MTNi YjQzODAzNjc1MzUuLmFkNGQ5NjRhZTNkNWY3ODA0ODdhMmVmMTFmZTM5NDE0NGJkMGY4NzAgMTAw NjQ0Ci0tLSBhL1Rvb2xzL1NjcmlwdHMvd2Via2l0cHkvcG9ydC9ndGsucHkKKysrIGIvVG9vbHMv U2NyaXB0cy93ZWJraXRweS9wb3J0L2d0ay5weQpAQCAtMjkwLDcgKzI5MCw3IEBAIGNsYXNzIEd0 a1BvcnQoUG9ydCk6CiAgICAgICAgICAgICBpZiBsZW4oY2FuZGlkYXRlcykgPiAxOgogICAgICAg ICAgICAgICAgIF9sb2cud2FybmluZygiTXVsdGlwbGUgV2ViS2l0MkdUSyBsaWJyYXJpZXMgZm91 bmQuIFNraXBwaW5nIEdUSzQgZGV0ZWN0aW9uLiIpCiAgICAgICAgICAgICAgICAgcmV0dXJuIEZh bHNlCi0gICAgICAgICAgICByZXR1cm4gb3MucGF0aC5iYXNlbmFtZShjYW5kaWRhdGVzWzBdKSA9 PSAnbGlid2Via2l0Mmd0ay01LjAuc28nCisgICAgICAgICAgICByZXR1cm4gb3MucGF0aC5iYXNl bmFtZShjYW5kaWRhdGVzWzBdKSA9PSAnbGlid2Via2l0Mmd0ay00LjUuc28nCiAKICAgICAgICAg ZXhjZXB0ICh3ZWJraXRweS5jb21tb24uc3lzdGVtLmV4ZWN1dGl2ZS5TY3JpcHRFcnJvciwgSU9F cnJvciwgT1NFcnJvcik6CiAgICAgICAgICAgICByZXR1cm4gRmFsc2UKZGlmZiAtLWdpdCBhL1Rv b2xzL1NjcmlwdHMvd2Via2l0cHkvcG9ydC9ndGtfdW5pdHRlc3QucHkgYi9Ub29scy9TY3JpcHRz L3dlYmtpdHB5L3BvcnQvZ3RrX3VuaXR0ZXN0LnB5CmluZGV4IDBkYmMyOWZhY2Y5MmVmY2U4YWUx NmU4OWQxYTQxNTQ5OWZlOTAxZTUuLjY2MGNkZGUyYTRmM2QwZWZhMjBjNWU1ZTVkOTA5MzZhMGI4 NTQwNTggMTAwNjQ0Ci0tLSBhL1Rvb2xzL1NjcmlwdHMvd2Via2l0cHkvcG9ydC9ndGtfdW5pdHRl c3QucHkKKysrIGIvVG9vbHMvU2NyaXB0cy93ZWJraXRweS9wb3J0L2d0a191bml0dGVzdC5weQpA QCAtOTgsNyArOTgsNyBAQCBjbGFzcyBHdGtQb3J0VGVzdChwb3J0X3Rlc3RjYXNlLlBvcnRUZXN0 Q2FzZSk6CiAgICAgZGVmIHRlc3RfZ3RrNF9leHBlY3RhdGlvbnNfYmluYXJ5X29ubHkoc2VsZik6 CiAgICAgICAgIHBvcnQgPSBzZWxmLm1ha2VfcG9ydCgpCiAgICAgICAgIHBvcnQuX2ZpbGVzeXN0 ZW0gPSBNb2NrRmlsZVN5c3RlbSh7Ci0gICAgICAgICAgICAiL21vY2stYnVpbGQvbGliL2xpYndl YmtpdDJndGstNS4wLnNvIjogIiIKKyAgICAgICAgICAgICIvbW9jay1idWlsZC9saWIvbGlid2Vi a2l0Mmd0ay00LjUuc28iOiAiIgogICAgICAgICB9KQogICAgICAgICB3aXRoIE91dHB1dENhcHR1 cmUoKSBhcyBfOgogICAgICAgICAgICAgc2VsZi5hc3NlcnRFcXVhbHMocG9ydC5leHBlY3RhdGlv bnNfZmlsZXMoKSwKQEAgLTEyNSw3ICsxMjUsNyBAQCBjbGFzcyBHdGtQb3J0VGVzdChwb3J0X3Rl c3RjYXNlLlBvcnRUZXN0Q2FzZSk6CiAgICAgICAgIHBvcnQgPSBzZWxmLm1ha2VfcG9ydCgpCiAg ICAgICAgIHBvcnQuX2ZpbGVzeXN0ZW0gPSBNb2NrRmlsZVN5c3RlbSh7CiAgICAgICAgICAgICAi L21vY2stYnVpbGQvbGliL2xpYndlYmtpdDJndGstNC4wLnNvIjogIiIsCi0gICAgICAgICAgICAi L21vY2stYnVpbGQvbGliL2xpYndlYmtpdDJndGstNS4wLnNvIjogIiIKKyAgICAgICAgICAgICIv bW9jay1idWlsZC9saWIvbGlid2Via2l0Mmd0ay00LjUuc28iOiAiIgogICAgICAgICB9KQogCiAg ICAgICAgIHdpdGggT3V0cHV0Q2FwdHVyZSgpIGFzIGNhcHR1cmVkOgpkaWZmIC0tZ2l0IGEvQ2hh bmdlTG9nIGIvQ2hhbmdlTG9nCmluZGV4IGM2ZDkwZTlkNzY4YWJmNWFjNWZkMThiNWNiYzQ2ZmU3 OGEwZjU0NGMuLmM2ZWVjMGRiYTU5MjE2M2UyZTA4YTBlOTA4ZWQyOTUxYTMwNjAzNmUgMTAwNjQ0 Ci0tLSBhL0NoYW5nZUxvZworKysgYi9DaGFuZ2VMb2cKQEAgLTEsMyArMSwxMiBAQAorMjAyMS0w Ny0yMyAgTWljaGFlbCBDYXRhbnphcm8gIDxtY2F0YW56YXJvQGdub21lLm9yZz4KKworICAgICAg ICBbR1RLXSBVc2Ugd2Via2l0Mmd0ay00LjUgZm9yIEdUSyA0IEFQSSB2ZXJzaW9uCisgICAgICAg IGh0dHBzOi8vYnVncy53ZWJraXQub3JnL3Nob3dfYnVnLmNnaT9pZD0yMjgyNTAKKworICAgICAg ICBSZXZpZXdlZCBieSBOT0JPRFkgKE9PUFMhKS4KKworICAgICAgICAqIFNvdXJjZS9jbWFrZS9P cHRpb25zR1RLLmNtYWtlOgorCiAyMDIxLTA3LTIzICBQaGlsaXBwZSBOb3JtYW5kICA8cG5vcm1h bmRAaWdhbGlhLmNvbT4KIAogICAgICAgICBbR0xpYl0gUmVtb3ZlIGxpYnBvcnRhbCBkZXBlbmRl bmN5Cg==