[grilo-plugins] doc: Follow instructions about GNOME Documentation



commit 23b31983457b1cfa4fb82afd2c8d63657eb862fb
Author: Juan A. Suarez Romero <jasuarez igalia com>
Date:   Thu Nov 29 18:03:38 2012 +0000

    doc: Follow instructions about GNOME Documentation
    
    See http://developer.gnome.org/gnome-doc-make/unstable/migrating.html
    
    Specifically, this commit
    - Adds legal.xml file
    - Disables scrollkeeper from distcheck flags
    - Adds gnome-doc-utils.make to distclean
    - Renames doc/ to help/
    
    https://bugzilla.gnome.org/show_bug.cgi?id=685473

 Makefile.am                       |    5 +-
 configure.ac                      |    4 +-
 doc/.gitignore                    |    1 -
 help/.gitignore                   |    1 +
 {doc => help}/C/grilo-plugins.xml |    4 +-
 help/C/legal.xml                  |   75 +++++++++++++++++++++++++++++++++++++
 {doc => help}/Makefile.am         |    3 +-
 7 files changed, 83 insertions(+), 10 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 4c10e83..1942743 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -7,7 +7,7 @@
 
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS = src doc examples test
+SUBDIRS = src help examples test
 
 MAINTAINERCLEANFILES = \
         aclocal.m4 \
@@ -26,7 +26,7 @@ MAINTAINERCLEANFILES = \
 	mkinstalldirs \
 	*~
 
-DISTCLEANFILES = $(MAINTAINERCLEANFILES)
+DISTCLEANFILES = $(MAINTAINERCLEANFILES) gnome-doc-utils.make
 
 EXTRA_DIST = ./m4/grilo.m4
 
@@ -34,6 +34,7 @@ EXTRA_DIST = ./m4/grilo.m4
 # when creating tarball releases,
 # and make sure that we enable all plugins needed by the documentation.
 DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc \
+                            --disable-scrollkeeper \
                             --enable-apple-trailers \
                             --enable-bliptv \
                             --enable-bookmarks \
diff --git a/configure.ac b/configure.ac
index a6c8d96..d25ac43 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1007,6 +1007,8 @@ GNOME_DOC_INIT([0.9.0],,
 
 AC_CONFIG_FILES([
   Makefile
+  examples/Makefile
+  help/Makefile
   src/Makefile
   src/apple-trailers/Makefile
   src/bliptv/Makefile
@@ -1028,8 +1030,6 @@ AC_CONFIG_FILES([
   src/upnp/Makefile
   src/vimeo/Makefile
   src/youtube/Makefile
-  doc/Makefile
-  examples/Makefile
   test/Makefile
 ])
 
diff --git a/help/.gitignore b/help/.gitignore
new file mode 100644
index 0000000..cf7cb60
--- /dev/null
+++ b/help/.gitignore
@@ -0,0 +1 @@
+html/*
diff --git a/doc/C/grilo-plugins.xml b/help/C/grilo-plugins.xml
similarity index 99%
rename from doc/C/grilo-plugins.xml
rename to help/C/grilo-plugins.xml
index ec2bc77..6553e18 100644
--- a/doc/C/grilo-plugins.xml
+++ b/help/C/grilo-plugins.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://docbook.org/docbook/xml/4.5/docbookx.dtd"; [
+  <!ENTITY legal SYSTEM "legal.xml">
   <!ENTITY url_refdocs_base "http://developer.gnome.org/grilo/unstable/";>
   <!ENTITY url_examples_base "http://git.gnome.org/browse/grilo-plugins/tree/examples/";>
   <!ENTITY uuml "&#252;" >
@@ -174,6 +175,3 @@
 </chapter>
 
 </book>
-
-
-
diff --git a/help/C/legal.xml b/help/C/legal.xml
new file mode 100644
index 0000000..05344ae
--- /dev/null
+++ b/help/C/legal.xml
@@ -0,0 +1,75 @@
+  <legalnotice id="legalnotice">
+	<para>
+	  Permission is granted to copy, distribute and/or modify this
+	  document under the terms of the GNU Free Documentation
+	  License (GFDL), Version 1.1 or any later version published
+	  by the Free Software Foundation with no Invariant Sections,
+	  no Front-Cover Texts, and no Back-Cover Texts.  You can find
+	  a copy of the GFDL at this <ulink type="help"
+	  url="help:fdl">link</ulink> or in the file COPYING-DOCS
+	  distributed with this manual.
+         </para>
+         <para> This manual is part of a collection of GNOME manuals
+          distributed under the GFDL.  If you want to distribute this
+          manual separately from the collection, you can do so by
+          adding a copy of the license to the manual, as described in
+          section 6 of the license.
+	</para>
+
+	<para>
+	  Many of the names used by companies to distinguish their
+	  products and services are claimed as trademarks. Where those
+	  names appear in any GNOME documentation, and the members of
+	  the GNOME Documentation Project are made aware of those
+	  trademarks, then the names are in capital letters or initial
+	  capital letters.
+	</para>
+
+	<para>
+	  DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
+	  UNDER  THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
+	  WITH THE FURTHER UNDERSTANDING THAT:
+
+	  <orderedlist>
+		<listitem>
+		  <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
+                    WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+                    IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
+                    THAT THE DOCUMENT OR MODIFIED VERSION OF THE
+                    DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
+                    A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
+                    RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
+                    OF THE DOCUMENT OR MODIFIED VERSION OF THE
+                    DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
+                    MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
+                    YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
+                    CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
+                    SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
+                    OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
+                    LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
+                    VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
+                    EXCEPT UNDER THIS DISCLAIMER; AND
+		  </para>
+		</listitem>
+		<listitem>
+		  <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
+                       THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
+                       CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
+                       INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
+                       DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
+                       OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
+                       PARTIES, BE LIABLE TO ANY PERSON FOR ANY
+                       DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
+                       CONSEQUENTIAL DAMAGES OF ANY CHARACTER
+                       INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
+                       OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
+                       MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
+                       LOSSES ARISING OUT OF OR RELATING TO USE OF THE
+                       DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
+                       EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
+                       THE POSSIBILITY OF SUCH DAMAGES.
+		  </para>
+		</listitem>
+	  </orderedlist>
+	</para>
+  </legalnotice>
diff --git a/doc/Makefile.am b/help/Makefile.am
similarity index 92%
rename from doc/Makefile.am
rename to help/Makefile.am
index 717518f..b5a8c36 100644
--- a/doc/Makefile.am
+++ b/help/Makefile.am
@@ -2,7 +2,7 @@ include $(top_srcdir)/gnome-doc-utils.make
 dist-hook: doc-dist-hook
 
 DOC_MODULE = grilo-plugins
-DOC_ENTITIES =
+DOC_ENTITIES = legal.xml
 DOC_INCLUDES = ../../examples/example-tmdb.c
 DOC_FIGURES =
 
@@ -14,4 +14,3 @@ DOC_LINGUAS =
 XMLLINT = xmllint
 validate: $(srcdir)/C/grilo-plugins.xml
 	$(XMLLINT) --xinclude --postvalid --noout $<
-



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]