mirror of
https://github.com/libusb/libusb.git
synced 2025-05-14 15:38:29 +00:00
4a5540a925
Change the name of the project to be what it actually is called
everywhere: libusb-1.0. This allows the public libusb.h header file to
be tracked by automake through pkginclude_HEADERS.
Decouple the doc directory from automake. There aren't any targets that
automake understands, so the build uselessly recurses into the directory.
Update the makefile targets with the correct dependencies so that the
docs aren't regenerated unnecessarily. Update the doxygen config file to
include the version, exclude irrelevant source files and create the
output into 'api-1.0' instead of 'html'. Also fix a deprecation tag for
the libusb_get_port_path() function and add Solaris to the list of
supported platforms.
Fix the 'dist' target. Clean up the README file to remote the GitHub
Markdown and remove the .gitattributes file from the msvc directory.
Add doc/libusb.png to EXTRA_DIST.
Enhance the {dist,doc}-upload targets to look at the SF_USER environment
variable to get the SourceForge username. This allows maintainers (like
me!) to have a local username that is different from their SourceForge
username. Switch the docs-upload recipe to use rsync with --delete to
clean up obsolete files.
Fix the Windows shared library (DLL) targets. The dependencies for the
RC file were incorrect, leading to cases of missed recompilation. The
'all' rule should not be overridden, so define an 'all-local' rule when
necessary. Fix the rule for running dlltool on the just generated DLL so
that it only fires when the correct dependencies change and do not
bother to run the rule when not building a DLL.
Signed-off-by: Chris Dickens <christopher.a.dickens@gmail.com>
41 lines
1.8 KiB
Text
41 lines
1.8 KiB
Text
Notes related to git compilation:
|
|
--------------------------------
|
|
|
|
If you retrieved the libusb repository from git and are using a gcc based
|
|
toolchain, be mindful that you should have the autotools installed (autoconf,
|
|
automake) and will need to run either ./autogen.sh or ./bootstrap.sh to produce
|
|
the configure file.
|
|
|
|
The difference between autogen.sh and bootstrap.sh is that the former invokes
|
|
configure with a default set of options, and will therefore generate a Makefile,
|
|
whereas the latter does not invoke configure at all. If using autogen.sh, note
|
|
that you can also append options, that will be passed as is to configure.
|
|
|
|
OS X-specific notes:
|
|
-------------------
|
|
|
|
Starting with Xcode 4.3, neither Xcode.app nor the Xcode 'command line tools'
|
|
includes autotools and so running either autogen.sh or bootstrap.sh will result
|
|
in the message:
|
|
|
|
libtoolize or glibtoolize was not found! Please install libtool.
|
|
|
|
To proceed, you must find and install it from somewhere.
|
|
|
|
Alternatively, you can use the Xcode project at Xcode/libusb.xcodeproj.
|
|
|
|
Notes related to submitting new developments:
|
|
--------------------------------------------
|
|
|
|
If you submit a new development to libusb (eg: new backend), that is unlikely
|
|
to fit in a couple of small patches, we would kindly suggest that you create a
|
|
public account on github, if you don't have one already, and then fork a new
|
|
libusb repository under this account from https://github.com/libusb/libusb.
|
|
|
|
Then you can create a git branch for your work, that we will be able to better
|
|
reference and test.
|
|
|
|
We also suggest that, if you are planning to bring in a large development, you
|
|
try to involve the libusb community early by letting the mailing list know, as
|
|
you may find that other people might be eager to help you out.
|
|
See http://mailing-list.libusb.info for details on how to join the mailing list.
|