luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-08 02:16:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
9b6cc973a0
glib/docs/reference/gio/Makefile.am

185 lines
4.0 KiB
Makefile
Raw Normal View History

Add more internal headers for gtk-doc to ignore This gives less bogus output in gio-unused.txt
2009-05-18 11:29:11 +02:00
NULL =
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
Move gdbus-codegen example code and docs into separate directories This avoids the generated types (e.g. ExampleAnimal, ExampleCat, ExampleObject and ExampleObjectManagerClient) being referenced in the core gio docs. This was requested by Matthias. Signed-off-by: David Zeuthen <davidz@redhat.com>
2011-06-03 19:22:31 +02:00
SUBDIRS = gdbus-object-manager-example
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
# The name of the module.
DOC_MODULE=gio
# The top-level SGML file.
DOC_MAIN_SGML_FILE=gio-docs.xml
# Extra options to supply to gtkdoc-scan
Teach gtk-doc about G_GNUC_WARN_UNUSED_RESULT
2011-12-19 13:45:43 +01:00
SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" \
--ignore-decorators="G_GNUC_WARN_UNUSED_RESULT"
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
# The directory containing the source code. Relative to $(srcdir)
DOC_SOURCE_DIR=$(top_srcdir)/gio
gio: Fix srcdir != builddir build for docs
2011-07-05 15:42:39 +02:00
BUILT_HFILES=gioenumtypes.h
Back out some changes to docs Makefiles Commit ab0e9dbfa76e056f875e969c0d7b6e133ec75431 introduced some changes to the documentation Makefiles designed to clean-up the process of deciding which headers get scanned for the docs. Unfortunately, the gtk-doc Makefile doesn't use HFILE_GLOB for actually generating the docs -- only for knowing when it needs to redo the generation. Because of this, we need to use IGNORE_HFILES or otherwise we get hundreds of symbols in the *-unused.txt files. Revert the changes that that commit made to the docs Makefiles (but leave the generation of the *-public-headers.txt files in place).
2011-09-05 23:54:52 +02:00
HFILE_GLOB=$(top_srcdir)/gio/*.h
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
CFILE_GLOB=$(top_srcdir)/gio/*.c
gio docs: don't scan subdirectories This clears up >50% of the huge warning spew from building GIO docs.
2011-09-06 01:10:04 +02:00
IGNORE_HFILES = \
gio docs: ignore private .h files
2011-09-06 01:35:16 +02:00
fam \
fen \
gdbus-2.0 \
gvdb \
inotify \
libasyncns \
tests \
win32 \
xdgmime \
gapplicationimpl.h \
gasynchelper.h \
gcontenttypeprivate.h \
gdbusauth.h \
gdbusauthmechanismanon.h \
gdbusauthmechanismexternal.h \
gdbusauthmechanism.h \
gdbusauthmechanismsha1.h \
gdbusprivate.h \
gdelayedsettingsbackend.h \
gdummyfile.h \
gdummyproxyresolver.h \
gdummytlsbackend.h \
gfileattribute-priv.h \
gfileinfo-priv.h \
giomodule-priv.h \
glocaldirectorymonitor.h \
glocalfileenumerator.h \
glocalfile.h \
glocalfileinfo.h \
glocalfileinputstream.h \
glocalfileiostream.h \
glocalfilemonitor.h \
glocalfileoutputstream.h \
glocalvfs.h \
gmountprivate.h \
docs: Ignore private network monitor headers
2012-02-19 16:19:40 +01:00
gnativevolumemonitor.h \
gio docs: ignore private .h files
2011-09-06 01:35:16 +02:00
gnetworkingprivate.h \
docs: Ignore private network monitor headers
2012-02-19 16:19:40 +01:00
gnetworkmonitorbase.h \
gnetworkmonitornetlink.h \
GNotification: finish documentation Add the missing documentation and add the section to the GIO reference docs. Fix up a few small documentation issues. https://bugzilla.gnome.org/show_bug.cgi?id=688492
2013-10-21 20:29:44 +02:00
gnotificationbackend.h \
gnotification-private.h \
gio docs: ignore private .h files
2011-09-06 01:35:16 +02:00
gpollfilemonitor.h \
gregistrysettingsbackend.h \
gsettingsbackendinternal.h \
gsettings-mapping.h \
Add gtk-doc for gsettingsschema{,source}
2011-11-17 11:06:49 +01:00
gsettingsschema-internal.h \
gio docs: ignore private .h files
2011-09-06 01:35:16 +02:00
gsocketinputstream.h \
gsocketoutputstream.h \
gsocks4aproxy.h \
gsocks4proxy.h \
gsocks5proxy.h \
Fixup GSubprocess documentation bits
2013-10-17 21:01:42 +02:00
gsubprocesslauncher-private.h \
gio docs: ignore private .h files
2011-09-06 01:35:16 +02:00
gthreadedresolver.h \
gunionvolumemonitor.h \
gunixmount.h \
gunixresolver.h \
gunixvolume.h \
gunixvolumemonitor.h \
gwin32appinfo.h \
gwin32mount.h \
gwin32resolver.h \
file-info: Add a G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID attribute This indicates whether the thumbnail (given by G_FILE_ATTRIBUTE_THUMBNAIL_PATH) is valid — i.e. to represent the file in its current state. If G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID is FALSE (for a normal _or_ failed thumbnail) it means the file has changed since the thumbnail was generated, and the thumbnail is out of date. Part of checking thumbnail validity (by the spec) involves parsing headers out of the thumbnail .png so we include some (small) code to do that in a separate file. We will likely want to copy this code to gvfs to do the same for GVfsFile. Heavily based on a patch from Philip Withnall <philip.withnall@collabora.co.uk> who suggested the feature and designed the API. https://bugzilla.gnome.org/show_bug.cgi?id=709898
2013-10-11 12:22:31 +02:00
gwin32volumemonitor.h \
thumbnail-verify.h
gio docs: ignore private .h files
2011-09-06 01:35:16 +02:00
gio docs: don't scan subdirectories This clears up >50% of the huge warning spew from building GIO docs.
2011-09-06 01:10:04 +02:00
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
Silence automake automake doesn't like INCLUDES anymore.
2013-02-03 04:54:15 +01:00
AM_CPPFLAGS = \
Replace -I with $(glib_INCLUDES) and friends Stop using ad hoc -I in all of our Makefile.am. Use the new variables instead.
2010-08-06 19:09:26 +02:00
$(gio_INCLUDES) \
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
$(GLIB_DEBUG_FLAGS)
GTKDOC_LIBS = \
$(top_builddir)/glib/libglib-2.0.la \
$(top_builddir)/gobject/libgobject-2.0.la \
$(top_builddir)/gmodule/libgmodule-2.0.la \
$(top_builddir)/gio/libgio-2.0.la \
$(NULL)
# Extra options to supply to gtkdoc-mkdb
Add GResolver, a glib-ish interface to DNS GResolver provides asynchronous (and synchronous-but-cancellable) APIs for resolving hostnames, reverse-resolving IP addresses back to hostnames, and resolving SRV records. Part of #548466.
2008-12-29 18:53:47 +01:00
MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=g \
gio docs: lots more fixes
2011-09-06 06:12:12 +02:00
--ignore-files='libasyncns tests'
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
# Images to copy into HTML directory
Stub of a migration chapter Stub of an overview Overview diagram taken 2007-12-17 Matthias Clasen <mclasen@redhat.com> * gio/migration.xml: Stub of a migration chapter * gio/overview.xml: Stub of an overview * gio/gvfs-overview.{odg,png}: Overview diagram taken from Alex Guadec slides. * gio/Makefile.am: * gio/gio-docs.xml: Include these svn path=/trunk/; revision=6145
2007-12-17 18:28:40 +01:00
HTML_IMAGES = \
Add GMenuModel
2011-11-27 04:46:51 +01:00
gvfs-overview.png \
menu-example.png \
menu-model.png
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
Add more internal headers for gtk-doc to ignore This gives less bogus output in gio-unused.txt
2009-05-18 11:29:11 +02:00
content_files = \
Stub of a migration chapter Stub of an overview Overview diagram taken 2007-12-17 Matthias Clasen <mclasen@redhat.com> * gio/migration.xml: Stub of a migration chapter * gio/overview.xml: Stub of an overview * gio/gvfs-overview.{odg,png}: Overview diagram taken from Alex Guadec slides. * gio/Makefile.am: * gio/gio-docs.xml: Include these svn path=/trunk/; revision=6145
2007-12-17 18:28:40 +01:00
version.xml \
Flesh out the docs svn path=/trunk/; revision=6150
2007-12-18 04:14:39 +01:00
overview.xml \
Add a migration chapter for dbus bits Also split migration.xml into separate files per chapter, it was getting unwieldy.
2010-05-06 23:52:54 +02:00
migrating-posix.xml \
migrating-gnome-vfs.xml \
migrating-gconf.xml \
Trivial: rename a file
2010-05-11 21:42:15 +02:00
migrating-gdbus.xml \
Add a man page for gio-querymodules
2010-04-18 21:54:54 +02:00
gio-querymodules.xml \
Rename gschema-compile to glib-compile-schemas And clean up the autofoo a bit: use an uppercase variable, check for pkg-config, check for presence of glib-compile-schemas.
2010-04-23 23:27:26 +02:00
glib-compile-schemas.xml\
build: include glib-compile-resources.xml in the dist tarball https://bugzilla.gnome.org/show_bug.cgi?id=671281
2012-03-04 00:26:10 +01:00
glib-compile-resources.xml \
docs: dist manpage gapplication.xml
2013-10-24 20:24:04 +02:00
gapplication.xml \
Rename gsettings-tool to gsettings And make it verb-based.
2010-04-22 07:15:54 +02:00
gsettings.xml \
Add docs for gresource
2012-01-23 06:23:18 +01:00
gresource.xml \
GDBus: add a man page for gdbus(1)
2010-05-07 01:39:16 +02:00
gdbus.xml \
Add gdbus-codegen(1) command It doesn't work yet without the user manually adding ffi bits. That's the topic of the next commit. Signed-off-by: David Zeuthen <davidz@redhat.com>
2011-04-08 22:57:31 +02:00
gdbus-codegen.xml \
GDBus: add a man page for gdbus(1)
2010-05-07 01:39:16 +02:00
$(NULL)
Flesh out the docs svn path=/trunk/; revision=6150
2007-12-18 04:14:39 +01:00
expand_content_files = \
overview.xml \
Add a migration chapter for dbus bits Also split migration.xml into separate files per chapter, it was getting unwieldy.
2010-05-06 23:52:54 +02:00
migrating-posix.xml \
migrating-gnome-vfs.xml \
migrating-gconf.xml \
gdbus-codegen: Add --c-generate-object-manager option + doc improvements Signed-off-by: David Zeuthen <davidz@redhat.com>
2011-04-12 17:50:34 +02:00
migrating-gdbus.xml \
gdbus-codegen.xml \
$(NULL)
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
Add more internal headers for gtk-doc to ignore This gives less bogus output in gio-unused.txt
2009-05-18 11:29:11 +02:00
extra_files = \
Stub of a migration chapter Stub of an overview Overview diagram taken 2007-12-17 Matthias Clasen <mclasen@redhat.com> * gio/migration.xml: Stub of a migration chapter * gio/overview.xml: Stub of an overview * gio/gvfs-overview.{odg,png}: Overview diagram taken from Alex Guadec slides. * gio/Makefile.am: * gio/gio-docs.xml: Include these svn path=/trunk/; revision=6145
2007-12-17 18:28:40 +01:00
version.xml.in \
gvfs-overview.odg
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
Fix gtk-doc cross-linking among glib/gobject/gio Patch by Daniel Macks, bug 644687.
2011-07-11 05:55:52 +02:00
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html --extra-dir=$(srcdir)/../gobject/html
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
include $(top_srcdir)/gtk-doc.make
Add more internal headers for gtk-doc to ignore This gives less bogus output in gio-unused.txt
2009-05-18 11:29:11 +02:00
EXTRA_DIST += \
gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 Alexander Larsson <alexl@redhat.com> * Makefile.am: * configure.in: * gio-2.0-uninstalled.pc.in: * gio-2.0.pc.in: * gio-unix-2.0-uninstalled.pc.in: * gio-unix-2.0.pc.in: * gio/ * docs/reference/gio Merged gio-standalone into glib. * glib/glibintl.h: * glib/gutils.c: Export glib_gettext so that gio can use it Add P_ (using same domain for now) Add I_ as g_intern_static_string svn path=/trunk/; revision=5941
2007-11-26 17:13:05 +01:00
version.xml.in
Merge the GSettings docs
2010-04-17 06:31:41 +02:00
build: Fix the --disable-man case The manpage listing needs to be inside the conditional.
2012-08-17 00:31:02 +02:00
man_MANS =
if ENABLE_MAN
man_MANS += \
New gapplication(1) tool This is essentially a commandline implementation of the client-side of the org.freedesktop.Application D-Bus interface. It includes support for tab-completion based on desktop files and their contents. https://bugzilla.gnome.org/show_bug.cgi?id=704218
2013-07-15 01:43:19 +02:00
gapplication.1 \
Add a man page for gio-querymodules
2010-04-18 21:54:54 +02:00
gio-querymodules.1 \
Rename gschema-compile to glib-compile-schemas And clean up the autofoo a bit: use an uppercase variable, check for pkg-config, check for presence of glib-compile-schemas.
2010-04-23 23:27:26 +02:00
glib-compile-schemas.1 \
Add documentation for GResource
2012-01-13 16:39:28 +01:00
glib-compile-resources.1 \
Add gdbus-codegen(1) command It doesn't work yet without the user manually adding ffi bits. That's the topic of the next commit. Signed-off-by: David Zeuthen <davidz@redhat.com>
2011-04-08 22:57:31 +02:00
gsettings.1 \
Add docs for gresource
2012-01-23 06:23:18 +01:00
gresource.1 \
Add gdbus-codegen(1) command It doesn't work yet without the user manually adding ffi bits. That's the topic of the next commit. Signed-off-by: David Zeuthen <davidz@redhat.com>
2011-04-08 22:57:31 +02:00
gdbus.1 \
gdbus-codegen.1
Merge the GSettings docs
2010-04-17 06:31:41 +02:00
docs: Improve man page generation Use $(AM_V_GEN) for generating man pages, and set some parameters for the XSL stylesheets. Among other things, don't generate AUTHORS and COPYRIGHT sections.
2012-08-03 00:33:34 +02:00
XSLTPROC_FLAGS = \
--nonet \
--stringparam man.output.quietly 1 \
--stringparam funcsynopsis.style ansi \
--stringparam man.th.extra1.suppress 1 \
--stringparam man.authors.section.enabled 0 \
--stringparam man.copyright.section.enabled 0
Fix up man page handling Turns out the formatted man pages did not end up in the tarballs. Doh.
2010-04-23 20:52:26 +02:00
.xml.1:
docs: Improve man page generation Use $(AM_V_GEN) for generating man pages, and set some parameters for the XSL stylesheets. Among other things, don't generate AUTHORS and COPYRIGHT sections.
2012-08-03 00:33:34 +02:00
$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
Merge the GSettings docs
2010-04-17 06:31:41 +02:00
endif
docs: Ensure CLEANFILES is set before we use += We need to be defensive about this in the case where gtk-doc.make is empty.
2012-08-25 23:13:43 +02:00
CLEANFILES ?=
Clean up man pages on 'clean' Follow the automake heuristic that says "if 'make' created it, 'make clean' should remove it". https://bugzilla.gnome.org/show_bug.cgi?id=681336
2012-08-08 15:57:48 +02:00
CLEANFILES += $(man_MANS)
Fix up man page handling Turns out the formatted man pages did not end up in the tarballs. Doh.
2010-04-23 20:52:26 +02:00
EXTRA_DIST += $(man_MANS)
Distcheck fixes
2010-04-18 02:13:59 +02:00
Remove man page placeholder generation I don't see a good reason for this - if man page generation is disabled, man pages are not produced, and things like 'make dist' will fail. That is simpler and better. https://bugzilla.gnome.org/show_bug.cgi?id=681336
2012-08-08 16:01:47 +02:00
dist-hook-local: all-local
Merge the GSettings docs
2010-04-17 06:31:41 +02:00
Fix up man page handling Turns out the formatted man pages did not end up in the tarballs. Doh.
2010-04-23 20:52:26 +02:00
gio-docs-clean: clean
cd $(srcdir) && rm -rf xml html
Reference in New Issue Copy Permalink