[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[SCM] GNU libidn branch, master, updated. libidn-1-18-38-gfed37e5
|
From: |
Simon Josefsson |
|
Subject: |
[SCM] GNU libidn branch, master, updated. libidn-1-18-38-gfed37e5 |
|
Date: |
Sat, 22 May 2010 11:27:46 +0000 |
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU libidn".
http://git.savannah.gnu.org/cgit/libidn.git/commit/?id=fed37e5e9725dfc236eeab43c403395e08039565
The branch, master has been updated
via fed37e5e9725dfc236eeab43c403395e08039565 (commit)
from bf880cc6ef80d9245f796da25c61c22c75d88f34 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit fed37e5e9725dfc236eeab43c403395e08039565
Author: Simon Josefsson <address@hidden>
Date: Thu May 20 16:23:13 2010 +0200
Update GTK-DOC files to enable PDF manual.
-----------------------------------------------------------------------
Summary of changes:
NEWS | 3 +-
cfg.mk | 3 +-
doc/gendocs_template | 1 +
doc/reference/Makefile.am | 28 +++++++++++----
gl/override/doc/gendocs_template.diff | 3 +-
gtk-doc.make | 65 ++++++++++++++++++++++++++-------
m4/gtk-doc.m4 | 2 +-
7 files changed, 80 insertions(+), 25 deletions(-)
diff --git a/NEWS b/NEWS
index 88b6bda..3d295ef 100644
--- a/NEWS
+++ b/NEWS
@@ -4,7 +4,8 @@ See the end for copying conditions.
* Version 1.19 (unreleased) [?]
-** doc: Fix typos etc.
+** doc: Typo fixes. Added PDF version of API reference manual.
+See doc/reference/libidn.pdf.
** build: Update gnulib files.
diff --git a/cfg.mk b/cfg.mk
index 7e8c288..5ad177c 100644
--- a/cfg.mk
+++ b/cfg.mk
@@ -17,7 +17,8 @@
WFLAGS ?= --enable-gcc-warnings
ADDFLAGS ?=
-CFGFLAGS ?= --enable-java --enable-gtk-doc $(ADDFLAGS) $(WFLAGS)
+CFGFLAGS ?= --enable-java --enable-gtk-doc --enable-gtk-doc-pdf \
+ $(ADDFLAGS) $(WFLAGS)
ifeq ($(.DEFAULT_GOAL),abort-due-to-no-makefile)
.DEFAULT_GOAL := bootstrap
diff --git a/doc/gendocs_template b/doc/gendocs_template
index 60c55a5..5a9ec19 100644
--- a/doc/gendocs_template
+++ b/doc/gendocs_template
@@ -74,6 +74,7 @@ this helps support FSF activities.</p>
<p>
<ul>
<li><a href="../reference/ch01.html">GTK-DOC HTML C/C++ API Reference
Manual</a>.
+ <li><a href="../reference/%%PACKAGE%%.pdf">PDF Reference API Manual
(GTK-DOC)</a>.
<li><a href="../reference/libidn.devhelp">GTK-DOC DevHelp C/C++ API
Reference Manual</a>.
</ul>
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 07068f3..6dc23e6 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -11,13 +11,17 @@ AUTOMAKE_OPTIONS = 1.6
# The name of the module, e.g. 'glib'.
DOC_MODULE=$(PACKAGE)
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
# The top-level SGML file. You can change this if you want to.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
-# The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk
+# Directories containing the source code, relative to $(srcdir).
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
DOC_SOURCE_DIR=../../lib
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
@@ -35,6 +39,9 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
MKTMPL_OPTIONS=
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=
+
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
FIXXREF_OPTIONS=
@@ -45,7 +52,11 @@ FIXXREF_OPTIONS=
HFILE_GLOB=$(top_srcdir)/lib/*.h
CFILE_GLOB=$(top_srcdir)/lib/*.c
-# Header files to ignore when scanning.
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=gunibreak.h gunicomp.h gunidecomp.h idn-int.h gl
@@ -65,9 +76,9 @@ expand_content_files=
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
-# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-AM_CPPFLAGS=
+GTKDOC_CFLAGS=
GTKDOC_LIBS=
# This includes the standard gtk-doc make rules, copied by gtkdocize.
@@ -83,4 +94,7 @@ EXTRA_DIST +=
#DISTCLEANFILES +=
# Comment this out if you want your docs-status tested during 'make check'
+if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc) &&
#TESTS = $(GTKDOC_CHECK)
+endif
diff --git a/gl/override/doc/gendocs_template.diff
b/gl/override/doc/gendocs_template.diff
index 8722402..9cb1a0a 100644
--- a/gl/override/doc/gendocs_template.diff
+++ b/gl/override/doc/gendocs_template.diff
@@ -1,6 +1,6 @@
--- gendocs_template.orig 2007-05-31 12:01:54.000000000 +0200
+++ gendocs_template 2007-05-31 12:01:40.000000000 +0200
-@@ -41,6 +41,27 @@
+@@ -41,6 +41,28 @@
(%%TEXI_TGZ_SIZE%%K bytes gzipped tar file).</a></li>
</ul>
@@ -15,6 +15,7 @@
+<p>
+<ul>
+ <li><a href="../reference/ch01.html">GTK-DOC HTML C/C++ API Reference
Manual</a>.
++ <li><a href="../reference/%%PACKAGE%%.pdf">PDF Reference API Manual
(GTK-DOC)</a>.
+ <li><a href="../reference/libidn.devhelp">GTK-DOC DevHelp C/C++ API
Reference Manual</a>.
+</ul>
+
diff --git a/gtk-doc.make b/gtk-doc.make
index 6646365..57fab98 100644
--- a/gtk-doc.make
+++ b/gtk-doc.make
@@ -23,7 +23,7 @@ GPATH = $(srcdir)
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
-EXTRA_DIST = \
+EXTRA_DIST = \
$(content_files) \
$(HTML_IMAGES) \
$(DOC_MAIN_SGML_FILE) \
@@ -31,10 +31,12 @@ EXTRA_DIST = \
$(DOC_MODULE)-overrides.txt
DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp
\
- $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
+ pdf-build.stamp \
+ $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp \
+ $(srcdir)/pdf.stamp
-SCANOBJ_FILES = \
- $(DOC_MODULE).args \
+SCANOBJ_FILES = \
+ $(DOC_MODULE).args \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).interfaces \
$(DOC_MODULE).prerequisites \
@@ -48,12 +50,23 @@ REPORT_FILES = \
CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
if ENABLE_GTK_DOC
-all-local: html-build.stamp
+if GTK_DOC_BUILD_HTML
+HTML_BUILD_STAMP=html-build.stamp
+else
+HTML_BUILD_STAMP=
+endif
+if GTK_DOC_BUILD_PDF
+PDF_BUILD_STAMP=pdf-build.stamp
+else
+PDF_BUILD_STAMP=
+endif
+
+all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
else
all-local:
endif
-docs: html-build.stamp
+docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
$(REPORT_FILES): sgml-build.stamp
@@ -62,8 +75,11 @@ $(REPORT_FILES): sgml-build.stamp
scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
@echo 'gtk-doc: Scanning header files'
@-chmod -R u+w $(srcdir)
- @cd $(srcdir) && \
- gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
--ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
+ @_source_dir='' ; for i in $(DOC_SOURCE_DIR) ; do \
+ _source_dir="$${_source_dir} --source-dir=$$i" ; \
+ done ; \
+ cd $(srcdir) && \
+ gtkdoc-scan --module=$(DOC_MODULE)
--ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS)
$(EXTRA_HFILES)
@if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ;
then \
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)"
CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)"
gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE)
--output-dir=$(srcdir) ; \
else \
@@ -96,8 +112,11 @@ $(srcdir)/tmpl/*.sgml:
sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml
$(expand_content_files)
@echo 'gtk-doc: Building XML'
@-chmod -R u+w $(srcdir)
- @cd $(srcdir) && \
- gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
--output-format=xml --expand-content-files="$(expand_content_files)"
--main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
+ @_source_dir='' ; for i in $(DOC_SOURCE_DIR) ; do \
+ _source_dir="$${_source_dir} --source-dir=$$i" ; \
+ done ; \
+ cd $(srcdir) && \
+ gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml
--expand-content-files="$(expand_content_files)"
--main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS)
@touch sgml-build.stamp
sgml.stamp: sgml-build.stamp
@@ -115,12 +134,31 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE)
$(content_files)
if test "$(?)" = "0"; then \
mkhtml_options=--path="$(srcdir)"; \
fi; \
- cd $(srcdir)/html && gtkdoc-mkhtml $(mkhtml_options) $(MKHTML_OPTIONS)
$(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
+ cd $(srcdir)/html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS)
$(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
@test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES)
html )
@echo 'gtk-doc: Fixing cross-references'
@cd $(srcdir) && gtkdoc-fixxref --module=$(DOC_MODULE)
--module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
@touch html-build.stamp
+#### pdf ####
+
+pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
+ @echo 'gtk-doc: Building PDF'
+ @-chmod -R u+w $(srcdir)
+ @rm -rf $(srcdir)/$(DOC_MODULE).pdf
+ @mkpdf_imgdirs=""; \
+ if test "x$(HTML_IMAGES)" != "x"; then \
+ for img in $(HTML_IMAGES); do \
+ part=`dirname $$img`; \
+ echo $$mkpdf_imgdirs | grep >/dev/null "\-\-imgdir=$$part "; \
+ if test $$? != 0; then \
+ mkpdf_imgdirs="$$mkpdf_imgdirs --imgdir=$$part"; \
+ fi; \
+ done; \
+ fi; \
+ cd $(srcdir) && gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_imgdirs
$(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
+ @touch pdf-build.stamp
+
##############
clean-local:
@@ -129,7 +167,7 @@ clean-local:
distclean-local:
cd $(srcdir) && \
- rm -rf xml $(REPORT_FILES) \
+ rm -rf xml $(REPORT_FILES) $(DOC_MODULE).pdf \
$(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
maintainer-clean-local: clean
@@ -180,11 +218,10 @@ endif
dist-hook: dist-check-gtkdoc dist-hook-local
mkdir $(distdir)/tmpl
- mkdir $(distdir)/xml
mkdir $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
- -cp $(srcdir)/xml/*.xml $(distdir)/xml
cp $(srcdir)/html/* $(distdir)/html
+ -cp $(srcdir)/$(DOC_MODULE).pdf $(distdir)/
-cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
-cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
cd $(distdir) && rm -f $(DISTCLEANFILES)
diff --git a/m4/gtk-doc.m4 b/m4/gtk-doc.m4
index ef01a82..2cfa1e7 100644
--- a/m4/gtk-doc.m4
+++ b/m4/gtk-doc.m4
@@ -48,7 +48,7 @@ AC_DEFUN([GTK_DOC_CHECK],
[build documentation in pdf format [[default=no]]]),,
[enable_gtk_doc_pdf=no])
- if test -n "$GTKDOC_MKPDF"; then
+ if test -z "$GTKDOC_MKPDF"; then
enable_gtk_doc_pdf=no
fi
hooks/post-receive
--
GNU libidn
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [SCM] GNU libidn branch, master, updated. libidn-1-18-38-gfed37e5,
Simon Josefsson <=