Skip to content

Commit

Permalink
Add deprecation message for Autotools
Browse files Browse the repository at this point in the history
  • Loading branch information
Youw committed Sep 20, 2021
1 parent 695b01f commit 77128aa
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
10 changes: 9 additions & 1 deletion BUILD.autotools.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Building HIDAPI using Autotools
# Building HIDAPI using Autotools (deprecated)

---
**NOTE**: for all intentions and purposes the Autotools build scripts for HIDAPI are _deprecated_ and going to be obsolete in the future.
HIDAPI Team recommends using CMake build for HIDAPI.
If you are already using Autotools build scripts provided by HIDAPI,
consider switching to CMake build scripts as soon as possible.

---

To be able to use Autotools to build HIDAPI, it has to be [installed](#installing-autotools)/available in the system.

Expand Down
6 changes: 4 additions & 2 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@
For various reasons you may need to build HIDAPI on your own.

It can be done in several different ways:
- using [Autotools](BUILD.autotools.md);
- using [CMake](BUILD.cmake.md);
- using [Autotools](BUILD.autotools.md) (deprecated);
- using [manual makefiles](#building-the-manual-way-on-unix-platforms).

**Autotools** build system is historically first mature build system for
HIDAPI. Most common usage of it is in its separate README: [BUILD.autotools.md](BUILD.autotools.md).
HIDAPI. Most common usage of it is in its separate README: [BUILD.autotools.md](BUILD.autotools.md).<br/>
NOTE: for all intentions and purposes the Autotools build scripts for HIDAPI are _deprecated_ and going to be obsolete in the future.
HIDAPI Team recommends using CMake build for HIDAPI.

**CMake** build system is de facto an industry standard for many open-source and proprietary projects and solutions.
HIDAPI is one of the projects which uses the power of CMake for its advantage.
Expand Down
3 changes: 3 additions & 0 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ AC_PREREQ(2.63)

AC_INIT([hidapi],[m4_normalize(m4_builtin([include], VERSION))],[https://github.com/libusb/hidapi/issues])

echo "This build script for HIDAPI is deprecated."
echo "Consider using CMake instead."

# Library soname version
# Follow the following rules (particularly the ones in the second link):
# http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html
Expand Down

0 comments on commit 77128aa

Please sign in to comment.