GIO doc cleanups
[platform/upstream/glib.git] / docs / reference / gio / Makefile.am
1 include $(top_srcdir)/Makefile.decl
2 NULL =
3
4 # The name of the module.
5 DOC_MODULE=gio
6
7 # The top-level SGML file.
8 DOC_MAIN_SGML_FILE=gio-docs.xml
9
10 # Extra options to supply to gtkdoc-scan
11 SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED"
12
13 # The directory containing the source code. Relative to $(srcdir)
14 DOC_SOURCE_DIR=$(top_srcdir)/gio
15
16 HFILE_GLOB=$(top_srcdir)/gio/*.h
17 CFILE_GLOB=$(top_srcdir)/gio/*.c
18
19 # Headers to ignore
20 IGNORE_HFILES=                          \
21         asyncns.h                       \
22         fam-helper.h                    \
23         fen-data.h                      \
24         fen-helper.h                    \
25         fen-kernel.h                    \
26         fen-node.h                      \
27         gasynchelper.h                  \
28         gcontenttypeprivate.h           \
29         gdbusauth.h                     \
30         gdbusauthmechanism.h            \
31         gdbusauthmechanismanon.h        \
32         gdbusauthmechanismexternal.h    \
33         gdbusauthmechanismsha1.h        \
34         gdbusprivate.h                  \
35         gdbus-sessionbus.h              \
36         gdbus-tests.h                   \
37         testenums.h                     \
38         gdelayedsettingsbackend.h       \
39         gdummyfile.h                    \
40         gfamdirectorymonitor.h          \
41         gfamfilemonitor.h               \
42         gfendirectorymonitor.h          \
43         gfenfilemonitor.h               \
44         gfileattribute-priv.h           \
45         gfileinfo-priv.h                \
46         ginotifydirectorymonitor.h      \
47         ginotifyfilemonitor.h           \
48         gio-marshal.h                   \
49         gio.h                           \
50         gioalias.h                      \
51         gioalias.h                      \
52         gkeyfilesettingsbackend.h       \
53         gioenumtypes.h                  \
54         giomodule-priv.h                \
55         glocaldirectorymonitor.h        \
56         glocalfile.h                    \
57         glocalfileenumerator.h          \
58         glocalfileinfo.h                \
59         glocalfileinputstream.h         \
60         glocalfileiostream.h            \
61         glocalfilemonitor.h             \
62         glocalfileoutputstream.h        \
63         glocalvfs.h                     \
64         gnativevolumemonitor.h          \
65         gnetworkingprivate.h            \
66         gnullsettingsbackend.h          \
67         gpollfilemonitor.h              \
68         gsettingsbackendinternal.h      \
69         gsettingsschema.h               \
70         gsettings-mapping.h             \
71         gthreadedresolver.h             \
72         gunionvolumemonitor.h           \
73         gunixdrive.h                    \
74         gunixresolver.h                 \
75         gunixvolume.h                   \
76         gvdb-builder.h                  \
77         gvdb-format.h                   \
78         gvdb-render.h                   \
79         gvolumeprivate.h                \
80         gwin32appinfo.h                 \
81         gwin32mount.h                   \
82         gwin32directorymonitor.h        \
83         gwin32inputstream.h             \
84         gwin32outputstream.h            \
85         gwin32volumemonitor.h           \
86         gwin32resolver.h                \
87         gwinhttpfile.h                  \
88         gwinhttpfileinputstream.h       \
89         gwinhttpfileoutputstream.h      \
90         gwinhttpvfs.h                   \
91         inotify-diag.h                  \
92         inotify-helper.h                \
93         inotify-kernel.h                \
94         inotify-missing.h               \
95         inotify-path.h                  \
96         inotify-sub.h                   \
97         local_inotify.h                 \
98         local_inotify_syscalls.h        \
99         xdgmime.h                       \
100         xdgmimealias.h                  \
101         xdgmimecache.h                  \
102         xdgmimeglob.h                   \
103         xdgmimeint.h                    \
104         xdgmimemagic.h                  \
105         xdgmimeparent.h                 \
106         xdgmimeicon.h                   \
107         winhttp.h                       \
108         $(NULL)
109
110 # CFLAGS and LDFLAGS for compiling scan program. Only needed
111 # if $(DOC_MODULE).types is non-empty.
112 INCLUDES = \
113         -I$(srcdir)                     \
114         -I$(top_srcdir)                 \
115         -I$(top_srcdir)/glib            \
116         -I$(top_srcdir)/gobject         \
117         -I$(top_srcdir)/gio             \
118         -I$(top_builddir)               \
119         -I$(top_builddir)/glib          \
120         -I$(top_builddir)/gobject       \
121         -I$(top_builddir)/gio           \
122         $(GLIB_DEBUG_FLAGS)
123
124 GTKDOC_LIBS = \
125         $(top_builddir)/glib/libglib-2.0.la             \
126         $(top_builddir)/gobject/libgobject-2.0.la       \
127         $(top_builddir)/gmodule/libgmodule-2.0.la       \
128         $(top_builddir)/gio/libgio-2.0.la               \
129         $(NULL)
130
131 # Extra options to supply to gtkdoc-mkdb
132 MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=g \
133         --ignore-files=libasyncns
134
135 # Images to copy into HTML directory
136 HTML_IMAGES =                   \
137         gvfs-overview.png
138
139 content_files =                 \
140         version.xml             \
141         overview.xml            \
142         migrating-posix.xml     \
143         migrating-gnome-vfs.xml \
144         migrating-gconf.xml     \
145         migrating-gdbus.xml     \
146         gio-querymodules.xml    \
147         glib-compile-schemas.xml\
148         gsettings.xml           \
149         gdbus.xml               \
150         $(NULL)
151
152 expand_content_files =          \
153         overview.xml            \
154         migrating-posix.xml     \
155         migrating-gnome-vfs.xml \
156         migrating-gconf.xml     \
157         migrating-gdbus.xml
158
159 extra_files =                   \
160         version.xml.in          \
161         gvfs-overview.odg
162
163 include $(top_srcdir)/gtk-doc.make
164
165 EXTRA_DIST +=                   \
166         version.xml.in
167
168 man_MANS =                      \
169         gio-querymodules.1      \
170         glib-compile-schemas.1  \
171         gsettings.1     \
172         gdbus.1
173
174 if ENABLE_MAN
175
176 .xml.1:
177         @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
178
179 dist-local-check-mans-enabled:
180         if grep "Man generation disabled" $(man_MANS) >/dev/null; then $(RM) $(man_MANS); fi
181
182 else
183
184 $(man_MANS):
185         echo Man generation disabled.  Creating dummy $@.  Configure with --enable-man to enable it.
186         echo Man generation disabled.  Remove this file, configure with --enable-man, and rebuild > $@
187
188 dist-local-check-mans-enabled:
189         echo "*** --enable-man must be used in order to make dist"
190         false
191
192 endif
193
194 MAINTAINERCLEANFILES = $(man_MANS) $(BUILT_SOURCES)
195
196 EXTRA_DIST += $(man_MANS)
197
198 dist-hook-local: dist-local-check-mans-enabled gio-docs-clean all-local
199
200 gio-docs-clean: clean
201         cd $(srcdir) && rm -rf xml html