[Webkit-unassigned] [Bug 17045] [GTK] Documentation

[bugzilla-daemon at webkit.org]

https://bugs.webkit.org/show_bug.cgi?id=17045





------- Comment #16 from jmalonzo at gmail.com  2008-11-25 04:46 PDT -------
(From update of attachment 25390)
Hi Holger

> +INCLUDES= \
> +	-I$(top_srcdir)/WebKit/gtk \
> +	-I$(top_builddir)/WebKit/gtk \
> +	$(global_cppflags) \
> +	$(global_cflags) \
> +	-I$(top_srcdir) \
> +	-I$(top_srcdir)/JavaScriptCore \
> +	-I$(top_srcdir)/JavaScriptCore/ForwardingHeaders \
> +	-I$(top_srcdir)/JavaScriptCore/parser \
> +	-I$(top_srcdir)/JavaScriptCore/wtf \
> +	-I$(top_builddir)/DerivedSources \
> +	$(GLOBALDEPS_CFLAGS) \
> +	$(CAIRO_CFLAGS) \
> +	$(GTK_CFLAGS)

Do we need all of the above?

> diff --git a/WebKit/gtk/docs/version.xml.in b/WebKit/gtk/docs/version.xml.in
> new file mode 100644
> index 0000000..d78bda9
> --- /dev/null
> +++ b/WebKit/gtk/docs/version.xml.in
> @@ -0,0 +1 @@
> + at VERSION@

Should we add version.xml.in to EXTRA_DIST?

> diff --git a/WebKit/gtk/docs/webkitgtk-docs.sgml b/WebKit/gtk/docs/webkitgtk-docs.sgml
> index 9b41ed6..2f50ce5 100644
> --- a/WebKit/gtk/docs/webkitgtk-docs.sgml
> +++ b/WebKit/gtk/docs/webkitgtk-docs.sgml
> @@ -1,14 +1,12 @@
>  <?xml version="1.0"?>
>  <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
> -               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
> +               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
> +<!ENTITY version SYSTEM "version.xml">
> +]>
>  <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
>    <bookinfo>
> -    <title>webkitgtk Reference Manual</title>
> -    <releaseinfo>
> -      for webkitgtk [VERSION]
> -      The latest version of this documentation can be found on-line at
> -      <ulink role="online-location" url="http://[SERVER]/webkitgtk/index.html">http://[SERVER]/webkitgtk/</ulink>.
> -    </releaseinfo>
> +    <title>WebKit/Gtk+ Reference Manual</title>
> +    <releaseinfo>for WebKit/Gtk+ &version;</releaseinfo>
>    </bookinfo>
>  
>    <chapter>
> diff --git a/autogen.sh b/autogen.sh
> index a929538..882eba9 100755
> --- a/autogen.sh
> +++ b/autogen.sh
> @@ -10,6 +10,14 @@ cd $srcdir
>  
>  DIE=0
>  
> +(gtkdocize --version) < /dev/null > /dev/null 2>&1 || {
> +    echo
> +    echo "You must have gtkdocize installed to compile $PROJECT."
> +    echo "Install the appropriate package for your distribution,"
> +    echo "or get the source tarball at http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/"
> +    DIE=1
> +}
> +
>  (autoconf --version) < /dev/null > /dev/null 2>&1 || {
>      echo
>      echo "You must have autoconf installed to compile $PROJECT."
> @@ -46,6 +54,7 @@ rm -rf $top_srcdir/autom4te.cache
>  
>  touch README INSTALL
>  
> +gtkdocize || exit $?

You might want to move this after LIBTOOLIZE below.

>  aclocal || exit $?
>  $LIBTOOLIZE --force || exit $?
>  autoheader || exit $?
> diff --git a/configure.ac b/configure.ac
> index f48f98f..c37d3ef 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -670,6 +670,8 @@ if test "$enable_video" = "yes"; then
>      html_flags=yes
>  fi
>  
> +GTK_DOC_CHECK([1.10])

Please move this at the top so we fail early if gtk-doc is not found but
builder wants gtk-doc.

> +
>  # OS conditionals
>  AM_CONDITIONAL([OS_WIN32],[test "$os_win32" = "yes"])
>  AM_CONDITIONAL([OS_UNIX],[test "$os_win32" = "no"])
> @@ -718,6 +720,8 @@ AC_CONFIG_FILES([
>  GNUmakefile
>  WebKit/gtk/webkit-1.0.pc:WebKit/gtk/webkit.pc.in
>  WebKit/gtk/webkit/webkitversion.h
> +WebKit/gtk/docs/GNUmakefile
> +WebKit/gtk/docs/version.xml

Lastly, try to do the same as the pc file generation above (e.g.
...version.xml:WebKit/gtk/docs/versio.xml.in)

Cheers,


-- 
Configure bugmail: https://bugs.webkit.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.