Doc and build updates
Add ChangeLog generation makefile target. Group all copyright notices in AUTHORS. Update some doxygen comments, and allow fp_dev_close(NULL)
This commit is contained in:
parent
06e8040956
commit
069b4a30eb
9 changed files with 41 additions and 8 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -21,3 +21,4 @@ install-sh
|
||||||
.deps
|
.deps
|
||||||
.libs
|
.libs
|
||||||
compile
|
compile
|
||||||
|
ChangeLog
|
||||||
|
|
8
AUTHORS
8
AUTHORS
|
@ -1 +1,7 @@
|
||||||
Daniel Drake <dsd@gentoo.org>
|
Copyright (C) 2007 Daniel Drake <dsd@gentoo.org>
|
||||||
|
Copyright (C) 2006-2007 Timo Hoenig <thoenig@suse.de>
|
||||||
|
Copyright (C) 2006 Pavel Machek <pavel@suse.cz>
|
||||||
|
Copyright (C) 1999 Erik Walthinsen <omega@cse.ogi.edu>
|
||||||
|
Copyright (C) 2004,2006 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||||
|
Copyright (C) 2007 Cyrille Bagard
|
||||||
|
Copyright (C) 2007 Vasily Khoruzhick
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
The ChangeLog is maintained in the git source control system.
|
|
11
HACKING
11
HACKING
|
@ -1,3 +1,14 @@
|
||||||
|
Copyright notices
|
||||||
|
=================
|
||||||
|
|
||||||
|
If you make a contribution substantial enough to add or update a copyright
|
||||||
|
notice on a file, such notice must be mirrored in the AUTHORS file. This is
|
||||||
|
to make it easy for people to comply to section 6 of the LGPL, which states
|
||||||
|
that a "work that uses the Library" must include copyright notices from
|
||||||
|
this library. By providing them all in one place, hopefully we save such
|
||||||
|
users some time.
|
||||||
|
|
||||||
|
|
||||||
USB
|
USB
|
||||||
===
|
===
|
||||||
|
|
||||||
|
|
|
@ -10,3 +10,9 @@ pkgconfigdir=$(libdir)/pkgconfig
|
||||||
pkgconfig_DATA=libfprint.pc
|
pkgconfig_DATA=libfprint.pc
|
||||||
DISTCLEANFILES=libfprint.pc
|
DISTCLEANFILES=libfprint.pc
|
||||||
|
|
||||||
|
.PHONY: ChangeLog
|
||||||
|
ChangeLog:
|
||||||
|
git --git-dir $(top_srcdir)/.git log > ChangeLog
|
||||||
|
|
||||||
|
dist-hook: ChangeLog
|
||||||
|
|
||||||
|
|
8
README
8
README
|
@ -17,9 +17,15 @@ http://www.reactivated.net/fprint/Libfprint
|
||||||
libfprint is licensed under the GNU LGPL version 2.1. See the COPYING file
|
libfprint is licensed under the GNU LGPL version 2.1. See the COPYING file
|
||||||
for the license text.
|
for the license text.
|
||||||
|
|
||||||
|
Section 6 of the license states that for compiled works that use this
|
||||||
|
library, such works must include libfprint copyright notices alongside the
|
||||||
|
copyright notices for the other parts of the work. We have attempted to
|
||||||
|
make this process slightly easier for you by grouping these all in one place:
|
||||||
|
the AUTHORS file.
|
||||||
|
|
||||||
libfprint includes code from NIST's NBIS software distribution:
|
libfprint includes code from NIST's NBIS software distribution:
|
||||||
http://fingerprint.nist.gov/NBIS/index.html
|
http://fingerprint.nist.gov/NBIS/index.html
|
||||||
We include bozorth3 from the US export controlled distribution. We have
|
We include bozorth3 from the US export controlled distribution. We have
|
||||||
determined that it is fine to ship bozorth3 in an open source project,
|
determined that it is fine to ship bozorth3 in an open source project,
|
||||||
see http://reactivated.net/fprint/US_export_control
|
see http://reactivated.net/fprint/wiki/US_export_control
|
||||||
|
|
||||||
|
|
1
THANKS
1
THANKS
|
@ -6,4 +6,3 @@ Craig Watson (NIST)
|
||||||
James Vasile (SFLC)
|
James Vasile (SFLC)
|
||||||
Toby Howard (University of Manchester)
|
Toby Howard (University of Manchester)
|
||||||
Seemant Kulleen
|
Seemant Kulleen
|
||||||
Vasily Khoruzhick
|
|
||||||
|
|
|
@ -453,7 +453,8 @@ API_EXPORTED struct fp_dscv_dev **fp_discover_devs(void)
|
||||||
* Free a list of discovered devices. This function destroys the list and all
|
* Free a list of discovered devices. This function destroys the list and all
|
||||||
* discovered devices that it included, so make sure you have opened your
|
* discovered devices that it included, so make sure you have opened your
|
||||||
* discovered device <b>before</b> freeing the list.
|
* discovered device <b>before</b> freeing the list.
|
||||||
* \param devs the list of discovered devices
|
* \param devs the list of discovered devices. If NULL, function simply
|
||||||
|
* returns.
|
||||||
*/
|
*/
|
||||||
API_EXPORTED void fp_dscv_devs_free(struct fp_dscv_dev **devs)
|
API_EXPORTED void fp_dscv_devs_free(struct fp_dscv_dev **devs)
|
||||||
{
|
{
|
||||||
|
@ -619,10 +620,13 @@ static void do_close(struct fp_dev *dev)
|
||||||
/** \ingroup dev
|
/** \ingroup dev
|
||||||
* Close a device. You must call this function when you are finished using
|
* Close a device. You must call this function when you are finished using
|
||||||
* a fingerprint device.
|
* a fingerprint device.
|
||||||
* \param dev the device to close
|
* \param dev the device to close. If NULL, function simply returns.
|
||||||
*/
|
*/
|
||||||
API_EXPORTED void fp_dev_close(struct fp_dev *dev)
|
API_EXPORTED void fp_dev_close(struct fp_dev *dev)
|
||||||
{
|
{
|
||||||
|
if (!dev)
|
||||||
|
return;
|
||||||
|
|
||||||
fp_dbg("");
|
fp_dbg("");
|
||||||
|
|
||||||
if (g_slist_index(opened_devices, (gconstpointer) dev) == -1)
|
if (g_slist_index(opened_devices, (gconstpointer) dev) == -1)
|
||||||
|
|
|
@ -378,7 +378,7 @@ API_EXPORTED int fp_print_data_from_dscv_print(struct fp_dscv_print *print,
|
||||||
|
|
||||||
/** \ingroup print_data
|
/** \ingroup print_data
|
||||||
* Frees a stored print. Must be called when you are finished using the print.
|
* Frees a stored print. Must be called when you are finished using the print.
|
||||||
* \param data the stored print to destroy
|
* \param data the stored print to destroy. If NULL, function simply returns.
|
||||||
*/
|
*/
|
||||||
API_EXPORTED void fp_print_data_free(struct fp_print_data *data)
|
API_EXPORTED void fp_print_data_free(struct fp_print_data *data)
|
||||||
{
|
{
|
||||||
|
@ -586,7 +586,8 @@ API_EXPORTED struct fp_dscv_print **fp_discover_prints(void)
|
||||||
* Frees a list of discovered prints. This function also frees the discovered
|
* Frees a list of discovered prints. This function also frees the discovered
|
||||||
* prints themselves, so make sure you do not use any discovered prints
|
* prints themselves, so make sure you do not use any discovered prints
|
||||||
* after calling this function.
|
* after calling this function.
|
||||||
* \param prints the list of discovered prints
|
* \param prints the list of discovered prints. If NULL, function simply
|
||||||
|
* returns.
|
||||||
*/
|
*/
|
||||||
API_EXPORTED void fp_dscv_prints_free(struct fp_dscv_print **prints)
|
API_EXPORTED void fp_dscv_prints_free(struct fp_dscv_print **prints)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in a new issue