⚠ Archived content — this site is no longer maintained.   Current WebKit documentation is at docs.webkit.org.

Changeset 101174 in webkit


Ignore:
Timestamp:
Nov 25, 2011, 8:19:44 AM (15 years ago)
Author:
Martin Robinson
Message:

[GTK] Integrate build-gtkdoc into build-webkit and make
​https://bugs.webkit.org/show_bug.cgi?id=72626

Reviewed by Philippe Normand.

.:

  • GNUmakefile.am: Remove references to old gtkdoc files. Update

the dist-hook to include copying documentation into the distribution.
This also means that the build will fail if documentation hasn't been
generated before 'make dist.'

  • configure.ac: Ditto.

Source/WebKit/gtk:

  • docs/GNUmakefile.am: Removed.
  • docs/version.xml.in: Removed.

Source/WebKit2:

  • GNUmakefile.am: Removed references to build-gtkdoc and gtkdoc.py.
  • UIProcess/API/gtk/docs/build-gtkdoc: Removed.

Tools:

  • GNUmakefile.am: Added support for new scripts and "make docs".
  • Scripts/webkitdirs.pm: Call generate-gtkdoc when building.

(buildAutotoolsProject):

  • gtk/generate-gtkdoc: Added.
  • gtk/gtkdoc.py: Renamed from Source/WebKit2/UIProcess/API/gtk/docs/gtkdoc.py.
Location:
trunk
Files:
3 added
4 deleted
10 edited
1 moved

Legend:

Unmodified
Added
Removed

  • trunk/ChangeLog

    r101089 r101174  
     12011-11-17  Martin Robinson  <mrobinson@igalia.com>
     2
     3        [GTK] Integrate build-gtkdoc into build-webkit and make
     4        https://bugs.webkit.org/show_bug.cgi?id=72626
     5
     6        Reviewed by Philippe Normand.
     7
     8        * GNUmakefile.am: Remove references to old gtkdoc files. Update
     9        the dist-hook to include copying documentation into the distribution.
     10        This also means that the build will fail if documentation hasn't been
     11        generated before 'make dist.'
     12        * configure.ac: Ditto.
     13
    1142011-11-23  Tor Arne Vestbø  <tor.arne.vestbo@nokia.com>
    215

  • trunk/GNUmakefile.am

    r98498 r101174  
    208208include Tools/GNUmakefile.am
    209209include Source/WebKit/gtk/po/GNUmakefile.am
    210 include Source/WebKit/gtk/docs/GNUmakefile.am
    211210include Tools/DumpRenderTree/gtk/GNUmakefile.ImageDiff.am
    212211
    … …  
    266265distclean-local:
    267266        -rm -rf $(GENSOURCES) $(GENPROGRAMS)
     267
     268dist-hook: doc-dist-hook
     269doc-dist-hook: docs-build.stamp
     270        cp $(WebKit)/NEWS $(distdir)
     271        @mkdir -p $(distdir)/Documentation/webkitgtk/html
     272        @mkdir -p $(distdir)/Documentation/webkitgtk/tmpl
     273        @-cp ./Documentation/webkitgtk/tmpl/*.sgml $(distdir)/Documentation/webkitgtk/tmpl
     274        @cp ./Documentation/webkitgtk/html/* $(distdir)/Documentation/webkitgtk/html
     275if ENABLE_WEBKIT2
     276        @mkdir -p $(distdir)/Documentation/webkit2gtk/html
     277        @mkdir -p $(distdir)/Documentation/webkit2gtk/tmpl
     278        @-cp ./Documentation/webkit2gtk/tmpl/*.sgml $(distdir)/Documentation/webkit2gtk/tmpl
     279        @cp ./Documentation/webkit2gtk/html/* $(distdir)/Documentation/webkit2gtk/html
     280endif

  • trunk/Source/WebKit/gtk/ChangeLog

    r101049 r101174  
     12011-11-17  Martin Robinson  <mrobinson@igalia.com>
     2
     3        [GTK] Integrate build-gtkdoc into build-webkit and make
     4        https://bugs.webkit.org/show_bug.cgi?id=72626
     5
     6        Reviewed by Philippe Normand.
     7
     8        * docs/GNUmakefile.am: Removed.
     9        * docs/version.xml.in: Removed.
     10
    1112011-11-23  Kaustubh Atrawalkar  <kaustubh@motorola.com>
    212

  • trunk/Source/WebKit/gtk/GNUmakefile.am

    r98554 r101174  
    385385        $(WebKit)/ChangeLog \
    386386        $(WebKit)/NEWS \
     387        $(WebKit)/docs/webkitgtk-docs.sgml \
     388        $(WebKit)/docs/webkitgtk-sections.txt \
     389        $(WebKit)/docs/webkitgtk.types \
     390        $(WebKit)/docs/webkitenvironment.xml \
     391        $(WebKit)/docs/webkitgtk-overrides.txt \
    387392        $(WebKit)/webkitmarshal.list \
    388         $(WebKit)/GNUmakefile.gtk-doc.am \
    389393        $(WebKit)/po/* \
    390394        $(WebKit)/resources/* \
    … …  
    594598        $(top_builddir)/Source/WebKit/gtk/webkit/webkitversion.h
    595599
    596 dist-hook:
    597         cp $(WebKit)/NEWS $(distdir)
    598600install-data-local: po-install-data-local
    599601installdirs-data-local: po-installdirs-data-local

  • trunk/Source/WebKit2/ChangeLog

    r101167 r101174  
     12011-11-17  Martin Robinson  <mrobinson@igalia.com>
     2
     3        [GTK] Integrate build-gtkdoc into build-webkit and make
     4        https://bugs.webkit.org/show_bug.cgi?id=72626
     5
     6        Reviewed by Philippe Normand.
     7
     8        * GNUmakefile.am: Removed references to build-gtkdoc and gtkdoc.py.
     9        * UIProcess/API/gtk/docs/build-gtkdoc: Removed.
     10
    1112011-11-25  Kenneth Rohde Christiansen  <kenneth@webkit.org>
    212

  • trunk/Source/WebKit2/GNUmakefile.am

    r100893 r101174  
    14041404
    14051405EXTRA_DIST += \
    1406         $(WebKit2)/UIProcess/API/gtk/docs/build-gtkdoc \
    1407         $(WebKit2)/UIProcess/API/gtk/docs/gtkdoc.py \
    14081406        $(WebKit2)/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml \
    14091407        $(WebKit2)/UIProcess/API/gtk/docs/webkit2gtk-sections.txt \

  • trunk/Tools/ChangeLog

    r101169 r101174  
     12011-11-17  Martin Robinson  <mrobinson@igalia.com>
     2
     3        [GTK] Integrate build-gtkdoc into build-webkit and make
     4        https://bugs.webkit.org/show_bug.cgi?id=72626
     5
     6        Reviewed by Philippe Normand.
     7
     8        * GNUmakefile.am: Added support for new scripts and "make docs".
     9        * Scripts/webkitdirs.pm: Call generate-gtkdoc when building.
     10        (buildAutotoolsProject):
     11        * gtk/generate-gtkdoc: Added.
     12        * gtk/gtkdoc.py: Renamed from Source/WebKit2/UIProcess/API/gtk/docs/gtkdoc.py.
     13
    1142011-11-25  Ádám Kallai  <Kallai.Adam@stud.u-szeged.hu>
    215

  • trunk/Tools/GNUmakefile.am

    r99852 r101174  
    228228CLEANFILES += TestNetscapePlugin/libtestnetscapeplugin.la
    229229endif
     230
     231EXTRA_DIST += \
     232        Tools/gtk/common.py \
     233        Tools/gtk/generate-gtkdoc \
     234        Tools/gtk/gtkdoc.py \
     235        Tools/Scripts/VCSUtils.pm \
     236        Tools/Scripts/webkit-build-directory \
     237        Tools/Scripts/webkitdirs.pm
     238
     239docs: docs-build.stamp
     240.PHONY : docs
     241DISTCLEANFILES += docs-build.stamp
     242
     243if ENABLE_WEBKIT2
     244docs-build.stamp: \
     245        $(BUILT_SOURCES) \
     246        Source/WebKit/gtk/docs/webkitenvironment.xml \
     247        Source/WebKit/gtk/docs/webkitgtk-docs.sgml \
     248        Source/WebKit/gtk/docs/webkitgtk-sections.txt \
     249        libwebkitgtk-@WEBKITGTK_API_MAJOR_VERSION@.@WEBKITGTK_API_MINOR_VERSION@.la \
     250        libwebkit2gtk-@WEBKITGTK_API_MAJOR_VERSION@.@WEBKITGTK_API_MINOR_VERSION@.la \
     251        Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml \
     252        Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt
     253        $(srcdir)/Tools/gtk/generate-gtkdoc
     254        @touch docs-build.stamp
     255else
     256docs-build.stamp: \
     257        $(BUILT_SOURCES) \
     258        libwebkitgtk-@WEBKITGTK_API_MAJOR_VERSION@.@WEBKITGTK_API_MINOR_VERSION@.la \
     259        Source/WebKit/gtk/docs/webkitenvironment.xml \
     260        Source/WebKit/gtk/docs/webkitgtk-docs.sgml \
     261        Source/WebKit/gtk/docs/webkitgtk-sections.txt
     262        $(srcdir)/Tools/gtk/generate-gtkdoc
     263        @touch docs-build.stamp
     264endif
     265
     266clean-local: doc-clean-local
     267doc-clean-local:
     268        @rm -f Documentation/webkitgtk/*~ Documentation/webkitgtk*.bak
     269        @rm -f Documentation/webkit2gtk/*~ Documentation/webkit2gtk*.bak
     270distclean-local: doc-distclean-local
     271doc-distclean-local:
     272        @rm -rf Documentation
     273maintainer-clean-local: doc-maintainer-clean-local
     274doc-maintainer-clean-local: clean
     275        @rm -rf Documentation/webkitgtk Documentation/webkit2gtk
     276        -@rmdir Documentation
     277
     278if ENABLE_GTK_DOC
     279all: docs-build.stamp
     280endif
     281

  • trunk/Tools/Scripts/webkitdirs.pm

    r101052 r101174  
    16801680
    16811681    chdir ".." or die;
     1682
     1683    if (isGtk()) {
     1684        my $relativeScriptsPath = relativeScriptsDir();
     1685        if (system("$relativeScriptsPath/../gtk/generate-gtkdoc --skip-html")) {
     1686            die "\n gtkdoc did not build without warnings\n";
     1687        }
     1688    }
     1689
    16821690    return 0;
    16831691}

  • trunk/Tools/gtk/gtkdoc.py

    r101173 r101174  
    1 #  Copyright (C) 2011 Igalia S.L.
     1# Copyright (C) 2011 Igalia S.L.
    22#
    3 #  This library is free software; you can redistribute it and/or
    4 #  modify it under the terms of the GNU Lesser General Public
    5 #  License as published by the Free Software Foundation; either
    6 #  version 2 of the License, or (at your option) any later version.
     3# This library is free software; you can redistribute it and/or
     4# modify it under the terms of the GNU Lesser General Public
     5# License as published by the Free Software Foundation; either
     6# version 2 of the License, or (at your option) any later version.
    77#
    8 #  This library is distributed in the hope that it will be useful,
    9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
    10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    11 #  Lesser General Public License for more details.
     8# This library is distributed in the hope that it will be useful,
     9# but WITHOUT ANY WARRANTY; without even the implied warranty of
     10# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     11# Lesser General Public License for more details.
    1212#
    13 #  You should have received a copy of the GNU Lesser General Public
    14 #  License along with this library; if not, write to the Free Software
    15 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
    16 #
     13# You should have received a copy of the GNU Lesser General Public
     14# License along with this library; if not, write to the Free Software
     15# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
    1716
    1817import errno
    … …  
    171170        return answer == 'y'
    172171
    173     def _run_command(self, args, env=None, cwd=None, print_output=True):
    174         self.logger.info("Running %s", args[0])
     172    def _run_command(self, args, env=None, cwd=None, print_output=True, ignore_warnings=False):
     173        if print_output:
     174            self.logger.info("Running %s", args[0])
    175175        self.logger.debug("Full command args: %s", str(args))
    176176
    … …  
    190190                             % (args[0], process.returncode))
    191191
    192         if 'warning' in stderr or 'warning' in stdout:
     192        if not ignore_warnings and ('warning' in stderr or 'warning' in stdout):
    193193            self.saw_warnings = True
    194194            if not self._ask_yes_or_no_question('%s produced warnings, '
    … …  
    284284        if self.library_path:
    285285            ldflags = ' "-L%s" ' % self.library_path + ldflags
    286             env['RUN'] = 'LD_LIBRARY_PATH="%s" ' % self.library_path
     286            current_ld_library_path = env.get('LD_LIBRARY_PATH')
     287            if current_ld_library_path:
     288                env['RUN'] = 'LD_LIBRARY_PATH="%s:%s" ' % (self.library_path, current_ld_library_path)
     289            else:
     290                env['RUN'] = 'LD_LIBRARY_PATH="%s" ' % self.library_path
     291
    287292        if ldflags:
    288293            env['LDFLAGS'] = ldflags
    … …  
    339344                           '--module-dir=html',
    340345                           '--html-dir=html'],
    341                           cwd=self.output_dir)
     346                          cwd=self.output_dir,
     347                          ignore_warnings=True)
    342348
    343349

  • trunk/configure.ac

    r101060 r101174  
    12101210AC_CONFIG_FILES([
    12111211Source/WebKit/gtk/webkit/webkitversion.h
    1212 Documentation/version.xml:Source/WebKit/gtk/docs/version.xml.in
    12131212])
    12141213
    … …  
    12461245 Optimized memory allocator                               : $enable_fast_malloc
    12471246 JavaScript Engine                                        : $with_jsengine
     1247
    12481248Features:
    12491249 3D Rendering                                             : $enable_3d_rendering
    … …  
    13051305 Hildon UI extensions                                     : $with_hildon
    13061306 Introspection support                                    : $enable_introspection
     1307 Generate documentation                                   : $enable_gtk_doc
    13071308"
    13081309if test "$with_unicode_backend" = "glib"; then
Note: See TracChangeset for help on using the changeset viewer.