]> git.proxmox.com Git - systemd.git/blame - docs/libudev/Makefile.am
Imported Upstream version 219
[systemd.git] / docs / libudev / Makefile.am
CommitLineData
663996b3
MS
1## Process this file with automake to produce Makefile.in
2
3# We require automake 1.10 at least.
4AUTOMAKE_OPTIONS = 1.10 color-tests
5
6# This is a blank Makefile.am for using gtk-doc.
7# Copy this to your project's API docs directory and modify the variables to
8# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
9# of using the various options.
10
11# The name of the module, e.g. 'glib'.
12DOC_MODULE=libudev
13
14# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
15#DOC_MODULE_VERSION=2
16
17# The top-level SGML file. You can change this if you want to.
18DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
19
20# The directory containing the source code. Relative to $(srcdir).
21# gtk-doc will search all .c & .h files beneath here for inline comments
22# documenting the functions and macros.
23# e.g. DOC_SOURCE_DIR=../../../gtk
24DOC_SOURCE_DIR=$(top_srcdir)/src/libudev
25
26# Extra options to pass to gtkdoc-scangobj. Not normally needed.
27SCANGOBJ_OPTIONS=
28
29# Extra options to supply to gtkdoc-scan.
30# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
31SCAN_OPTIONS=
32
33# Extra options to supply to gtkdoc-mkdb.
34# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
35MKDB_OPTIONS=--xml-mode --output-format=xml --name-space=udev
36
37# Extra options to supply to gtkdoc-mktmpl
38# e.g. MKTMPL_OPTIONS=--only-section-tmpl
39MKTMPL_OPTIONS=
40
41# Extra options to supply to gtkdoc-mkhtml
42MKHTML_OPTIONS=--path=$(abs_srcdir) --path=$(abs_builddir)
43
44# Extra options to supply to gtkdoc-fixref. Not normally needed.
45# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
46FIXXREF_OPTIONS=>/dev/null 2>&1
47
48# Used for dependencies. The docs will be rebuilt if any of these change.
49# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
50# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
51HFILE_GLOB=$(top_srcdir)/src/libudev/libudev*.h
52CFILE_GLOB=$(top_srcdir)/src/libudev/libudev*.c
53
54# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
55# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
56EXTRA_HFILES=
57
58# Header files to ignore when scanning. Use base file name, no paths
59# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
e735f4d4 60IGNORE_HFILES = libudev-private.h
663996b3
MS
61
62# Images to copy into HTML directory.
63# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
64HTML_IMAGES=
65
66# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
67# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
68content_files = version.xml
69
70# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
71# These files must be listed here *and* in content_files
72# e.g. expand_content_files=running.sgml
73expand_content_files=
74
75# Hack, hack. You silly gtk-doc, you must not add CFLAGS multiple
76# times when calling gcc; it surely can not work with options that must
77# be listed only once.
78# Kill CFLAGS here because gtk-doc thinks adding CFLAGS to CC _and_ also
79# adding CFLAGS itself again would work.
80override CFLAGS=
81override LDFLAGS=
82
83# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
84# Only needed if you are using gtkdoc-scangobj to dynamically query widget
85# signals and properties.
86# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
87# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
88GTKDOC_CFLAGS=
89GTKDOC_LIBS=
90
91# This includes the standard gtk-doc make rules, copied by gtkdocize.
92include $(top_srcdir)/docs/gtk-doc.make
93
94# Other files to distribute
95# e.g. EXTRA_DIST += version.xml.in
96EXTRA_DIST += version.xml.in
97
98# Files not to distribute
99# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
100# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
101#DISTCLEANFILES +=
102
103# Comment this out if you want your docs-status tested during 'make check'
104if ENABLE_GTK_DOC
105if ENABLE_GTK_DOC_TESTS
106#TESTS_ENVIRONMENT = cd $(top_srcdir)
107#TESTS = $(GTKDOC_CHECK)
108endif
109endif