Bug 65178 - [GTK] Rename WebKit2 GTK+ API main header as webkit2.h
Summary: [GTK] Rename WebKit2 GTK+ API main header as webkit2.h
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: WebKit2 (show other bugs)
Version: 528+ (Nightly build)
Hardware: PC Linux
: P2 Normal
Assignee: Nobody
URL:
Keywords: Gtk
Depends on: 65616
Blocks: 67931
  Show dependency treegraph
 
Reported: 2011-07-26 06:06 PDT by Carlos Garcia Campos
Modified: 2011-09-27 09:39 PDT (History)
6 users (show)

See Also:


Attachments
Patch (7.10 KB, patch)
2011-07-26 06:10 PDT, Carlos Garcia Campos
no flags Details | Formatted Diff | Diff
Patch (7.18 KB, patch)
2011-07-26 06:41 PDT, Carlos Garcia Campos
no flags Details | Formatted Diff | Diff
New patch (9.33 KB, patch)
2011-09-12 02:52 PDT, Carlos Garcia Campos
no flags Details | Formatted Diff | Diff
New patch to use <webkit2/webkit2gtk.h> (8.98 KB, patch)
2011-09-23 06:06 PDT, Carlos Garcia Campos
no flags Details | Formatted Diff | Diff
New patch to use <webkit2/webkit2.h> (8.97 KB, patch)
2011-09-27 00:52 PDT, Carlos Garcia Campos
no flags Details | Formatted Diff | Diff
Updated patch to use a symlink (8.71 KB, patch)
2011-09-27 02:08 PDT, Carlos Garcia Campos
mrobinson: review+
Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Carlos Garcia Campos 2011-07-26 06:06:59 PDT
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.
Comment 1 Carlos Garcia Campos 2011-07-26 06:10:05 PDT
Created attachment 101993 [details]
Patch
Comment 2 Carlos Garcia Campos 2011-07-26 06:41:38 PDT
Created attachment 101996 [details]
Patch

Fixed changelog entries, I removed the 'Reviewed by' line by mistake.
Comment 3 Martin Robinson 2011-07-26 07:01:08 PDT
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?
Comment 4 Carlos Garcia Campos 2011-08-02 06:17:44 PDT
(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.
Comment 5 Carlos Garcia Campos 2011-09-12 02:52:27 PDT
Created attachment 107033 [details]
New patch

This is a new patch following the headers reorganization proposed in bug #65616.
Comment 6 Carlos Garcia Campos 2011-09-23 06:06:09 PDT
Created attachment 108468 [details]
New patch to use <webkit2/webkit2gtk.h>
Comment 7 Carlos Garcia Campos 2011-09-23 06:11:50 PDT
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.
Comment 8 Carlos Garcia Campos 2011-09-27 00:52:40 PDT
Created attachment 108806 [details]
New patch to use <webkit2/webkit2.h>
Comment 9 WebKit Review Bot 2011-09-27 00:56:07 PDT
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.
Comment 10 Carlos Garcia Campos 2011-09-27 02:08:11 PDT
Created attachment 108815 [details]
Updated patch to use a symlink

Use a symlink instead of copying the headers as suggested by Martin.
Comment 11 WebKit Review Bot 2011-09-27 02:11:21 PDT
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.
Comment 12 Carlos Garcia Campos 2011-09-27 05:26:47 PDT
(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.
Comment 13 Carlos Garcia Campos 2011-09-27 09:39:13 PDT
Committed r96121: <http://trac.webkit.org/changeset/96121>