mirror of
https://github.com/systemd/systemd.git
synced 2024-12-23 21:35:11 +03:00
libudev: add gtk-doc
This commit is contained in:
Kay Sievers
parent
7e8ea3320d
commit
26812f0a13
1
.gitignore
vendored
1
.gitignore
vendored
@ -23,3 +23,4 @@ configure
|
||||
stamp-h1
|
||||
depcomp
|
||||
udev-test-install
|
||||
gtk-doc.make
|
||||
|
||||
@ -20,6 +20,8 @@ CLEANFILES = \
|
||||
|
||||
ACLOCAL_AMFLAGS = -I m4
|
||||
|
||||
DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc
|
||||
|
||||
clean-local:
|
||||
rm -rf udev-test-install
|
||||
|
||||
@ -55,3 +57,6 @@ git-release:
|
||||
cat .git/refs/heads/master > .git/refs/tags/$(VERSION)
|
||||
git gc
|
||||
git prune
|
||||
|
||||
doc-sync:
|
||||
rsync -av --delete libudev/docs/html/ master.kernel.org:/pub/linux/utils/kernel/hotplug/libudev/
|
||||
|
||||
14
NEWS
14
NEWS
@ -3,12 +3,13 @@ udev 143
|
||||
Bugfixes.
|
||||
|
||||
Event processes now get re-used after they handled an event. This reduces
|
||||
pressure on the CPU significantly because cloned event processes no longer
|
||||
cause page faults in the main daemon. After the events have settled, a few
|
||||
worker processes stay around for future events, all others get cleaned up.
|
||||
the number of forks and the pressure on the CPU significantly, because
|
||||
cloned event processes no longer cause page faults in the main daemon.
|
||||
After the events have settled, a few worker processes stay around for
|
||||
future events, all others get cleaned up.
|
||||
|
||||
To be able to use signalfd(), udev depends on kernel version 2.6.25 now.
|
||||
Also inotify support is required now to run udev.
|
||||
Also inotify support is mandatory now to run udev.
|
||||
|
||||
The format of the queue exported by the udev damon has changed. There is
|
||||
no longer a /dev/.udev/queue/ directory. The current event queue can be
|
||||
@ -17,6 +18,11 @@ accessed with udevadm settle and libudedv.
|
||||
Libudev does not have the unstable API header anymore. From now on,
|
||||
incompatible changes will be handled by bumping the library major version.
|
||||
|
||||
To build udev from the git tree gtk-doc is needed now. The tarballs will
|
||||
build without it and contain the pre-built documentation. An online copy
|
||||
is available here:
|
||||
http://www.kernel.org/pub/linux/utils/kernel/hotplug/libudev/
|
||||
|
||||
udev 142
|
||||
========
|
||||
Bugfixes.
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
#!/bin/sh -e
|
||||
|
||||
gtkdocize
|
||||
autoreconf --install --symlink
|
||||
|
||||
CFLAGS="-g -Wall \
|
||||
@ -8,7 +9,7 @@ CFLAGS="-g -Wall \
|
||||
-Wpointer-arith -Wsign-compare -Wchar-subscripts \
|
||||
-Wstrict-prototypes -Wshadow \
|
||||
-Wformat=2 -Wtype-limits"
|
||||
args="--prefix=/usr --exec-prefix= --sysconfdir=/etc --with-selinux"
|
||||
args="--prefix=/usr --exec-prefix= --sysconfdir=/etc --with-selinux --enable-gtk-doc"
|
||||
libdir=$(basename $(cd /lib/$(gcc -print-multi-os-directory); pwd))
|
||||
|
||||
case "$1" in
|
||||
|
||||
@ -9,6 +9,7 @@ dnl AM_SILENT_RULES
|
||||
AC_SYS_LARGEFILE
|
||||
AC_CONFIG_MACRO_DIR([m4])
|
||||
AC_PROG_LIBTOOL
|
||||
GTK_DOC_CHECK(1.10)
|
||||
|
||||
dnl /* prefix is /usr, exec_prefix is /, if overridden exec_prefix follows prefix */
|
||||
AC_PREFIX_DEFAULT([/usr])
|
||||
@ -70,6 +71,8 @@ AC_CONFIG_FILES([
|
||||
Makefile
|
||||
libudev/Makefile
|
||||
libudev/libudev.pc
|
||||
libudev/docs/Makefile
|
||||
libudev/docs/version.xml
|
||||
udev/Makefile
|
||||
rules/Makefile
|
||||
extras/Makefile
|
||||
|
||||
@ -1,5 +1,8 @@
|
||||
include $(top_srcdir)/Makefile.am.inc
|
||||
|
||||
SUBDIRS = \
|
||||
docs
|
||||
|
||||
noinst_PROGRAMS = \
|
||||
test-libudev
|
||||
|
||||
|
||||
17
libudev/docs/.gitignore
vendored
Normal file
17
libudev/docs/.gitignore
vendored
Normal file
@ -0,0 +1,17 @@
|
||||
html/
|
||||
tmpl/
|
||||
xml/
|
||||
*.stamp
|
||||
version.xml
|
||||
libudev-decl-list.txt
|
||||
libudev-decl.txt
|
||||
libudev-overrides.txt
|
||||
libudev-undeclared.txt
|
||||
libudev-undocumented.txt
|
||||
libudev-unused.txt
|
||||
libudev.args
|
||||
libudev.hierarchy
|
||||
libudev.interfaces
|
||||
libudev.prerequisites
|
||||
libudev.signals
|
||||
|
||||
99
libudev/docs/Makefile.am
Normal file
99
libudev/docs/Makefile.am
Normal file
@ -0,0 +1,99 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
# We require automake 1.10 at least.
|
||||
AUTOMAKE_OPTIONS = 1.10
|
||||
|
||||
# This is a blank Makefile.am for using gtk-doc.
|
||||
# Copy this to your project's API docs directory and modify the variables to
|
||||
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
|
||||
# of using the various options.
|
||||
|
||||
# The name of the module, e.g. 'glib'.
|
||||
DOC_MODULE=libudev
|
||||
|
||||
# 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
|
||||
DOC_SOURCE_DIR=..
|
||||
|
||||
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
|
||||
SCANGOBJ_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-scan.
|
||||
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
|
||||
SCAN_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-mkdb.
|
||||
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
|
||||
MKDB_OPTIONS=--sgml-mode --output-format=xml
|
||||
|
||||
# Extra options to supply to gtkdoc-mktmpl
|
||||
# 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=
|
||||
|
||||
# Used for dependencies. The docs will be rebuilt if any of these change.
|
||||
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
|
||||
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
|
||||
HFILE_GLOB=$(top_srcdir)/libudev/libudev*.h
|
||||
CFILE_GLOB=$(top_srcdir)/libudev/libudev*.c
|
||||
|
||||
# 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=
|
||||
|
||||
# Images to copy into HTML directory.
|
||||
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
||||
HTML_IMAGES=
|
||||
|
||||
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
||||
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
|
||||
content_files = version.xml
|
||||
|
||||
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
|
||||
# These files must be listed here *and* in content_files
|
||||
# e.g. expand_content_files=running.sgml
|
||||
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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
||||
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
||||
GTKDOC_CFLAGS=
|
||||
GTKDOC_LIBS=
|
||||
|
||||
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
||||
include $(top_srcdir)/gtk-doc.make
|
||||
|
||||
# Other files to distribute
|
||||
# e.g. EXTRA_DIST += version.xml.in
|
||||
EXTRA_DIST += version.xml.in
|
||||
|
||||
# Files not to distribute
|
||||
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
|
||||
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
|
||||
#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
|
||||
31
libudev/docs/libudev-docs.sgml
Normal file
31
libudev/docs/libudev-docs.sgml
Normal file
@ -0,0 +1,31 @@
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
|
||||
[
|
||||
<!ENTITY version SYSTEM "version.xml">
|
||||
]>
|
||||
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
||||
<bookinfo>
|
||||
<title>libudev Reference Manual</title>
|
||||
<releaseinfo>for libudev version &version;</releaseinfo>
|
||||
<copyright>
|
||||
<year>2009</year>
|
||||
<holder>Kay Sievers <kay.sievers@vrfy.org></holder>
|
||||
</copyright>
|
||||
</bookinfo>
|
||||
|
||||
<chapter>
|
||||
<title>libudev</title>
|
||||
<xi:include href="xml/libudev.xml"/>
|
||||
<xi:include href="xml/libudev-list.xml"/>
|
||||
<xi:include href="xml/libudev-device.xml"/>
|
||||
<xi:include href="xml/libudev-monitor.xml"/>
|
||||
<xi:include href="xml/libudev-enumerate.xml"/>
|
||||
<xi:include href="xml/libudev-queue.xml"/>
|
||||
</chapter>
|
||||
|
||||
<index id="api-index-full">
|
||||
<title>API Index</title>
|
||||
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
||||
</index>
|
||||
</book>
|
||||
107
libudev/docs/libudev-sections.txt
Normal file
107
libudev/docs/libudev-sections.txt
Normal file
@ -0,0 +1,107 @@
|
||||
<SECTION>
|
||||
<FILE>libudev</FILE>
|
||||
<TITLE>udev</TITLE>
|
||||
udev
|
||||
udev_ref
|
||||
udev_unref
|
||||
udev_new
|
||||
udev_set_log_fn
|
||||
udev_get_log_priority
|
||||
udev_set_log_priority
|
||||
udev_get_sys_path
|
||||
udev_get_dev_path
|
||||
udev_get_userdata
|
||||
udev_set_userdata
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libudev-list</FILE>
|
||||
<TITLE>udev_list</TITLE>
|
||||
udev_list_entry
|
||||
udev_list_entry_get_next
|
||||
udev_list_entry_get_by_name
|
||||
udev_list_entry_get_name
|
||||
udev_list_entry_get_value
|
||||
udev_list_entry_foreach
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libudev-device</FILE>
|
||||
<TITLE>udev_device</TITLE>
|
||||
udev_device
|
||||
udev_device_ref
|
||||
udev_device_unref
|
||||
udev_device_get_udev
|
||||
udev_device_new_from_syspath
|
||||
udev_device_new_from_devnum
|
||||
udev_device_new_from_subsystem_sysname
|
||||
udev_device_get_parent
|
||||
udev_device_get_parent_with_subsystem_devtype
|
||||
udev_device_get_devpath
|
||||
udev_device_get_subsystem
|
||||
udev_device_get_devtype
|
||||
udev_device_get_syspath
|
||||
udev_device_get_sysname
|
||||
udev_device_get_sysnum
|
||||
udev_device_get_devnode
|
||||
udev_device_get_devlinks_list_entry
|
||||
udev_device_get_properties_list_entry
|
||||
udev_device_get_property_value
|
||||
udev_device_get_driver
|
||||
udev_device_get_devnum
|
||||
udev_device_get_action
|
||||
udev_device_get_sysattr_value
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libudev-monitor</FILE>
|
||||
<TITLE>udev_monitor</TITLE>
|
||||
udev_monitor
|
||||
udev_monitor_ref
|
||||
udev_monitor_unref
|
||||
udev_monitor_get_udev
|
||||
udev_monitor_new_from_netlink
|
||||
udev_monitor_new_from_socket
|
||||
udev_monitor_enable_receiving
|
||||
udev_monitor_get_fd
|
||||
udev_monitor_receive_device
|
||||
udev_monitor_filter_add_match_subsystem_devtype
|
||||
udev_monitor_filter_update
|
||||
udev_monitor_filter_remove
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libudev-enumerate</FILE>
|
||||
<TITLE>udev_enumerate</TITLE>
|
||||
udev_enumerate
|
||||
udev_enumerate_ref
|
||||
udev_enumerate_unref
|
||||
udev_enumerate_get_udev
|
||||
udev_enumerate_new
|
||||
udev_enumerate_add_match_subsystem
|
||||
udev_enumerate_add_nomatch_subsystem
|
||||
udev_enumerate_add_match_sysattr
|
||||
udev_enumerate_add_nomatch_sysattr
|
||||
udev_enumerate_add_match_property
|
||||
udev_enumerate_add_syspath
|
||||
udev_enumerate_scan_devices
|
||||
udev_enumerate_scan_subsystems
|
||||
udev_enumerate_get_list_entry
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>libudev-queue</FILE>
|
||||
<TITLE>udev_queue</TITLE>
|
||||
udev_queue
|
||||
udev_queue_ref
|
||||
udev_queue_unref
|
||||
udev_queue_get_udev
|
||||
udev_queue_new
|
||||
udev_queue_get_udev_is_active
|
||||
udev_queue_get_queue_is_empty
|
||||
udev_queue_get_seqnum_is_finished
|
||||
udev_queue_get_seqnum_sequence_is_finished
|
||||
udev_queue_get_queued_list_entry
|
||||
udev_queue_get_failed_list_entry
|
||||
</SECTION>
|
||||
|
||||
1
libudev/docs/version.xml.in
Normal file
1
libudev/docs/version.xml.in
Normal file
@ -0,0 +1 @@
|
||||
@VERSION@
|
||||
2
m4/.gitignore
vendored
2
m4/.gitignore
vendored
@ -1,2 +1,4 @@
|
||||
libtool.m4
|
||||
lt*m4
|
||||
gtk-doc.m4
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user