Changeset 3651

Timestamp:

Apr 4, 2005, 12:21:18 PM (21 years ago)

Author:

desonia

Message:

merged changes from rel5.

Location:

trunk/psModules

Files:

• . (modified) (1 prop)
• .cvsignore (modified) (1 diff)
• Doxyfile.in (added)
• Makefile.am (modified) (1 diff)
• configure.ac (modified) (2 diffs)
• psmodule-config.in (added)
• psmodule.pc.in (added)
• src/Doxyfile (deleted)
• src/mainpage.dox (modified) (4 diffs)

trunk/psModules

@@ -7 +7 @@
 aclocal.m4
 configure
+Doxyfile
+DoxygenLog
+docs
+man
+psmodule-config
+psmodule.pc
+bin
+include
+lib

@@ -7 +7 @@
 aclocal.m4
 configure
+Doxyfile
+DoxygenLog
+docs
+man
+psmodule-config
+psmodule.pc
+bin
+include
+lib

trunk/psModules/.cvsignore

@@ -7 +7 @@
 aclocal.m4
 configure
+Doxyfile
+DoxygenLog
+docs
+man
+psmodule-config
+psmodule.pc
+bin
+include
+lib
 

trunk/psModules/Makefile.am

@@ -1 @@
-AUTOMAKE_OPTIONS = foreign 1.4
 
 SUBDIRS = src test
 
+bin_SCRIPTS = psmodule-config
+
+pkgconfigdir = $(libdir)/pkgconfig
+pkgconfig_DATA= psmodule.pc
+
+EXTRA_DIST = Doxyfile.in psmodule-config.in psmodule.pc.in
+
+docs: Doxyfile $(prefix)/docs/psmodule $(mandir)/man3
+        $(DOXYGEN)
+        mv -f $(prefix)/docs/psmodule/man/man3/* $(mandir)/man3
+        rm -rf $(prefix)/docs/psmodule/man
+
+$(prefix)/docs/psmodule:
+        mkdir -p $(prefix)/docs/psmodule
+
+$(mandir)/man3:
+        mkdir -p $(mandir)/man3
+
+uninstall-hook:
+        rm -rf $(prefix)/docs/psmodule/*
+
+CLEANFILES = $(prefix)/docs/psmodule/*
+
 test: check

trunk/psModules/configure.ac

@@ -10 +10 @@
 AC_SUBST(CFLAGS)
 
-CFLAGS="${CFLAGS=} -Wall -Werror -std=c99 -D_GNU_SOURCE"
+AC_MSG_CHECKING([C99 flag])
+if test "$GCC" == "yes"
+then
+CFLAGS="${CFLAGS=} -std=gnu99"
+AC_MSG_RESULT([-std=gnu99])
+else
+CFLAGS="${CFLAGS=} -std=c99"
+AC_MSG_RESULT([-std=c99])
+fi
+
+AC_GNU_SOURCE
 
 AC_PROG_INSTALL
 AM_PROG_LIBTOOL
+
+AC_PREFIX_DEFAULT([`pwd`])
+test "$prefix" = NONE && prefix=`pwd`
+
+DOXYGEN="doxygen Doxyfile"
+AC_CHECK_PROG(DOXYGEN,doxygen,[echo Doxygen not detected in configure stage.])
+AC_SUBST(DOXYGEN,$DOXYGEN)
 
 AC_ARG_WITH(pslib-config,
@@ -33 +50 @@
 AC_CHECK_LIB(pslib,main,,AC_MSG_ERROR(psLib library required))
 
-AC_OUTPUT(Makefile src/Makefile test/Makefile)
+CFLAGS="${CFLAGS=} -Wall -Werror"
+
+AC_CONFIG_FILES([Makefile])
+AC_CONFIG_FILES([src/Makefile])
+AC_CONFIG_FILES([test/Makefile])
+AC_CONFIG_FILES([Doxyfile])
+AC_CONFIG_FILES([psmodule-config])
+AC_CONFIG_FILES([psmodule.pc])
+
+AC_OUTPUT

trunk/psModules/src/mainpage.dox

@@ -17 +17 @@
  - Combine readouts (pmReadoutCombine)
  - Subtract sky (pmSubtractSky)
+ - Object detection (pmObjects)
 
+The installed code for psModule consists of header files and a binary library.
 
-The installed code for psModule consists of header files and a static binary library (libpsmodule.a).
+@section extinstall Required external Libraries
 
-@section extinstall Required 3rd Party Libraries
-
-Before building psLib from source, several 3rd party software libraries must
+Before building psLib from source, several external software libraries must
 be installed. These include:
  - Pan-STARRS Library (psLib)
      - Available from the Maui High Performance Computiong Center (MHPCC) at https://mhpcc.pan-starrs.org/code/releases
-     - Compatibility tested with rel3
- - GNU Scientific Library (GSL)
-     - Available at http://www.gnu.org/software/gsl
-     - Compatibility tested with version is 1.4
- - Fastest Fourier Transform in the West (FFTW), version 3
-     - Available at http://www.fftw.org
-     - Compatibility tested with version is 3.0.1
- - C Flexible Image Transport System Input output (CFITSIO), version 2.480 or later
-     - Available at http://heasarc.gsfc.nasa.gov/docs/software/fitsio
-     - Compatibility tested with version is 2.490
-     - Versions earlier than 2.480 will not work as new functionality introduced in 2.480 is exercised
+     - Compatibility tested with rel5
+     - Note, psLib itself has many external library dependencies.
  - Doxygen Documentation System
+     - Only needed if code documentation is to be made
      - Available at http://www.doxygen.org
      - Compatibility tested with version 1.3.6
      - The optional companion package, GraphViz (a.k.a., the 'dot' command), is recommended to enable header-file dependency diagrams
- - SLALIB
-     - Available at http://star-www.rl.ac.uk/
-     - Compatibility tested with package version number 2.4-12
- - Gnome XML C parser and toolkit (libxml2)
-     - Available at http://www.xmlsoft.org
-     - Compatibility tested with version 2-2.6.16-3
 
 We recommend using the particular versions listed as compatibility tested, as
@@ -81 +67 @@
 where:
   - USERNAME is your login name on the server
-  - RELEASEBRANCH is the desired release branch, e.g. rel1.
+  - RELEASEBRANCH is the desired release branch, e.g. rel5.
 
 
-@section build How to Build the psModule library.
+@section build How to Build and Test the psModule Library.
 
 The psModule library and associated tests are made via the GNU autoconf/automake system.
@@ -92 +78 @@
 <pre>
 $ cd psModule
-$ configure --with-psLib=/home/kaiser/psLib (NB: Directory for psLib will vary)
+$ ./configure
 $ make
+$ make check
+$ make install
 </pre>
-<i>This builds files in psModule/src and psModule/test.</i>
+<i>Unless otherwise specified, the library is installed with PREFIX of the current directory.</i>
 
-Other configuration options, such as location of other 3rd party libraries, are also available.
+Other configuration options, such as location of external libraries, are also available.
 To get a list of options, type the following in the top psModule directory.
 <pre>
 $ configure --help
 </pre>
-
-@section run How to Build and Run Tests
-
-To test the installation, users may execute the unit tests which was automatically built
-when the user performs a make from the psModule directory.
-<pre>
-$ cd psModule/test
-$ ./FullUnitTest
-</pre>
-<i>This executes all test drivers in psModule/test.</i>
+A likely option needed is '--with-pslib-config', which specifies the location of
+the configuration script for psLib.  By default, iconfigure searches for it using PATH, but that
+is often not sufficient.
 
 @section doc How to Create Code Documentation
@@ -118 +99 @@
 documentation embedded in the code using the following commands:
 <pre>
-$ cd psModule/src
-$ doxygen
+$ cd psModule
+$ make docs
 </pre>
-<i>This places documentation in psModule/docs.</i>
+<i>This places documentation in PREFIX/docs.</i>
 
 Also, a prebuilt set of code documentation for both the releases and last

@@ -7 +7 @@
 aclocal.m4
 configure
+Doxyfile
+DoxygenLog
+docs
+man
+psmodule-config
+psmodule.pc
+bin
+include
+lib