Title: [168591] trunk
Revision
168591
Author
[email protected]
Date
2014-05-10 19:14:09 -0700 (Sat, 10 May 2014)

Log Message

[GTK][CMake] Unable to do make install
https://bugs.webkit.org/show_bug.cgi?id=130188

Reviewed by Carlos Garcia Campos.

Only try to install the HTML documentation if the build is configured to generate it via
the new ENABLE_GTKDOC option. We cannot conditionally install something, so this allows us
to keep the HTML documentation directory as an installation source.

* Source/PlatformGTK.cmake: The gtkdoc target now always builds HTML documentation, but
is only added to the default target when ENABLE_GTKDOC is turned on. gtkdoc-no-html is
now only added to the default target when DEVELOPER_MODE is true and ENABLE_GTKDOC is
false. When both ENABLE_GTKDOC and DEVELOPER_MODE are false, documentation isn't built at all.
* Source/cmake/OptionsGTK.cmake: Add an ENABLE_GTKDOC option to the build.

Modified Paths

Diff

Modified: trunk/ChangeLog (168590 => 168591)


--- trunk/ChangeLog	2014-05-11 01:35:08 UTC (rev 168590)
+++ trunk/ChangeLog	2014-05-11 02:14:09 UTC (rev 168591)
@@ -1,3 +1,20 @@
+2014-05-10  Martin Robinson  <[email protected]>
+
+        [GTK][CMake] Unable to do make install
+        https://bugs.webkit.org/show_bug.cgi?id=130188
+
+        Reviewed by Carlos Garcia Campos.
+
+        Only try to install the HTML documentation if the build is configured to generate it via
+        the new ENABLE_GTKDOC option. We cannot conditionally install something, so this allows us
+        to keep the HTML documentation directory as an installation source.
+
+        * Source/PlatformGTK.cmake: The gtkdoc target now always builds HTML documentation, but
+        is only added to the default target when ENABLE_GTKDOC is turned on. gtkdoc-no-html is
+        now only added to the default target when DEVELOPER_MODE is true and ENABLE_GTKDOC is
+        false. When both ENABLE_GTKDOC and DEVELOPER_MODE are false, documentation isn't built at all.
+        * Source/cmake/OptionsGTK.cmake: Add an ENABLE_GTKDOC option to the build.
+
 2014-05-09  Anders Carlsson  <[email protected]>
 
         Rename WebKit2.framework to WebKit.framework

Modified: trunk/Source/PlatformGTK.cmake (168590 => 168591)


--- trunk/Source/PlatformGTK.cmake	2014-05-11 01:35:08 UTC (rev 168590)
+++ trunk/Source/PlatformGTK.cmake	2014-05-11 02:14:09 UTC (rev 168591)
@@ -9,6 +9,9 @@
         "${CMAKE_SOURCE_DIR}/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml"
         "${CMAKE_SOURCE_DIR}/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt"
     )
+endif ()
+
+if (ENABLE_GTKDOC)
     install(DIRECTORY ${CMAKE_BINARY_DIR}/Documentation/webkit2gtk/html/
             DESTINATION ${CMAKE_INSTALL_DATADIR}/gtk-doc/html/webkit2gtk
     )
@@ -24,16 +27,21 @@
     )
 endmacro()
 
-add_gtkdoc_generator("docs-build-no-html.stamp" "--skip-html")
-add_custom_target(gtkdoc-no-html ALL
-    DEPENDS "${CMAKE_BINARY_DIR}/docs-build-no-html.stamp"
-)
-
 add_gtkdoc_generator("docs-build.stamp" "")
-add_custom_target(gtkdoc
-    DEPENDS "${CMAKE_BINARY_DIR}/docs-build.stamp"
-)
+if (ENABLE_GTKDOC)
+    add_custom_target(gtkdoc ALL DEPENDS "${CMAKE_BINARY_DIR}/docs-build.stamp")
+else ()
+    add_custom_target(gtkdoc DEPENDS "${CMAKE_BINARY_DIR}/docs-build.stamp")
 
+    # Add a default build step which check that documentation does not have any warnings
+    # or errors. This is useful to prevent breaking documentation inadvertently during
+    # the course of development.
+    if (DEVELOPER_MODE)
+        add_gtkdoc_generator("docs-build-no-html.stamp" "--skip-html")
+        add_custom_target(gtkdoc-no-html ALL DEPENDS "${CMAKE_BINARY_DIR}/docs-build-no-html.stamp")
+    endif ()
+endif ()
+
 add_custom_target(check
     COMMAND ${TOOLS_DIR}/Scripts/run-gtk-tests
     COMMAND ${TOOLS_DIR}/gtk/check-for-webkitdom-api-breaks

Modified: trunk/Source/cmake/OptionsGTK.cmake (168590 => 168591)


--- trunk/Source/cmake/OptionsGTK.cmake	2014-05-11 01:35:08 UTC (rev 168590)
+++ trunk/Source/cmake/OptionsGTK.cmake	2014-05-11 02:14:09 UTC (rev 168591)
@@ -17,6 +17,7 @@
 CALCULATE_LIBRARY_VERSIONS_FROM_LIBTOOL_TRIPLE(_javascript_CORE 16 2 16)
 
 set(ENABLE_CREDENTIAL_STORAGE ON CACHE BOOL "Whether or not to enable support for credential storage using libsecret.")
+set(ENABLE_GTKDOC OFF CACHE BOOL "Whether or not to use generate gtkdoc.")
 
 # FIXME: We want to expose fewer options to downstream, but for now everything is public.
 WEBKIT_OPTION_BEGIN()
_______________________________________________
webkit-changes mailing list
[email protected]
https://lists.webkit.org/mailman/listinfo/webkit-changes

Reply via email to