Bug 77542 – [GTK] WebKit1 API documentation is not generated when building with gtk-2.0

• Status: RESOLVED
• Resolution: WONTFIX
• Component: Tools / Tests

[Carlos Garcia Campos]

Tools/gtk/generate-gtkdoc assumes gtk3 is always used and creates a generator for webkit2gtk-3.0.pc

[Carlos Garcia Campos]

Created attachment 124926 [details]
Patch

[Gustavo Noronha (kov)]

Comment on attachment 124926 [details]
Patch

That reminds me I had to fix the doc build for the debian package but hadn't taken the time yet to upload the patch. Here's what I have fwiw. The common.py part is required because the debian package builds in a directory called build-x.y (where x.y is 2.0 for the gtk2-based library and 3.0 for gtk3-based one).


diff --git a/Tools/gtk/common.py b/Tools/gtk/common.py
index 7941e13..59f1aec 100644
--- a/Tools/gtk/common.py
+++ b/Tools/gtk/common.py
@@ -64,6 +64,10 @@ def get_build_path():
     if is_valid_build_directory(build_dir):
         return build_dir
 
+    build_dir = os.getcwd()
+    if is_valid_build_directory(build_dir):
+        return build_dir
+
     print 'Could not determine build directory.'
     sys.exit(1)
 
diff --git a/Tools/gtk/generate-gtkdoc b/Tools/gtk/generate-gtkdoc
index db5f83a..6b48f46 100755
--- a/Tools/gtk/generate-gtkdoc
+++ b/Tools/gtk/generate-gtkdoc
@@ -83,7 +83,11 @@ def get_webkit1_options():
                    ' -I' + common.top_level_path('Source', 'JavaScriptCore', 'ForwardingHeaders'),
         'ignored_files': glob.glob(src_path('webkit', '*private.*'))
     })
-    return (common.build_path('Source', 'WebKit', 'gtk', 'webkitgtk-3.0.pc'), options)
+
+    if os.path.exists(common.build_path('Source', 'WebKit', 'gtk', 'webkitgtk-3.0.pc')):
+        return (common.build_path('Source', 'WebKit', 'gtk', 'webkitgtk-3.0.pc'), options)
+
+    return (common.build_path('Source', 'WebKit', 'gtk', 'webkit-1.0.pc'), options)
 
 configure_logging()

[Carlos Garcia Campos]

Committed r106474: <http://trac.webkit.org/changeset/106474>

[Gustavo Noronha (kov)]

Looks like this hasn't fixed the issue, seb128 reported on IRC that the package build for 1.7.5 failed because of no documentation built for the gtk2-based library. The second part of the alternative patch I posted in comment 2 was working for us in 1.7.4. Here's the log:

https://launchpadlibrarian.net/92255948/buildlog_ubuntu-precise-i386.webkit_1.7.5-0ubuntu1~build3_FAILEDTOBUILD.txt.gz

[Gustavo Noronha (kov)]

I posted the first patch of my patch to a separate bug, btw: https://bugs.webkit.org/show_bug.cgi?id=78118

[Eric Seidel (no email)]

Attachment 124926 [details] was posted by a committer and has review+, assigning to Carlos Garcia Campos for commit.

[Martin Robinson]

WebKit1GTK+ has been removed.