move build recipes to folder doc

git-svn-id: https://svn.mcs.anl.gov/repos/parallel-netcdf/branches/am@2966 c368ceb8-fd28-0410-a457-e46ee1d7cd4a

Author: wkliao

INSTALL

@@ -43,11 +43,11 @@ default configuration of PnetCDF up and running.
     different command syntax. Command "echo $SHELL" prints out the current
     shell used by your terminal program.
 
-(b) Unpack the tar file and go to the top level directory:
+(b) Unpack the tar file and go to the top level directory, for example:
 
-      gunzip parallel-netcdf-1.6.0.tar.gz
-      tar xf parallel-netcdf-1.6.0.tar
-      cd parallel-netcdf-1.6.0
+      gunzip parallel-netcdf-1.8.0.tar.gz
+      tar xf parallel-netcdf-1.8.0.tar
+      cd parallel-netcdf-1.8.0
 
 (c) Choose an installation directory, say $HOME/PnetCDF
 
@@ -155,7 +155,7 @@ Some influential environment variables:
   MPICXX      MPI C++ compiler
   MPIF77      MPI Fortran 77 compiler
   MPIF90      MPI Fortran 90 compiler
-  CC          Overwritten by MPICC if MPICC is set
+  CC          Overwritten by MPICC  if MPICC  is set
   CXX         Overwritten by MPICXX if MPICXX is set
   F77         Overwritten by MPIF77 if MPIF77 is set
   FC          Overwritten by MPIF90 if MPIF90 is set
@@ -202,7 +202,7 @@ Some influential environment variables:
     of compiler not found.
 
  - For platform-specific build instructions, see one of the README.<ARCH>
-   files.  
+   files in directory doc/.  
 
 
 ----
@@ -260,9 +260,10 @@ Currently, the testing uses up to 8 processes. Hence, please make sure the
 process allocation at least contains 8 processes.
 
 One can also run "make ptest" on batch queue systems. One example PBS script is
-provide "pbs.script". It is recommended to build all the testing executables
-before submitting the batch job. This can be done by running the below command.
-    cd test ; make ; cd ../examples ; make ; cd ..
+provide "pbs.script" in directory doc/. It is recommended to build all the
+testing executables before submitting the batch job. This can be done by
+running the below command.
+    make tests
 
 Note on setting TESTOUTDIR. In order to run parallel test correctly, the
 output directory must be on a file system accessible to all MPI processes.  We
@@ -283,84 +284,3 @@ Issue with older MPI-IO implementation.
 
 Please send an email to [email protected]
 
-
-
------------------------------------------------------------------------------
-Notes from previous releases
------------------------------------------------------------------------------
-
-To INSTALL parallel netCDF library:
-
-    1. 'autoreconf' (only necessary if you make changes to configure.in or
-        other configure-related files)
-
-    2. ./configure --prefix=<install dir> --with-mpi=/path/to/implementation
-	the --with-mpi argument should specify the prefix of where the mpi
-	implementation was installed.  If your mpicc is in
-	/usr/local/mpich-1.2.3/bin/mpicc then use the prefix
-	--with-mpi=/usr/local/mpich-1.2.3
-
-    NOTE: If configure cannot find your MPI implementation's C and/or
-	  Fortran compilers, define MPICC, MPICXX, MPIF77 and MPIF90
-	  environment variables to be the name of those compilers.  The
-	  configure script will then use those values instead of trying
-	  to guess.
-
-    3. make 
-
-       We have tried to make the Makefiles platform-independent.
-       However, each platform has its own make quirks:  if you run into
-       problems, please send a report to the developers at
-       [email protected].  If you have GNU Make, try using
-       that.
-
-    4. make install
-
-IF THIS DOESN'T WORK:
-
-Autoconf should do the right thing: using the system compiler to perform
-autoconf tests and then use the MPI compilers to build parallel-netcdf.
-If you need to set specific flags for a platform, and autoconf does not
-set them for you, then you will have to set some environment variables
-to help out the configure script.   Here are some suggested settings:
-
-       For Solaris
-            MPICC=mpicc
-
-       For SGI Origin2000
-            MPICC = mpicc
-            ------------ OR -------------
-            CC='/bin/cc -64 -mips4 -lmpi'
-            CPPFLAGS=-DNDEBUG
-            CFLAGS=-O
-            FC='/bin/f90 -64'
-            FFLAGS=-O
-            F90='/bin/f90 -64'
-            CXX='/bin/CC -64'
-            CXXFLAGS=-O
-
-       For Linux
-            MPICC=mpicc
-            CPPFLAGS='-DNDEBUG -Df2cFortran'
-            CFLAGS=-O
-            CXX=g++
-            FFLAGS='-O -W'
-
-       For IBM SP-2
-            MPICC mpcc_r
-            MPIF77 /bin/mpxlf_r
-            F90 /bin/mpxlf90_r
-            F90FLAGS -qsuffix=f=f90
-            CXX /bin/mpxlC_r
-            ------------- OR -------------
-            CC xlc
-            FC /bin/xlf
-            F90 /bin/xlf90
-            F90FLAGS -qsuffix=f=f90
-            CXX /bin/xlC
-                then manually edit macros.make:
-            CC = mpcc_r
-            FC = mpxlf_r
-            F90 = mpxlf90_r
-            F90FLAGS = -qsuffix=f=f90
-            CXX = mpxlC_r

Makefile.am

@@ -18,28 +18,11 @@ if BUILD_DOCS
 SUBDIRS += doc
 endif
 
-CLEANFILES = pnetcdf_pc
-
-DISTCLEANFILES = pnetcdf.pc
-
 EXTRA_DIST = COPYRIGHT \
              CREDITS \
              INSTALL \
              README \
-             README.CRAY \
-             README.Fujitsu \
-             README.INTEL \
-             README.IBM \
-             README.K-Computer \
-             README.LINUX \
-             README.SGI \
-             README.SX \
-             README.consistency \
-             README.large_files \
              RELEASE_NOTES \
-             pbs.script \
-             cobalt.script \
-             check_install.in \
              m4/foreach.m4 \
              m4/foreachq.m4 \
              m4/utils.m4
@@ -75,9 +58,6 @@ ptests:
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libpnetcdf.pc
 
-# The script shows the end users how pnetcdf is built
-bin_SCRIPTS = pnetcdf-config
-
 install-data-hook:
 	@echo '+----------------------------------------------------------------------------+'
 	@echo '|'

NEWS

@@ -1,3 +1,3 @@
 Please see Parallel-netCDF project web sites:
 http://cucis.ece.northwestern.edu/projects/PnetCDF
-https://trac.mcs.anl.gov/projects/parallel-netcdf/wiki
+http://trac.mcs.anl.gov/projects/parallel-netcdf

README

@@ -8,16 +8,16 @@ formats (CDF-1 and 2).
 
 In addition, PnetCDF supports the CDF-5 file format, an extension of CDF-2,
 that supports more data types and allows users to define large dimensions,
-attributes, and variables (>2B elements).
+attributes, and variables (>2B array elements).
 
 NetCDF gives scientific programmers a space-efficient and portable means for
 storing data. However, it does so in a serial manner, making it difficult to
 achieve high I/O performance. By making some small changes to the NetCDF APIs,
 PnetCDF can use MPI-IO to achieve high-performance parallel I/O.
 
 More extensive installation guides can be found in file INSTALL.  Additional
-information regarding the contents of the release can be found in
-the RELEASE_NOTES file in the top-level directory.  Finally, the PnetCDF web
+information regarding the contents of the release can be found in the
+RELEASE_NOTES file in the top-level directory.  Finally, the PnetCDF web
 sites:
     http://trac.mcs.anl.gov/projects/parallel-netcdf
     http://cucis.ece.northwestern.edu/projects/PnetCDF
@@ -26,13 +26,13 @@ contain information on bug fixes and new releases.
 
 Requirements:
 
-    - Parallel-NetCDF relies on MPI-IO.  ROMIO, the most common MPI-IO
-      implementation, can make use of a prefix in front of the file name to
-      specify the underlying file system and override ROMIO's auto detection. A
-      typical prefix would look like "nfs:" or "pvfs2:".  Bear this in mind if
-      you use a file name with ':' characters.  In some cases, ROMIO might
-      think you are passing in a prefix and will complain about an unsupported
-      file system type.  If that happens, add a file-system prefix to your file
+    - PnetCDF relies on MPI-IO.  ROMIO, the most common MPI-IO implementation,
+      can make use of a prefix in front of the file name to specify the
+      underlying file system and override ROMIO's auto detection. A typical
+      prefix would look like "nfs:" or "pvfs2:".  Bear this in mind if you use
+      a file name with ':' characters.  In some cases, ROMIO might think you
+      are passing in a prefix and will complain about an unsupported file
+      system type.  If that happens, add a file-system prefix to your file
       name.   
 
     - To build parallel-netcdf you will need some additional programs:
@@ -44,7 +44,8 @@ Requirements:
 
 
 Build recipes:
-    Several machine- and platform-specific build recipes are available.
+    Several machine- and platform-specific build recipes are available under
+    the directory of doc.
     - README.IBM        (BlueGene systems)
     - README.SX         (NEC SX systems)
     - README.CRAY       (Cray systems)
@@ -63,8 +64,9 @@ Note on supporting large files and large variables.
 
     - In places where you might use NF_UNLIMITED to define an unlimited 
       dimension in one of the nfmpi_ routines, use NFMPI_UNLIMITED. 
-      NFMPI_UNLIMITED will be defined as the proper type for nfmpi_def_dim, 
-      whereas nf_unlimited might be too small. Similarly, for Fortran 90,
+      NFMPI_UNLIMITED has been defined as the proper type for nfmpi_def_dim, 
+      whereas NF_UNLIMITED might be too small. Similarly, for Fortran 90,
       use NF90MPI_UNLIMITED instead of NF90_UNLIMITED.
 
 Please send an email to [email protected]
+

RELEASE_NOTES

@@ -768,7 +768,7 @@ version  1.5.0 (July 8, 2014)
       processes used to run the tests. The testing uses up to 8 MPI processes.
 
     * A sample PBS script file is provided to test "make ptest" on machines
-      with a batch queue system: pbs.script. This example script can be
+      with a batch queue system: doc/pbs.script. This example script can be
       submitted from the build root directory (where you run "make" command to
       build PnetCDF library).
 

configure.ac

@@ -147,7 +147,7 @@ AC_ARG_VAR(MPICC,  MPI C compiler)
 AC_ARG_VAR(MPICXX, MPI C++ compiler)
 AC_ARG_VAR(MPIF77, MPI Fortran 77 compiler)
 AC_ARG_VAR(MPIF90, MPI Fortran 90 compiler)
-AC_ARG_VAR(CC,     Overwritten by MPICC  if MPICC is set)
+AC_ARG_VAR(CC,     Overwritten by MPICC  if MPICC  is set)
 AC_ARG_VAR(CXX,    Overwritten by MPICXX if MPICXX is set)
 AC_ARG_VAR(F77,    Overwritten by MPIF77 if MPIF77 is set)
 AC_ARG_VAR(FC,     Overwritten by MPIF90 if MPIF90 is set)
@@ -1303,6 +1303,7 @@ AC_CONFIG_FILES(Makefile \
                 benchmarks/C/Makefile \
                 benchmarks/FLASH-IO/Makefile \
                 doc/Makefile \
+                doc/pnetcdf-api/Makefile \
                 man/Makefile \
                 test/Makefile \
                 test/common/Makefile \
@@ -1328,8 +1329,8 @@ AC_CONFIG_FILES(Makefile \
 # AC_CONFIG_FILES([stamp-h], [echo timestamp > stamp-h])
 
 dnl add executable permission to pnetcdf-config and check_install
-AC_CONFIG_FILES([pnetcdf-config], [chmod u+x pnetcdf-config])
-AC_CONFIG_FILES([check_install],  [chmod u+x check_install])
+AC_CONFIG_FILES([src/utils/pnetcdf-config], [chmod u+x src/utils/pnetcdf-config])
+AC_CONFIG_FILES([src/utils/check_install],  [chmod u+x src/utils/check_install])
 
 AC_OUTPUT
 echo "------------------------------------------------------------------------------"

README.CRAY doc/README.CRAY

@@ -32,9 +32,7 @@ EXTRA_DIST = c_api.tex \
              multiple_io.tex \
              nonblocking.tex \
              pnetcdf-api.bbl \
-             pnetcdf-api.tex \
-             porting_notes.txt \
-             symbol_renaming.txt
+             pnetcdf-api.tex
 
 CLEANFILES = *.dvi *.log *.aux *.ps $(API_GUIDE)
 

README.Fujitsu doc/README.Fujitsu

@@ -8,6 +8,12 @@
 
 SUBDIRS = ncmpigen ncmpidump ncmpidiff ncmpivalid pnetcdf_version ncoffsets
 
+# The script shows the end users how pnetcdf is built
+bin_SCRIPTS = pnetcdf-config
+
+EXTRA_DIST = pnetcdf-config.in \
+             check_install.in
+
 dist-hook:
 	-rm -rf `find $(distdir) -name .svn`