<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://bugs.webkit.org/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.4.1"
          urlbase="https://bugs.webkit.org/"
          
          maintainer="admin@webkit.org"
>

    <bug>
          <bug_id>198521</bug_id>
          
          <creation_ts>2019-06-04 02:27:24 -0700</creation_ts>
          <short_desc>[GTK] Documentation is built even when setting says it is off</short_desc>
          <delta_ts>2019-06-04 06:36:14 -0700</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>1</classification_id>
          <classification>Unclassified</classification>
          <product>WebKit</product>
          <component>WebKitGTK</component>
          <version>WebKit Local Build</version>
          <rep_platform>Unspecified</rep_platform>
          <op_sys>Unspecified</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>WONTFIX</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>P2</priority>
          <bug_severity>Normal</bug_severity>
          <target_milestone>---</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Xabier Rodríguez Calvar">calvaris</reporter>
          <assigned_to name="Nobody">webkit-unassigned</assigned_to>
          <cc>bugs-noreply</cc>
    
    <cc>cgarcia</cc>
    
    <cc>mcatanzaro</cc>
          

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>1541489</commentid>
    <comment_count>0</comment_count>
    <who name="Xabier Rodríguez Calvar">calvaris</who>
    <bug_when>2019-06-04 02:27:24 -0700</bug_when>
    <thetext>...
--  ENABLE_GTKDOC                            OFF
...
--  ENABLE_INTROSPECTION                     OFF
...
[6148/6200] Generating ../docs-build-no-html.stamp</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>1541525</commentid>
    <comment_count>1</comment_count>
    <who name="Michael Catanzaro">mcatanzaro</who>
    <bug_when>2019-06-04 05:22:03 -0700</bug_when>
    <thetext>That&apos;s the test target for ENABLE_DEVELOPER_MODE which checks that the docs can be built but skips HTML output generation. If you don&apos;t want it to use gtkdoc at all, then you should not use developer mode.

ADD_GTKDOC_GENERATOR(&quot;docs-build.stamp&quot; &quot;--gtk&quot;)
if (ENABLE_GTKDOC)
    add_custom_target(gtkdoc ALL DEPENDS &quot;${CMAKE_BINARY_DIR}/docs-build.stamp&quot;)
elseif (NOT ENABLED_COMPILER_SANITIZERS AND NOT CMAKE_CROSSCOMPILING AND NOT APPLE)
    add_custom_target(gtkdoc DEPENDS &quot;${CMAKE_BINARY_DIR}/docs-build.stamp&quot;)

    # 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(&quot;docs-build-no-html.stamp&quot; &quot;--gtk;--skip-html&quot;)
        add_custom_target(gtkdoc-no-html ALL DEPENDS &quot;${CMAKE_BINARY_DIR}/docs-build-no-html.stamp&quot;)
    endif ()
endif ()</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>1541529</commentid>
    <comment_count>2</comment_count>
    <who name="Xabier Rodríguez Calvar">calvaris</who>
    <bug_when>2019-06-04 05:59:50 -0700</bug_when>
    <thetext>What&apos;s the rationale behind this? Even in developer mode, it is very confusing to deactivate something and getting it anyway.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>1541532</commentid>
    <comment_count>3</comment_count>
    <who name="Carlos Garcia Campos">cgarcia</who>
    <bug_when>2019-06-04 06:08:56 -0700</bug_when>
    <thetext>Docs are not generated (there&apos;s no generated html documentation), but gtk-doc is used to check there aren&apos;t errors in documentation like undocumented symbols. It could be renamed to ENABLE_API_DOCUMENTATION for example, if that&apos;s clearer.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>1541537</commentid>
    <comment_count>4</comment_count>
    <who name="Michael Catanzaro">mcatanzaro</who>
    <bug_when>2019-06-04 06:36:14 -0700</bug_when>
    <thetext>(In reply to Xabier Rodríguez Calvar from comment #2)
&gt; What&apos;s the rationale behind this?

Before we added this, developers who built with gtkdoc disabled kept breaking the docs build. :)</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>