HACKING 2.84 KB
Newer Older
Daniel Drake's avatar
Daniel Drake committed
1 2 3 4 5 6 7 8 9 10 11
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.


Daniel Drake's avatar
Daniel Drake committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
USB
===

At the time of development, there are no known consumer fingerprint readers
which do not operate over the USB bus. Therefore the library is designed around
the fact that each driver drivers USB devices, and each device is a USB device.
If we were to ever support a non-USB device, some rearchitecting would be
needed, but this would not be a substantial task.


GLib
====

Although the library uses GLib internally, libfprint is designed to provide
a completely neutral interface to it's application users. So, the public
APIs should never return GLib data types or anything like that.


Two-faced-ness
==============

Like any decent library, this one is designed to provide a stable and
documented API to it's users: applications. Clear distinction is made between
data available internally in the library, and data/functions available to
the applications.

This library is confused a little by the fact that there is another 'interface'
at hand: the internal interface provided to drivers. So, we effectively end
up with 2 APIs:

 1. The external-facing API for applications
 2. The internal API for fingerprint drivers

Daniel Drake's avatar
Daniel Drake committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
Non-static functions which are intended for internal use only are prepended
with the "fpi_" prefix.


API stability
=============

No API stability has been promised to anyone: go wild, there's no issue with
breaking APIs at this point in time.


Portability
===========

libfprint is primarily written for Linux. However, I'm interested in
supporting efforts to port this to other operating systems too.

You should ensure code is portable wherever possible. Try and use GLib rather
than OS-specific features.

Endianness must be considered in all code. libfprint must support both big-
and little-endian systems.


Coding Style
============

This project follows Linux kernel coding style but with a tab width of 4.


Documentation
=============

All additions of public API functions must be accompanied with doxygen
comments.

All changes which potentially change the behaviour of the public API must
be reflected by updating the appropriate doxygen comments.


Contributing
============

88 89
Patches should be sent to the fprint bugzilla:
https://bugs.freedesktop.org/enter_bug.cgi?product=libfprint
Daniel Drake's avatar
Daniel Drake committed
90 91

Information about libfprint development repositories can be found here:
92
http://www.freedesktop.org/wiki/Software/fprint/libfprint
Daniel Drake's avatar
Daniel Drake committed
93 94 95

If you're looking for ideas for things to work on, look at the TODO file or
grep the source code for FIXMEs.
Daniel Drake's avatar
Daniel Drake committed
96