summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorLarry Knox <lrknox@hdfgroup.org>2012-06-02 18:54:58 (GMT)
committerLarry Knox <lrknox@hdfgroup.org>2012-06-02 18:54:58 (GMT)
commitf4990be63538b8941aa9ad0f4fcf4e11a82185cc (patch)
tree71d42c0a02d76806ff3529fe80f6c7ec59c92f2e /examples
parent71c9b82d5e97480f965e857f8c65245d36f09916 (diff)
downloadhdf5-f4990be63538b8941aa9ad0f4fcf4e11a82185cc.zip
hdf5-f4990be63538b8941aa9ad0f4fcf4e11a82185cc.tar.gz
hdf5-f4990be63538b8941aa9ad0f4fcf4e11a82185cc.tar.bz2
[svn-r22426] Add examples/README file to be installed with examples.
Text file only, but tested with h5committest.
Diffstat (limited to 'examples')
-rw-r--r--examples/Makefile.am1
-rw-r--r--examples/Makefile.in14
-rw-r--r--examples/README17
3 files changed, 30 insertions, 2 deletions
diff --git a/examples/Makefile.am b/examples/Makefile.am
index 9ec6a85..a35d8ca 100644
--- a/examples/Makefile.am
+++ b/examples/Makefile.am
@@ -44,6 +44,7 @@ INSTALL_FILES = h5_write.c h5_read.c h5_extend_write.c h5_chunk_read.c \
INSTALL_SCRIPT_FILES = run-c-ex.sh
INSTALL_TOP_SCRIPT_FILES = run-all-ex.sh
+INSTALL_TOP_FILES = README
# How to build examples, using installed version of h5cc
if BUILD_PARALLEL_CONDITIONAL
diff --git a/examples/Makefile.in b/examples/Makefile.in
index c93ad12..c01afcc 100644
--- a/examples/Makefile.in
+++ b/examples/Makefile.in
@@ -54,7 +54,7 @@ PRE_UNINSTALL = :
POST_UNINSTALL = :
build_triplet = @build@
host_triplet = @host@
-DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \
+DIST_COMMON = README $(srcdir)/Makefile.am $(srcdir)/Makefile.in \
$(srcdir)/run-c-ex.sh.in $(srcdir)/testh5cc.sh.in \
$(top_srcdir)/config/commence.am \
$(top_srcdir)/config/conclude.am \
@@ -382,6 +382,7 @@ INSTALL_FILES = h5_write.c h5_read.c h5_extend_write.c h5_chunk_read.c \
INSTALL_SCRIPT_FILES = run-c-ex.sh
INSTALL_TOP_SCRIPT_FILES = run-all-ex.sh
+INSTALL_TOP_FILES = README
# The external link examples demonstrate how to use paths; they need
# directories to be created to do this.
@@ -674,7 +675,7 @@ install-data-local:
uninstall-local:
@$(MAKE) $(AM_MAKEFLAGS) uninstall-examples
-install-examples: $(EXAMPLEDIR) $(INSTALL_FILES)
+install-examples: $(EXAMPLEDIR) $(INSTALL_FILES)
@for f in X $(INSTALL_FILES); do \
if test $$f != X; then \
(set -x; $(INSTALL) $(srcdir)/$$f $(EXAMPLEDIR)/. || exit 1); \
@@ -686,6 +687,12 @@ install-examples: $(EXAMPLEDIR) $(INSTALL_FILES)
(set -x; $(INSTALL) $$f $(EXAMPLEDIR)/. || exit 1);\
fi; \
done
+ @for f in X $(INSTALL_TOP_FILES); do \
+ if test $$f != X; then \
+ (set -x; $(INSTALL) $(srcdir)/$$f $(EXAMPLETOPDIR)/. || exit 1); \
+ chmod a-x $(EXAMPLETOPDIR)/$$f;\
+ fi; \
+ done
@for f in X $(INSTALL_TOP_SCRIPT_FILES); do \
if test $$f != X; then \
(set -x; $(INSTALL) $(srcdir)/$$f $(EXAMPLETOPDIR)/. || exit 1); \
@@ -699,6 +706,9 @@ uninstall-examples:
@if test -n "$(INSTALL_SCRIPT_FILES)" -a -d $(EXAMPLEDIR); then \
set -x; cd $(EXAMPLEDIR) && $(RM) $(INSTALL_SCRIPT_FILES); \
fi
+ @if test -n "$(INSTALL_TOP_FILES)" -a -d $(EXAMPLETOPDIR); then \
+ set -x; cd $(EXAMPLETOPDIR) && $(RM) $(INSTALL_TOP_FILES); \
+ fi
@if test -n "$(INSTALL_TOP_SCRIPT_FILES)" -a -d $(EXAMPLETOPDIR); then \
set -x; cd $(EXAMPLETOPDIR) && $(RM) $(INSTALL_TOP_SCRIPT_FILES); \
fi
diff --git a/examples/README b/examples/README
new file mode 100644
index 0000000..0550b15
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,17 @@
+ HDF5 Examples
+
+This directory contains example programs for the installed APIs and scripts to
+compile and run them. Examples in the c and hl/c subdirectories are always
+installed, and those in fortan, hl/fortran, c++ and hl/c++ will be installed
+when fortran or c++ are enabled.
+
+Running the run-all-ex.sh script in this directory will run the scripts and in
+turn the examples in all the subdirectories where examples are installed. The
+scripts can also be run individually. The appropriate compile scripts in the
+bin directory for this install will be used by default to compile and link the
+example programs. Note that h5redeploy must be run if these binaries are
+copied or extracted in a directory other than the one where they were initially
+installed. Compile scripts from other locations can be used by setting an
+environment variable prefix to the path of the directory containing the bin
+directory with the compile scripts h5cc, h5fc, etc. For example, export
+prefix=/usr/local/hdf5 to use h5cc, h5fc, etc. in /usr/local/hdf5/bin.