sg_logs: add media changer diagnostic data page; change doco for src, include and lib subdirectories

git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@102 6180dd3e-e324-4e3e-922d-17de1ae2f315

1 files changed, 20 insertions, 15 deletions

diff --git a/INSTALL b/INSTALL
index 5116f3eb..f5d6615e 100644
--- a/INSTALL
+++ b/INSTALL
@@ -4,7 +4,12 @@
 Introduction
 ============
 During the development of sg3_utils version 1.25 this package was changed to
-use autotools. Prior to version 1.25 it used handed crafted Makefiles.
+use autotools. Prior to version 1.25 it used handed crafted Makefiles. Also
+the relatively flat directory structure was made deeper in version 1.25. Now
+each utility's main source file is found in the 'src' subdirectory. That
+code typically depends on header files now placed in the 'include'
+subdirectory and library code placed in the 'lib' subdirectory. The man page
+code for each utility has been moved to the 'doc' subdirectory.
 
 In most cases the build process is now:
   a) fetch the source tarball, untar it and go to the top level directory,
@@ -27,15 +32,15 @@ this: './configure --prefix=/usr' . To check that the code compiles clean
 as C++ (with g++) step b) may be changed to "./configure CC=g++". See the
 output of './configure --help' for more information about build options.
 
-The two script files that drive the autotools build are configure.ac and
-Makefile.am . If the former is changed, autoconf should be run and if the
-latter is changed, automake should be run. More simply if either is changed
-the autogen.sh script can be run.
+The script files that drive the autotools build are configure.ac and
+Makefile.am . There is an instance of Makefile.am found in the main directory
+and the 'lib', 'include', 'src' and 'doc' subdirectories. If any of these
+files are changed, the 'autogen.sh' script in the main directory should be
+run.
 
-Note that only the utilities in the main directory are build by the
-'./configure' infrastructure. [An exception: the code is the getopt_long
-directory is built for OSF (Tru64).] Code in the examples, utils and
-archives directories can be built with simple Makefiles which are
+Note that only the utilities in the 'src' subdirectory are build by
+the './configure' infrastructure. Code in the 'examples', 'utils'
+and 'archives' directories can be built with simple Makefiles which are
 typically found in those directories.
 
 
@@ -75,7 +80,7 @@ Introduction section above.
 
 Utilities that are linux specific (e.g. sg_map) are not built for
 FreeBSD. See the "bin_PROGRAMS" definition within the OS_FREEBSD
-conditional of the Makefile.am file for a definitive list.
+conditional of the various Makefile.am files for a definitive list.
 
 
 Solaris
@@ -85,7 +90,7 @@ Introduction section above.
 
 Utilities that are linux specific (e.g. sg_map) are not built for
 Solaris. See the "bin_PROGRAMS" definition within the OS_SOLARIS
-conditional of the Makefile.am file for a definitive list.
+conditional of the various Makefile.am files for a definitive list.
 
 
 Tru64 (OSF)
@@ -95,7 +100,7 @@ Introduction section above.
 
 Utilities that are linux specific (e.g. sg_map) are not built for
 Tru64. See the "bin_PROGRAMS" definition within the OS_OSF
-conditional of the Makefile.am file for a definitive list.
+conditional of the various Makefile.am files for a definitive list.
 
 
 Windows
@@ -113,8 +118,8 @@ such as 'gcc' (the GNU C compiler) and 'make' need to be loaded as they are
 not in the minimal cygwin default distribution. The utilities can be built
 and installed as shown in the Introduction section above. Utilities that
 are linux specific (e.g. sg_map) are not built for cygwin. See the
-"bin_PROGRAMS" definition within the OS_CYGWIN conditional of the
-Makefile.am file for a definitive list. Currently the make doesn't build a
+"bin_PROGRAMS" definition within the OS_CYGWIN conditional of the various
+Makefile.am files for a definitive list. Currently the make doesn't build a
 dll (cf shared libraries are built on Linux and FreeBSD) so the executable
 files are bigger than they need to be. Once built, the various ".exe"
 commands can either be executed in a cygwin shell (typically "bash") or a
@@ -132,5 +137,5 @@ Makefile.am file for a definitive list. The executables have a '.exe'
 extension and can be executed in a MSYS or "cmd" shell.
 
 
-30th August 2007
+16th September 2007
 Doug Gilbert