From 1084e2fbb7e4e803e40b6dd4af0a6b5de6e57c86 Mon Sep 17 00:00:00 2001 From: Robert Bragg Date: Mon, 3 Sep 2012 15:32:07 +0100 Subject: [PATCH] docs: Update pointers to documentation The generated release message and the README have been updated to point to the reference manuals hosted on developer.gnome.org and state that documentation for the experimental 2.0 api is not currently available online since we are migrating services away from clutter-project.org and may not be able to rely on it for much longer. --- README.in | 14 ++++++++------ build/autotools/Makefile.am.release | 17 +++++++++-------- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/README.in b/README.in index 4fbf8e355..3ccd01400 100644 --- a/README.in +++ b/README.in @@ -87,16 +87,18 @@ UProf is available from: DOCUMENTATION ------------------------------------------------------------------------------- -The API references for the latest stable release are available at: +The 1.x stable API is documented here: - http://docs.clutter-project.org/docs/cogl/stable/ + http://developer.gnome.org/cogl/stable/ -The experimental 2.0 API can be found here: +The 1.x development API is documented here: - http://docs.clutter-project.org/docs/cogl-2.0-experimental/stable/ + http://developer.gnome.org/cogl/1.$(COGL_1_MINOR_VERSION) - Note: The confusing "stable" at the end refers to the overall Cogl release - status, not the documentation specifically. +The experimental 2.0 API is currently not hosted online but can be built +by passing the --enable-gtk-doc option to ./configure when building +and the documentation can then be found under +doc/reference/cogl-2.0-experimental/html/index.html -- LICENSE diff --git a/build/autotools/Makefile.am.release b/build/autotools/Makefile.am.release index ad2b818ed..224953f58 100644 --- a/build/autotools/Makefile.am.release +++ b/build/autotools/Makefile.am.release @@ -7,10 +7,8 @@ TAR_OPTIONS = --owner=0 --group=0 RELEASE_URL_BASE = http://download.gnome.org/sources/cogl RELEASE_URL = $(RELEASE_URL_BASE)/$(COGL_1_MAJOR_VERSION).$(COGL_1_MINOR_VERSION) -RELEASE_ANNOUNCE_LIST = cogl3d@googlegroups.com, clutter-announce@clutter-project.org -RELEASE_ANNOUNCE_CC = gnome-announce-list@gnome.org - -RELEASE_DOC_URL = http://docs.clutter-project.org/docs/ +RELEASE_ANNOUNCE_LIST = cogl@lists.freedesktop.org +RELEASE_ANNOUNCE_CC = gnome-announce-list@gnome.org clutter-announce@clutter-project.org tar_file = $(distdir).tar.bz2 sha256_file = $(distdir).sha256sum @@ -111,10 +109,13 @@ release-message: @echo "DOCUMENTATION" @echo "-------------------------------------------------------------------------------" @echo "" - @echo "The 1.x API is documented here:" - @echo " http://docs.clutter-project.org/docs/cogl/1.$(COGL_1_MINOR_VERSION)" - @echo "The experimental 2.0 API is documented here:" - @echo " http://docs.clutter-project.org/docs/cogl-2.0-experimental/1.$(COGL_1_MINOR_VERSION)" + @echo "The 1.x stable API is documented here:" + @echo " http://developer.gnome.org/cogl/stable/" + @echo "The 1.x development API is documented here:" + @echo " http://developer.gnome.org/cogl/1.$(COGL_1_MINOR_VERSION)" + @echo "" + @echo "The experimental 2.0 API is currently not hosted online but can be built" + @echo "by passing the --enable-gtk-doc option to ./configure when building." @echo "" @echo "" @echo "RELEASE NOTES"