Document check and distcheck make targets

Also synchronize ldconfig configuration documentation.
Hamlib-3.0
Nate Bargmann 2013-05-08 20:48:34 -05:00
rodzic 69c2ceb957
commit 0f2a53581b
3 zmienionych plików z 41 dodań i 9 usunięć

13
INSTALL
Wyświetl plik

@ -90,13 +90,18 @@ main directory and do the following:
/usr/local/lib
On Debian systems since at least 4.0 (Etch) and its derivatives (Ubuntu,
etc.), a file will need to be created in the /etc/ld.so.conf.d directory.
It doesn't seem to matter what you name it so long as it ends in .conf
and local.conf is a good choice. Place the following line in it:
Most modern distributions have an /etc/ld.so.conf.d/ directory where
local configuration can be made. Later versions of Debian and
derivatives have a file named 'libc.conf' in this directory. The
contents of libc.conf are:
# libc default configuration
/usr/local/lib
If your system does not have such a file, one will need to be created
and then `ldconfig' will need to be run as the root user so that
applications using the Hamlib libraries can find them.
Now `ldconfig' can be run.
While the programs built along with Hamlib will probably work fine

Wyświetl plik

@ -87,7 +87,6 @@ Optional, but highly recommended for a complete build:
* libgd2 devel # gdlib-config --version
* libusb devel # libusb-config --version (not 1.0.0!)
* libreadline devel # ver 5.2 or newer
* Git for connection to hamlib.git.sourceforge.net
N.B The libusb package is required for building most of the 'kit' backend.
The older version is needed, not 1.0.0 or higher. Debian and derivatives
@ -95,6 +94,7 @@ package libusb 0.1.12 which is what is needed.
Documentation:
* Doxygen
* Texinfo (for rebuilding the new info and HTML manual)
Git master branch daily snapshot build:
@ -105,6 +105,7 @@ to do the following commands.
./configure [--prefix=$HOME/local]
make
make check
make install
The prefix argument is optional. Convention is that local packages be
@ -118,6 +119,20 @@ Other useful options are '--with-perl-binding' or '--with-python-binding' or
those scripting languages If you are unsure it is safe to ignore these
options.
'make' will run the C and, optionally, the C++ compiler building all of the
binary object files and finally linking all of them together to form the
Hamlib "frontend" and "backend" libraries.
The 'make check' target will run a few predetermined tests using the 'dummy'
(rig model 1) backend and some other Hamlib functions in the build tree.
This is a basic sanity check and cannot test all backends.
The 'make install' target will require super user (root/administrator)
privileges when installing to the system directories as a normal user.
Some Linux distributions offer the 'sudo' command to grant temporary root
privileges or the 'su' command to login as "root". Consult your
distribution's documentation.
NOTE! If Hamlib has not been previously installed as a locally built
package you will need to make sure that 'ldconfig' is configured correctly
and run after 'make install'. Most modern distributions have an
@ -137,11 +152,11 @@ To delete the binary files from the source directory after compiling:
make clean
To also remove the Makefiles and other build files generated by 'configure',
along with the binary files as above:
along with the binary files as with 'make clean' above:
make distclean
The configure script will need to be run again as above.
The 'configure' script will need to be run again as above.
The above commands will clean things up so Hamlib can be compiled with other
configure script options.
@ -177,11 +192,11 @@ winradio,
yaesu,etc: rig backends
easycomm,rotorez,
sartek, etc: rotator backends
dummy: virtual dummy rig and rotator, for developer's use.
dummy: virtual dummy rig and rotator, for testing use.
lib: library for functions missing on your system
libltdl: wrapper for shared module loader
bindings Perl, Python, Tcl, and Visual Basic bindings
c++,kylix: C++ and Kylix bindings
c++: C++ bindings
doc: documentation base and scripts to extract from src
include/hamlib: exported header files go here
include: non-distributed header files go there

Wyświetl plik

@ -341,6 +341,18 @@ For a Tcl build, add this if needed:
Note: C-shell users may have to run autogen.sh and make through a bourne
shell instead, or pass "SHELL=bash" as a parameter to make.
Some basic testing is accomplished with the 'make check' target which will
run a few predetermined tests using the 'dummy' (rig model 1) backend and
some other Hamlib functions in the build tree. This is a basic sanity check
and cannot test all backends.
Likewise, a complete test of the build system is accomplished with
'make distcheck' which exercises a complete build sequence from creating
a distribution tarball, building, installing, uninstalling, and cleaning
Hamlib. All packages listed above except for Swig and Doxygen are required
for this target as neither the bindings or old documentation are generated
in a default build.
NOTE! If Hamlib has not been previously installed as a locally built
package you will need to make sure that `ldconfig' is configured correctly
and run periodically after `make install'. Most modern distributions have