Bug 238868 - [GTK] Turning on the address sanitizer should disable GIR and documentation
Summary: [GTK] Turning on the address sanitizer should disable GIR and documentation
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Tools / Tests (show other bugs)
Version: WebKit Nightly Build
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: Martin Robinson
URL:
Keywords: InRadar
Depends on:
Blocks:
 
Reported: 2022-04-06 08:10 PDT by Martin Robinson
Modified: 2022-04-07 03:59 PDT (History)
8 users (show)

See Also:


Attachments
Patch (2.34 KB, patch)
2022-04-06 08:42 PDT, Martin Robinson
no flags Details | Formatted Diff | Diff
Patch (1.96 KB, patch)
2022-04-07 00:48 PDT, Martin Robinson
no flags Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Robinson 2022-04-06 08:10:37 PDT
GIR isn't compatible with the flags passed for address sanitation and documentation depends on GIR.
Comment 1 Martin Robinson 2022-04-06 08:42:42 PDT
Created attachment 456822 [details]
Patch
Comment 2 Adrian Perez 2022-04-06 10:04:13 PDT
Comment on attachment 456822 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=456822&action=review

> Source/cmake/OptionsGTK.cmake:286
> +# FIXME: Does the new documentation toolchain work on Mac now?

Do we have any evidence that it does not work in MacOS? TBH, I think the
if(APPLE) conditional is unnecessary. It's not like MacOS is particularly
well supported, and people packaging for such an environment (e.g. MacPorts)
sure can decide themselves if they want to disable documentation or not.

FWIW, there is nothing particularly special about gi-docgen: it's a pure
Python program, so as long as g-ir-scanner can create a .gir file, it will
work fine.

Also, this is unrelated to sanitizers, so one more reason to leave this
part out od this patch.
Comment 3 Martin Robinson 2022-04-06 10:05:49 PDT
(In reply to Adrian Perez from comment #2)
ork fine.
> 
> Also, this is unrelated to sanitizers, so one more reason to leave this
> part out od this patch.

I'm just maintaining this existing behavior. I think someone should double-check that the new documentation tool works on Mac before turning it back on.
Comment 4 Martin Robinson 2022-04-07 00:47:27 PDT
(In reply to Martin Robinson from comment #3)
> (In reply to Adrian Perez from comment #2)
> ork fine.
> > 
> > Also, this is unrelated to sanitizers, so one more reason to leave this
> > part out od this patch.
> 
> I'm just maintaining this existing behavior. I think someone should
> double-check that the new documentation tool works on Mac before turning it
> back on.

That said, I don't want to block this patch. I have uploaded a new version that maintains the broken line which tries to disable documentation when building on Mac.
Comment 5 Martin Robinson 2022-04-07 00:48:29 PDT
Created attachment 456898 [details]
Patch
Comment 6 Martin Robinson 2022-04-07 01:41:58 PDT
Comment on attachment 456898 [details]
Patch

Thanks for the review!
Comment 7 EWS 2022-04-07 03:58:44 PDT
Committed r292528 (249366@main): <https://commits.webkit.org/249366@main>

All reviewed patches have been landed. Closing bug and clearing flags on attachment 456898 [details].
Comment 8 Radar WebKit Bug Importer 2022-04-07 03:59:16 PDT
<rdar://problem/91406165>