From patchwork Sun Jan 25 11:34:24 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Takashi Sakamoto X-Patchwork-Id: 5701051 Return-Path: X-Original-To: patchwork-alsa-devel@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id F38309F1D6 for ; Sun, 25 Jan 2015 11:35:59 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id E6101201F5 for ; Sun, 25 Jan 2015 11:35:58 +0000 (UTC) Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) by mail.kernel.org (Postfix) with ESMTP id 9A7BA201EC for ; Sun, 25 Jan 2015 11:35:57 +0000 (UTC) Received: by alsa0.perex.cz (Postfix, from userid 1000) id 134BD26053D; Sun, 25 Jan 2015 12:35:56 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Spam-Status: No, score=0.6 required=5.0 tests=BAYES_00,NO_DNS_FOR_FROM, UNPARSEABLE_RELAY,URIBL_DBL_SPAM autolearn=no version=3.3.1 Received: from alsa0.perex.cz (localhost [IPv6:::1]) by alsa0.perex.cz (Postfix) with ESMTP id 67160260465; Sun, 25 Jan 2015 12:35:12 +0100 (CET) X-Original-To: alsa-devel@alsa-project.org Delivered-To: alsa-devel@alsa-project.org Received: by alsa0.perex.cz (Postfix, from userid 1000) id A8D0C26045C; Sun, 25 Jan 2015 12:35:10 +0100 (CET) Received: from smtp302.phy.lolipop.jp (smtp302.phy.lolipop.jp [210.157.22.85]) by alsa0.perex.cz (Postfix) with ESMTP id C0437260437 for ; Sun, 25 Jan 2015 12:35:01 +0100 (CET) Received: from smtp302.phy.lolipop.lan (HELO smtp302.phy.lolipop.jp) (172.17.1.85) (smtp-auth username m12129643-o-takashi, mechanism plain) by smtp302.phy.lolipop.jp (qpsmtpd/0.82) with ESMTPA; Sun, 25 Jan 2015 20:34:59 +0900 Received: from 127.0.0.1 (127.0.0.1) by smtp302.phy.lolipop.jp (LOLIPOP-Fsecure); Sun, 25 Jan 2015 20:34:35 +0900 (JST) X-Virus-Status: clean(LOLIPOP-Fsecure) From: Takashi Sakamoto To: clemens@ladisch.de, tiwai@suse.de, perex@perex.cz Date: Sun, 25 Jan 2015 20:34:24 +0900 Message-Id: <1422185674-16431-4-git-send-email-o-takashi@sakamocchi.jp> X-Mailer: git-send-email 2.1.0 In-Reply-To: <1422185674-16431-1-git-send-email-o-takashi@sakamocchi.jp> References: <1422185674-16431-1-git-send-email-o-takashi@sakamocchi.jp> Cc: alsa-devel@alsa-project.org, linux1394-devel@lists.sourceforge.net, ffado-devel@lists.sf.net Subject: [alsa-devel] [PATCH 03/13] libhinawa: support GTK-Doc to generate references X-BeenThere: alsa-devel@alsa-project.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Alsa-devel mailing list for ALSA developers - http://www.alsa-project.org" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: alsa-devel-bounces@alsa-project.org Sender: alsa-devel-bounces@alsa-project.org X-Virus-Scanned: ClamAV using ClamSMTP The GTK-Doc project gives a way to generate API documentation from C source code, mainly from comments. This library uses this mechanism to give references. This commit adds a dependency with: - GTK-Doc 1.18-2 or later The reference is available to give '--enable-gtk-doc' option for ./configure script. Signed-off-by: Takashi Sakamoto --- libhinawa/Makefile.am | 3 ++- libhinawa/README | 7 +++++ libhinawa/autogen.sh | 1 + libhinawa/configure.ac | 6 +++++ libhinawa/doc/Makefile.am | 2 ++ libhinawa/doc/reference/Makefile.am | 46 ++++++++++++++++++++++++++++++++ libhinawa/doc/reference/hinawa-docs.sgml | 39 +++++++++++++++++++++++++++ libhinawa/doc/reference/version.xml.in | 1 + 8 files changed, 104 insertions(+), 1 deletion(-) create mode 100644 libhinawa/doc/Makefile.am create mode 100644 libhinawa/doc/reference/Makefile.am create mode 100644 libhinawa/doc/reference/hinawa-docs.sgml create mode 100644 libhinawa/doc/reference/version.xml.in diff --git a/libhinawa/Makefile.am b/libhinawa/Makefile.am index 05f5d58..3fd84c5 100644 --- a/libhinawa/Makefile.am +++ b/libhinawa/Makefile.am @@ -2,4 +2,5 @@ ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS} SUBDIRS = \ - src + src \ + doc diff --git a/libhinawa/README b/libhinawa/README index db9b82a..f6a0650 100644 --- a/libhinawa/README +++ b/libhinawa/README @@ -3,9 +3,16 @@ Requirements - GNU Automake 1.10.1 or later - GNU libtool 2.2.6 or later - Glib 2.32.4 or later +- GTK-Doc 1.18-2 How to build $ ./autogen.sh $ ./configure $ make $ make install + +How to refer document + $ ./autogen.sh + $ ./configure --enable-gtk-doc + $ make + $ make install diff --git a/libhinawa/autogen.sh b/libhinawa/autogen.sh index 54ecfa2..98f6dbf 100755 --- a/libhinawa/autogen.sh +++ b/libhinawa/autogen.sh @@ -7,4 +7,5 @@ if [ ! -e m4 ] ; then mkdir -p m4 fi +gtkdocize --copy --docdir doc/reference autoreconf --install diff --git a/libhinawa/configure.ac b/libhinawa/configure.ac index 5ecb7ec..28ca374 100644 --- a/libhinawa/configure.ac +++ b/libhinawa/configure.ac @@ -45,10 +45,16 @@ AC_PROG_CC # Glib 2.32 or later AM_PATH_GLIB_2_0([2.32.4], [], [], [gobject]) +# GTK-Doc 1.18-2 or later +GTK_DOC_CHECK([1.18-2]) + # The files generated from *.in AC_CONFIG_FILES([ Makefile src/Makefile + doc/Makefile + doc/reference/Makefile + doc/reference/version.xml ]) # Generate scripts and launch diff --git a/libhinawa/doc/Makefile.am b/libhinawa/doc/Makefile.am new file mode 100644 index 0000000..66af18f --- /dev/null +++ b/libhinawa/doc/Makefile.am @@ -0,0 +1,2 @@ +SUBDIRS = \ + reference diff --git a/libhinawa/doc/reference/Makefile.am b/libhinawa/doc/reference/Makefile.am new file mode 100644 index 0000000..b7e28d2 --- /dev/null +++ b/libhinawa/doc/reference/Makefile.am @@ -0,0 +1,46 @@ +# The name of this module +DOC_MODULE = hinawa + +# THe entry point +DOC_MAIN_SGML_FILE = hinawa-docs.sgml + +# The directory with sources +DOC_SOURCE_DIR = \ + $(top_srcdir)/src + +# The tag for deprecates +SCAN_OPTIONS = + +# The prefix +MKDB_OPTIONS = \ + --name-space=hinawa + +# The patterns for headers +HFILE_GLOB = \ + $(top_srcdir)/src/*.h + +# The patterns for sources +CFILE_GLOB = \ + $(top_srcdir)/src/*.c + +# The options for C Pre-Processor +AM_CPPFLAGS = \ + -I$(top_srcdir) \ + -I$(top_srcdir)/src + +# The options for C compiler +AM_CFLAGS = \ + $(GLIB_CFLAGS) \ + -Wall + +# The options to link +GTKDOC_LIBS = \ + $(top_builddir)/src/libhinawa.la \ + $(GLIB_LIBS) + +# Include Makefile generated by GTK-Doc +include $(top_srcdir)/doc/reference/gtk-doc.make + +CLEANFILES += \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE).types diff --git a/libhinawa/doc/reference/hinawa-docs.sgml b/libhinawa/doc/reference/hinawa-docs.sgml new file mode 100644 index 0000000..43c5c4e --- /dev/null +++ b/libhinawa/doc/reference/hinawa-docs.sgml @@ -0,0 +1,39 @@ + + +]> + + + Hinawa Reference Manual + This document is for the Hinawa library, version &version;. + + + + + Reference + + + Introduction + + Hinawa is an gobject introspection library for devices connected to + IEEE 1394 bus. This library supports any types of transactions + over IEEE 1394 bus. + This library also supports some functionality which ALSA firewire + stack produces. + + + + + libhinawa + + This library gives 7 objects, 3 objects are abstraction of the + functionality in ALSA firewire stack, the others are abstractions + of the transaction functionality in Linux firewire stack. + + + + + + Index of all symbols + + diff --git a/libhinawa/doc/reference/version.xml.in b/libhinawa/doc/reference/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/libhinawa/doc/reference/version.xml.in @@ -0,0 +1 @@ +@VERSION@