xsdk-project · balos1 · Jun 7, 2019 · Jul 12, 2019 · Jul 12, 2019 · Jul 12, 2019
diff --git a/installation_policies/1.md b/installation_policies/1.md
diff --git a/installation_policies/10.md b/installation_policies/10.md
diff --git a/installation_policies/11.md b/installation_policies/11.md
diff --git a/installation_policies/12.md b/installation_policies/12.md
diff --git a/installation_policies/13.md b/installation_policies/13.md
diff --git a/installation_policies/2.md b/installation_policies/2.md
diff --git a/installation_policies/3.md b/installation_policies/3.md
diff --git a/installation_policies/4.md b/installation_policies/4.md
diff --git a/installation_policies/5.md b/installation_policies/5.md
diff --git a/installation_policies/6.md b/installation_policies/6.md
diff --git a/installation_policies/7.md b/installation_policies/7.md
diff --git a/installation_policies/8.md b/installation_policies/8.md
diff --git a/installation_policies/9.md b/installation_policies/9.md
diff --git a/installation_policies/I1.md b/installation_policies/I1.md
@@ -0,0 +1,13 @@
+# I1
+
+Implement the default behavior described below. Each package can decide whether 
+XSDK mode is the default mode.^4^
+
+1. `--dis/enable-xsdk-defaults`
+2. `USE_XSDK_DEFAULTS=[YES,NO]`
+
+----
+
+^4^ For packages like Trilinos that need to maintain backward compatibility 
+over consecutive releases, 
+`USE_XSDK_DEFAULTS` may be `FALSE` by default.
diff --git a/installation_policies/I10.md b/installation_policies/I10.md
@@ -0,0 +1,14 @@
+# I10
+
+Determine other package libraries and include directories.
+
+1. `--with-<package> --with-<package>-lib="linkable list of libraries” 
+--with-<package>-include=”list of include directories”`
+2. `TPL_ENABLE_<package>=[YES,NO]`
+
+Packages must provide a way for a user to specify a dependent package to use. 
+Packages are free to locate a package on the file system if none is 
+specifically provided by the user. If the user does provide one, however, it 
+must be used; if it is not able to be used, then an error must be generated. A 
+package cannot silently substitute a different installation.
+
diff --git a/installation_policies/I11.md b/installation_policies/I11.md
@@ -0,0 +1,4 @@
+# I11
+
+In the XSDK mode, XSDK projects should not rely on users providing any library 
+path information in environmental variables such as `LD_LIBRARY_PATH`.
diff --git a/installation_policies/I12.md b/installation_policies/I12.md
@@ -0,0 +1,5 @@
+# I12
+
+After packages are configured, they can be compiled, installed and "smoke" 
+tested with the following commands: `make ; 
+[sudo] make install ; make test_install`. 
diff --git a/installation_policies/I13.md b/installation_policies/I13.md
@@ -0,0 +1,6 @@
+# I13
+
+After an install the package should provide a machine-readable output to show 
+provenance, that is, what compilers were used and what libraries were linked
+with, as well as other build configurationinformation, so that users with
+problems can send the information directly to developers.
diff --git a/installation_policies/I2.md b/installation_policies/I2.md
@@ -0,0 +1,8 @@
+# I2
+
+Identify location to install package. Multiple "versions" of packages, such as 
+debug and release, can be installed by using different prefix directories.
+
+1. `--prefix=directory`
+2. `CMAKE_INSTALL_PREFIX=directory`
+
diff --git a/installation_policies/I3.md b/installation_policies/I3.md
@@ -0,0 +1,40 @@
+# I3
+
+Select compilers^5^ and compiler flags.
+
+1. If the compilers (and or flags) are explicitly set on input, use those:
+
+    1. `CC=<cc>`,  `CXX=<cxx>`,  `FC=<fc>`,  `CPP`, `FFLAGS`, `FCFLAGS`, 
+`CFLAGS`, `CXXFLAGS`, `CPPFLAGS`, `LDFLAGS`
+
+    2. `CMAKE_C_COMPILER=<cc>`, `CMAKE_CXX_COMPILER=<cxx>`, 
+`CMAKE_Fortran_COMPILER=<fc>`, `CMAKE_C_FLAGS="<flag1> <flag2> ...”`, 
+`CMAKE_CXX_FLAGS=”...”`, `CMAKE_Fortran_FLAGS=”...”`
+
+2. If the compilers and/or flags are not explicitly set on input but are 
+set in the environment variables
+    `FC`, `CC`, `CXX`, `CPP`^6^, `FFLAGS`, `FCFLAGS`, `CFLAGS`, `CXXFLAGS`, 
+`CPPFLAGS`,^7^ `LDFLAGS`, then the compilers and flags must be set to these.
+If both `FFLAGS` and `FCFLAGS` are set, then they need to be the same or it
+is an error.
+
+3. If the compilers and/or compiler flags are not explicitly passed in or 
+defined in the environment variables listed above, then the package is free
+to try to find compilers on the system and set the compiler flags consistent
+with the other settings defined below (e.g., shared libraries vs. static libraries, 
+debug vs. non-debug).^8^
+
+-----
+
+^5^ Packages must support using the MPI compiler wrappers for these arguments.
+
+^6^ The environment variable CPP is not supported by raw CMake.
+
+^7^ The environment variable CPPFLAGS is not supported by raw CMake.
+
+^8^ All CMake projects should use the same built-in CMake algorithm to find the 
+default compilers, so even when no 
+explicit compilers or flags are set they should use the same compilers and 
+flags.  Also, raw CMake projects will append 
+compiler flags based on the build type.  See "Selecting compiler and linker 
+options".
diff --git a/installation_policies/I4.md b/installation_policies/I4.md
@@ -0,0 +1,9 @@
+# I4
+
+Create libraries with debugging information and possible additional error 
+checking (default is debug in XSDK mode).
+
+1. `--dis/enable-debug` 
+
+2. `CMAKE_BUILD_TYPE=[Debug,Release]`
+
diff --git a/installation_policies/I5.md b/installation_policies/I5.md
@@ -0,0 +1,9 @@
+# I5
+
+Select option used for indicating whether to build shared libraries (default is 
+shared in XSDK mode).
+
+1. `--dis/enable-shared (configure)` 
+
+2. `BUILD_SHARED_LIBS=[YES,NO]` 
+
diff --git a/installation_policies/I6.md b/installation_policies/I6.md
@@ -0,0 +1,8 @@
+# I6
+
+Build interface for a particular additional language.
+
+1.  `--dis/enable-<language>` 
+
+2. `XSDK_ENABLE_<language>=[YES,NO]` 
+
diff --git a/installation_policies/I7.md b/installation_policies/I7.md
@@ -0,0 +1,10 @@
+# I7
+
+Determine precision for packages that build only for one precision (default is 
+double). Packages that handle all precisions automatically are free to ignore
+this option.
+
+1. `--with-precision=[single,double,quad]`
+
+2. `XSDK_PRECISION=[SINGLE,DOUBLE,QUAD]` 
+
diff --git a/installation_policies/I8.md b/installation_policies/I8.md
@@ -0,0 +1,10 @@
+# I8
+
+Determine index size for packages that build only for one index size (default 
+is 32). Packages that handle all index sizes automatically are free to ignore
+this option.
+
+1. `--with-index-size=[32,64]`
+
+2. `XSDK_INDEX_SIZE=[32,64]`
+
diff --git a/installation_policies/I9.md b/installation_policies/I9.md
@@ -0,0 +1,13 @@
+# I9 
+
+Set location of BLAS and LAPACK libraries (default is to locate one on the 
+system automatically). 
+
+1. `--with-blas-lib="linkable list of libraries” 
+--with-lapack-lib=”linkable list of libraries”` -- it is fine to use 
+-L and -l flags in the lists
+
+2. `TPL_BLAS_LIBRARIES="linkable list of libraries”`, 
+`TPL_LAPACK_LIBRARIES=”linkable list of libraries”` -- should not use
+-L or -l flags in the lists
+