Bug 65178 – [GTK] Rename WebKit2 GTK+ API main header as webkit2.h

• Status: RESOLVED
• Resolution: FIXED
• Component: WebKit2

[Carlos Garcia Campos]

We were using webkit/webkit.h header for webkit2, because we were trying to use the exactly same webkit1 api. Now that we have decided it was not a good idea, rename it as WebKit2Gtk.h and move it to the main include dir so that it will be included as <WebKit2/WebKit2Gtk.h> like the other webkit2 headers.

[Carlos Garcia Campos]

Created attachment 101993 [details]
Patch

[Carlos Garcia Campos]

Created attachment 101996 [details]
Patch

Fixed changelog entries, I removed the 'Reviewed by' line by mistake.

[Martin Robinson]

Won't this mean the installed header will be WebKit2/WebKit2Gtk.h? Wouldn't it make more sense to install it to a place like webkit2/webkit.h or webkit2/webkit2.h, since GLib headers are usually lower-case?

[Carlos Garcia Campos]

(In reply to comment #3)
> Won't this mean the installed header will be WebKit2/WebKit2Gtk.h? Wouldn't it make more sense to install it to a place like webkit2/webkit.h or webkit2/webkit2.h, since GLib headers are usually lower-case?

Yes, but C API main header is WebKit2/WebKit2.h, so I used WebKit2/WebKit2Gtk.h to avoid problems with non-case sensitive file systems and for consistency with the C API.

[Carlos Garcia Campos]

Created attachment 107033 [details]
New patch

This is a new patch following the headers reorganization proposed in bug #65616.

[Carlos Garcia Campos]

Created attachment 108468 [details]
New patch to use <webkit2/webkit2gtk.h>

[Carlos Garcia Campos]

This patch doesn't apply because it depends on bug #65616. Note also that this patch breaks all other bugs depending on this, I'll update all other patches if we agree on this approach.

[Carlos Garcia Campos]

Created attachment 108806 [details]
New patch to use <webkit2/webkit2.h>

[WebKit Review Bot]

Attachment 108806 [details] did not pass style-queue:

Failed to run "['Tools/Scripts/check-webkit-style', '--diff-files', u'Source/WebKit2/ChangeLog', u'Source/WebKit..." exit_code: 1

Source/WebKit2/UIProcess/API/gtk/webkit2.h:20:  #ifndef header guard has wrong style, please use: webkit2_h  [build/header_guard] [5]
Source/WebKit2/UIProcess/API/gtk/webkit2.h:24:  Alphabetical sorting problem.  [build/include_order] [4]
Total errors found: 2 in 8 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Carlos Garcia Campos]

Created attachment 108815 [details]
Updated patch to use a symlink

Use a symlink instead of copying the headers as suggested by Martin.

[WebKit Review Bot]

Attachment 108815 [details] did not pass style-queue:

Failed to run "['Tools/Scripts/check-webkit-style', '--diff-files', u'Source/WebKit2/ChangeLog', u'Source/WebKit..." exit_code: 1

Source/WebKit2/UIProcess/API/gtk/webkit2.h:20:  #ifndef header guard has wrong style, please use: webkit2_h  [build/header_guard] [5]
Source/WebKit2/UIProcess/API/gtk/webkit2.h:24:  Alphabetical sorting problem.  [build/include_order] [4]
Total errors found: 2 in 8 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Carlos Garcia Campos]

(In reply to comment #10)
> Created an attachment (id=108815) [details]
> Updated patch to use a symlink
> 
> Use a symlink instead of copying the headers as suggested by Martin.

I've just realized this won't work. Some generated files like marshalers and enum types need to be copied there too, with the symlink they will end up in the sources dir instead of build dir.

[Carlos Garcia Campos]

Committed r96121: <http://trac.webkit.org/changeset/96121>