]> git.ipfire.org Git - thirdparty/systemd.git/commit
man: add libudev man-pages (skeletons) 253/head
authorDavid Herrmann <dh.herrmann@gmail.com>
Wed, 17 Jun 2015 13:11:11 +0000 (15:11 +0200)
committerDavid Herrmann <dh.herrmann@gmail.com>
Wed, 17 Jun 2015 13:22:49 +0000 (15:22 +0200)
commit06255d6f76f3f630a9634d745a48910b1ea3e4d3
treee445d0b8f29bf99023ed84fea080691de2dfc8b0
parentf1398fa59cd5b799b6be6e30c9d49ef98e8298a3
man: add libudev man-pages (skeletons)

This adds man-pages for most of the libudev symbols we export. Similar
symbols are grouped together in a single man-page, with respective links
added. All man-pages contain the full skeleton including NAME, SYNOPSIS,
RETURN VALUE and SEE ALSO. However, most of them still lack the
DESCRIPTION part. This should be copied from the gtkdoc descriptions in
src/libudev/libudev*.[ch]. Any help is welcome! (the whole skeleton is
already done, so it's really just about the prose-part of the man-pages to
be written).

Missing from the man-pages are the following parts:
  - udev_set_log_fn()
  - udev_[gs]et_log_priority()
  - udev_[gs]et_userdata()
  - udev_list_entry_foreach()
  - udev_device_get_seqnum()
  - udev_device_get_usec_since_initialized()
  - udev_util_encode_string()
These are considered legacy, afaik. If not, please feel free to add them
now!

Furthermore, udev-hwdb and udev-queue are not documented at all (for the
same reasons).
13 files changed:
Makefile-man.am
man/libudev.xml [new file with mode: 0644]
man/udev_device_get_syspath.xml [new file with mode: 0644]
man/udev_device_has_tag.xml [new file with mode: 0644]
man/udev_device_new_from_syspath.xml [new file with mode: 0644]
man/udev_enumerate_add_match_subsystem.xml [new file with mode: 0644]
man/udev_enumerate_new.xml [new file with mode: 0644]
man/udev_enumerate_scan_devices.xml [new file with mode: 0644]
man/udev_list_entry.xml [new file with mode: 0644]
man/udev_monitor_filter_update.xml [new file with mode: 0644]
man/udev_monitor_new_from_netlink.xml [new file with mode: 0644]
man/udev_monitor_receive_device.xml [new file with mode: 0644]
man/udev_new.xml [new file with mode: 0644]