summaryrefslogtreecommitdiffstats
path: root/fortran/src/README_DEVELOPEMENT
diff options
context:
space:
mode:
Diffstat (limited to 'fortran/src/README_DEVELOPEMENT')
-rw-r--r--fortran/src/README_DEVELOPEMENT36
1 files changed, 36 insertions, 0 deletions
diff --git a/fortran/src/README_DEVELOPEMENT b/fortran/src/README_DEVELOPEMENT
new file mode 100644
index 0000000..dc65f47
--- /dev/null
+++ b/fortran/src/README_DEVELOPEMENT
@@ -0,0 +1,36 @@
+Procedure to add a new function:
+
+(1) Edit the fortran/src/H5*ff.f90 file
+(2) Edit the fortran/sr/H5*f.c file
+(3) Edit the fortran/src/H5f90proto.h file
+
+
+
+Procedure:
+(1) Find the struct name you are interested in:
+ (a) src/H5public.h if it is a generic type, i.e. H5_*
+ or
+ (b) src/H5*public.h if is a specific type, i.e. H5*_
+
+(2) Put that structure into an array that will be passed to fortran in:
+ (a) fortran/src/H5_f.c (add to nh5init_flags_c subroutine)
+ (b) edit fortran/src/H5f90proto.h and edit nh5init_flags_c interface call
+
+(3) Edit the function call in fortran/src/H5_ff.f90
+ (a) edit the call FUNCTION h5init_flags_c
+ (b) edit h5init_flags_c call in h5open_f to match the number of arguments passing
+
+(4) add the size of the array and array to fortran/src/H5f90global.f90
+ - must match the size found it H5_f.c
+
+NOTE: To just add a default C value argument, do steps (2a) and (4)
+
+Adding a new file to the repository
+-------------------------------------
+
+Add the name of the file to:
+ (1) Makefile.am located in the same directory as the newfile
+ (2) MANIFEST located in the top level directory
+
+
+If you add a new file, be sure to add it to the MANIFEST located in the top directory