xref: /petsc/makefile (revision b270bd72dc745022da9541a837c18d411f2d1c38)
111b6ed10SLois Curfman McInnes#
261108934SBarry Smith# This is the makefile for installing PETSc. See
361108934SBarry Smith# http://www.mcs.anl.gov/petsc/petsc-2/documentation/installation.html for directions on installing PETSc.
4cfd69a58SBarry Smith# See also bmake/common for additional commands.
511b6ed10SLois Curfman McInnes#
6716b9c40SSatish BalayALL: all
748b2c0e9SBarry SmithLOCDIR = .
8de21bb36SSatish BalayDIRS   = src include
961523587SBarry Smith
10516d1546SSatish Balayinclude ${PETSC_DIR}/bmake/common/base
11516d1546SSatish Balayinclude ${PETSC_DIR}/bmake/common/test
1261523587SBarry Smith
13ca5c9d59SMatthew Knepley#
143677444aSSatish Balay# Basic targets to build PETSc libraries.
15fa527775SLois Curfman McInnes# all: builds the c, fortran, and f90 libraries
16b5fa40b8SBarry Smithall:
17ab901514SBarry Smith	@${OMAKE}  PETSC_ARCH=${PETSC_ARCH}  chkpetsc_dir
18ab901514SBarry Smith	-@${OMAKE} all_build 2>&1 | tee make_log_${PETSC_ARCH}
19b5d30489SBarry Smithall_build: chk_petsc_dir chklib_dir info info_h deletelibs  build shared
20efd74e9bSBarry Smith#
21fa527775SLois Curfman McInnes# Prints information about the system and version of PETSc being compiled
22efd74e9bSBarry Smith#
23efd74e9bSBarry Smithinfo:
24efd74e9bSBarry Smith	-@echo "=========================================="
2511b6dc0cSBarry Smith	-@echo " "
26*b270bd72SBarry Smith	-@echo "See docs/faq.html and docs/bugreporting.html"
27d76296fbSBarry Smith	-@echo "for help with installation problems. Please send EVERYTHING"
28d76296fbSBarry Smith	-@echo "printed out below when reporting problems"
2911b6dc0cSBarry Smith	-@echo " "
3011b6dc0cSBarry Smith	-@echo "To subscribe to the PETSc users mailing list, send mail to "
3111b6dc0cSBarry Smith	-@echo "majordomo@mcs.anl.gov with the message: "
328b6f49e5SSatish Balay	-@echo "subscribe petsc-announce"
3311b6dc0cSBarry Smith	-@echo " "
34d76296fbSBarry Smith	-@echo "=========================================="
351d91fb6eSBarry Smith	-@echo On `date` on `hostname`
3630fdcc7aSBarry Smith	-@echo Machine characteristics: `uname -a`
37*b270bd72SBarry Smith	-@echo "config/configure.py run at " ${CONFIGURE_RUN_TIME}
38*b270bd72SBarry Smith	-@echo "config/configure.py options " ${CONFIGURE_OPTIONS}
39efd74e9bSBarry Smith	-@echo "-----------------------------------------"
40e481929fSSatish Balay	-@echo "Using PETSc directory: ${PETSC_DIR}"
41e481929fSSatish Balay	-@echo "Using PETSc arch: ${PETSC_ARCH}"
4247794344SBarry Smith	-@echo "-----------------------------------------"
43bdd8b494SSatish Balay	-@grep "define PETSC_VERSION" ${PETSC_DIR}/include/petscversion.h | ${SED} "s/........//"
44f265ae5cSBarry Smith	-@echo "-----------------------------------------"
45e0e703c1SSatish Balay	-@echo "Using configuration flags:"
4619552e71SMatthew Knepley	-@grep "\#define " ${PETSC_DIR}/bmake/${PETSC_ARCH}/petscconf.h
4747794344SBarry Smith	-@echo "-----------------------------------------"
48d77bb2e1SSatish Balay	-@echo "Using include paths: ${PETSC_INCLUDE}"
49e481929fSSatish Balay	-@echo "Using PETSc flags: ${PETSCFLAGS} ${PCONF}"
50efd74e9bSBarry Smith	-@echo "------------------------------------------"
51abc0a331SBarry Smith	-@echo "Using C/C++ compiler: ${CC} ${COPTFLAGS} ${CPPFLAGS}"
52e481929fSSatish Balay	-@echo "C/C++ Compiler version: " `${CCV}`
53e481929fSSatish Balay	-@if [ "${FC}" != "" ]; then \
54abc0a331SBarry Smith	   echo "Using Fortran compiler: ${FC} ${FOPTFLAGS} ${FPPFLAGS}";\
55e481929fSSatish Balay	   echo "Fortran Compiler version: " `${FCV}`;\
56e481929fSSatish Balay         fi
57e481929fSSatish Balay	-@echo "-----------------------------------------"
58abc0a331SBarry Smith	-@echo "Using C/C++ linker: ${CC_LINKER}"
59e481929fSSatish Balay	-@if [ "${FC}" != "" ]; then \
60abc0a331SBarry Smith	   echo "Using Fortran linker: ${FC_LINKER}";\
61e6ee457dSBarry Smith         fi
62e481929fSSatish Balay	-@echo "-----------------------------------------"
63f2b01315SBarry Smith	-@echo "Using libraries: ${PETSC_LIB}"
64e3353558SSatish Balay	-@echo "------------------------------------------"
65e3353558SSatish Balay	-@echo "Using mpirun: ${MPIRUN}"
66efd74e9bSBarry Smith	-@echo "=========================================="
67b8d81f61SBarry Smith#
68b8d81f61SBarry Smith#
6919552e71SMatthew KnepleyMINFO = ${PETSC_DIR}/bmake/${PETSC_ARCH}/petscmachineinfo.h
70b8d81f61SBarry Smithinfo_h:
71ddbfe947SBarry Smith	-@$(RM) -f MINFO ${MINFO}
722fc52814SBarry Smith	-@echo  "static const char *petscmachineinfo = \"  " >> MINFO
7334a92de5SBarry Smith	-@echo  "Libraries compiled on `date` on `hostname` " >> MINFO
74*b270bd72SBarry Smith	-@echo  "config/configure.py run at " ${CONFIGURE_RUN_TIME} >> MINFO
75*b270bd72SBarry Smith	-@echo  "config/configure.py options " ${CONFIGURE_OPTIONS} >> MINFO
76c5e9c7dfSBarry Smith	-@echo  Machine characteristics: `uname -a` "" >> MINFO
77f6a9982fSBarry Smith	-@echo  "Using PETSc directory: ${PETSC_DIR}" >> MINFO
7819552e71SMatthew Knepley	-@echo  "Using PETSc arch: ${PETSC_ARCH}" >> MINFO
7993520af8SSatish Balay	-@echo  "-----------------------------------------\"; " >> MINFO
802fc52814SBarry Smith	-@echo  "static const char *petsccompilerinfo = \"  " >> MINFO
81abc0a331SBarry Smith	-@echo  "Using C compiler: ${CC} ${COPTFLAGS} ${CCPPFLAGS} " >> MINFO
82dffd13fbSMatthew Knepley	-@echo  "C Compiler version:"  >> MINFO ; ${C_CCV} >> MINFO 2>&1 ; true
83dffd13fbSMatthew Knepley	-@echo  "C++ Compiler version:"  >> MINFO; ${CXX_CCV} >> MINFO 2>&1 ; true
84abc0a331SBarry Smith	-@echo  "Using Fortran compiler: ${FC} ${FOPTFLAGS} ${FCPPFLAGS}" >> MINFO
85770ba9b7SSatish Balay	-@echo  "Fortran Compiler version:" >> MINFO ; ${FCV} >> MINFO 2>&1 ; true
8693520af8SSatish Balay	-@echo  "-----------------------------------------\"; " >> MINFO
872fc52814SBarry Smith	-@echo  "static const char *petsccompilerflagsinfo = \"  " >> MINFO
88c5e9c7dfSBarry Smith	-@echo  "Using PETSc flags: ${PETSCFLAGS} ${PCONF}" >> MINFO
89c5e9c7dfSBarry Smith	-@echo  "-----------------------------------------" >> MINFO
90c5e9c7dfSBarry Smith	-@echo  "Using configuration flags:" >> MINFO
91c5e9c7dfSBarry Smith	-@echo  "-----------------------------------------" >> MINFO
92c5e9c7dfSBarry Smith	-@echo  "Using include paths: ${PETSC_INCLUDE}" >> MINFO
9393520af8SSatish Balay	-@echo  "------------------------------------------\"; " >> MINFO
942fc52814SBarry Smith	-@echo  "static const char *petsclinkerinfo = \"  " >> MINFO
95c5e9c7dfSBarry Smith	-@echo  "Using C linker: ${CLINKER}" >> MINFO
96c5e9c7dfSBarry Smith	-@echo  "Using Fortran linker: ${FLINKER}" >> MINFO
9793520af8SSatish Balay	-@echo  "Using libraries: ${PETSC_LIB} \"; " >> MINFO
98a2d9a622SKris Buschelman	-@cat MINFO | ${SED} -e 's/\^M//g' | ${SED} -e 's/\\/\\\\/g' | ${SED} -e 's/$$/ \\n\\/' | sed -e 's/\;  \\n\\/\;/'> MINFO_
99aa0c092eSKris Buschelman	-@cat MINFO_ | ${SED} -e 's/\
1000e98dc4aSKris Buschelman//g'  > /dev/null; foobar=$$?; \
101a2d9a622SKris Buschelman          if [ "$$foobar" = "0" ]; then \
102a2d9a622SKris Buschelman	    cat MINFO_ | ${SED} -e 's/\
103a2d9a622SKris Buschelman//g' > ${MINFO}; \
104f194edaeSKris Buschelman          else cat MINFO | ${SED} -e 's/\^M//g' | ${SED} -e 's/\\/\\\\/g' | ${SED} -e 's/$$/ \\n\\/' | sed -e 's/\;  \\n\\/\;/'> ${MINFO}; \
105ce0f4ea0SKris Buschelman          fi
1063677444aSSatish Balay	-@$(RM) MINFO MINFO_
107fa527775SLois Curfman McInnes
108fa527775SLois Curfman McInnes#
109f6a9982fSBarry Smith# Builds the PETSc libraries
1103677444aSSatish Balay# This target also builds fortran77 and f90 interface
111f6a9982fSBarry Smith# files and compiles .F files
112efd74e9bSBarry Smith#
11347794344SBarry Smithbuild:
114ab901514SBarry Smith	-@echo "BEGINNING TO COMPILE LIBRARIES IN ALL DIRECTORIES"
1150e98dc4aSKris Buschelman	-@echo "========================================="
116*b270bd72SBarry Smith	-@${OMAKE}  PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=libfast tree
1174ad51bbdSBarry Smith	@grep -i " error " make_log_${PETSC_ARCH} > /dev/null; if [ "$$?" = "0" ]; then \
118*b270bd72SBarry Smith           echo "********************************************************************; \
119*b270bd72SBarry Smith           echo "         Error during compile, check " make_log_${PETSC_ARCH}; \
120*b270bd72SBarry Smith           echo "     Send it and configure.log to petsc-maint@mcs.anl.gov";\
121e5175200SBarry Smith           echo "********************************************************************; \
1220b3634f8SBarry Smith           exit 1; fi
12347794344SBarry Smith	-@${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}
12435ca7349SBarry Smith	-@echo "Completed building libraries"
1259d6c0ac5SBarry Smith	-@echo "========================================="
1268744090aSBarry Smith#
1272492ecdbSBarry Smith# Builds PETSc test examples for a given architecture
12804f117c6SBarry Smith#
129ab901514SBarry Smithtest:
130c53b3f23SSatish Balay	-@echo "Running test examples to verify correct installation"
13104f117c6SBarry Smith	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex19
1320ce59502SBarry Smith	@if [ "${FC}" != "" ]; then cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex5f; fi;
1332492ecdbSBarry Smith	-@echo "Completed test examples"
1343677444aSSatish Balay
1353677444aSSatish Balaytestexamples: info
1363677444aSSatish Balay	-@echo "BEGINNING TO COMPILE AND RUN TEST EXAMPLES"
1373677444aSSatish Balay	-@echo "Due to different numerical round-off on certain"
138ab901514SBarry Smith	-@echo "machines some of the numbers may not match exactly."
1393677444aSSatish Balay	-@echo "========================================="
1403677444aSSatish Balay	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ACTION=testexamples_1  tree
1412492ecdbSBarry Smith	-@echo "Completed compiling and running test examples"
1423677444aSSatish Balay	-@echo "========================================="
1433677444aSSatish Balaytestfortran: info
1443677444aSSatish Balay	-@echo "BEGINNING TO COMPILE AND RUN FORTRAN TEST EXAMPLES"
1453677444aSSatish Balay	-@echo "========================================="
1463677444aSSatish Balay	-@echo "Due to different numerical round-off on certain"
1473677444aSSatish Balay	-@echo "machines or the way Fortran formats numbers"
148770ba9b7SSatish Balay	-@echo "some of the results may not match exactly."
149ab901514SBarry Smith	-@echo "========================================="
1506d2f2efaSKris Buschelman	-@if [ "${FC}" != "" ]; then \
1516d2f2efaSKris Buschelman            ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_3 tree; \
1526d2f2efaSKris Buschelman            echo "Completed compiling and running Fortran test examples"; \
1534b5d664cSKris Buschelman          else \
1543677444aSSatish Balay            echo "Error: No FORTRAN compiler available"; \
1552492ecdbSBarry Smith          fi
15601c5c36fSSatish Balay	-@echo "========================================="
15701c5c36fSSatish Balaytestexamples_uni: info
15801c5c36fSSatish Balay	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR EXAMPLES"
15901c5c36fSSatish Balay	-@echo "Due to different numerical round-off on certain"
160ab901514SBarry Smith	-@echo "machines some of the numbers may not match exactly."
16101c5c36fSSatish Balay	-@echo "========================================="
16201c5c36fSSatish Balay	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_4  tree
1632492ecdbSBarry Smith	-@echo "Completed compiling and running uniprocessor test examples"
1643677444aSSatish Balay	-@echo "========================================="
1653677444aSSatish Balaytestfortran_uni: info
1663677444aSSatish Balay	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR FORTRAN EXAMPLES"
1673677444aSSatish Balay	-@echo "Due to different numerical round-off on certain"
168770ba9b7SSatish Balay	-@echo "machines some of the numbers may not match exactly."
169ab901514SBarry Smith	-@echo "========================================="
1706d2f2efaSKris Buschelman	-@if [ "${FC}" != "" ]; then \
1716d2f2efaSKris Buschelman            ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_9  tree; \
1726d2f2efaSKris Buschelman            echo "Completed compiling and running uniprocessor fortran test examples"; \
1734b5d664cSKris Buschelman          else \
1746d2f2efaSKris Buschelman            echo "Error: No FORTRAN compiler available"; \
1753677444aSSatish Balay          fi
176ad96cc0dSLois Curfman McInnes	-@
177f3eacedaSSatish Balay	-@echo "========================================="
1788c37ef55SBarry Smith
179e5175200SBarry Smith# Ranlib on the libraries
18061523587SBarry Smithranlib:
18111b6ed10SLois Curfman McInnes	${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}
1822492ecdbSBarry Smith
183b87434adSSatish Balay# Deletes PETSc libraries
184d44968ceSBarry Smithdeletelibs:
185a42cec9dSMatthew Knepley	-${RM} -f ${PETSC_LIB_DIR}/*
186a42cec9dSMatthew Knepley
187ab901514SBarry Smith# Cleans up build
188a42cec9dSMatthew Knepleyallclean: deletelibs
1893677444aSSatish Balay	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=clean tree
1904918a6b0SSatish Balay
1914918a6b0SSatish Balay
1924918a6b0SSatish Balay#
1934918a6b0SSatish Balay# Check if PETSC_DIR variable specified is valid
1944918a6b0SSatish Balay#
1951390f061SBarry Smithchk_petsc_dir:
1961390f061SBarry Smith	@if [ ! -f ${PETSC_DIR}/include/petscversion.h ]; then \
1971390f061SBarry Smith	  echo "Incorrect PETSC_DIR specified: ${PETSC_DIR}!"; \
1984918a6b0SSatish Balay	  echo "You need to use / to separate directories, not \\!"; \
19975910670SSatish Balay	  echo "Aborting build"; \
20075910670SSatish Balay	  false; fi
2013c94ec11SBarry Smith#
2020e98dc4aSKris Buschelman#
203fe0e97ccSBarry Smithinstall:
2043c94ec11SBarry Smith	-@if [ "${INSTALL_DIR}" = "${PETSC_DIR}" ]; then \
2053c94ec11SBarry Smith	  echo "Install directory is current directory; nothing needs to be done";\
2063c94ec11SBarry Smith        else \
207de21bb36SSatish Balay	  echo Installing PETSc at ${INSTALL_DIR};\
2083c94ec11SBarry Smith          if [ ! -d `dirname ${INSTALL_DIR}` ]; then \
2093c94ec11SBarry Smith	    ${MKDIR} `dirname ${INSTALL_DIR}` ; \
210de21bb36SSatish Balay          fi;\
2113c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR} ]; then \
2123c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR} ; \
2133c94ec11SBarry Smith          fi;\
214de21bb36SSatish Balay          cp -fr include ${INSTALL_DIR};\
2153c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR}/bmake ]; then \
2163c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR}/bmake ; \
2173c94ec11SBarry Smith          fi;\
2183c94ec11SBarry Smith          cp -f bmake/adic* bmake/variables ${INSTALL_DIR}/bmake ; \
2193c94ec11SBarry Smith          cp -fr bmake/common ${INSTALL_DIR}/bmake;\
2203c94ec11SBarry Smith          cp -fr bmake/${PETSC_ARCH} ${INSTALL_DIR}/bmake;\
221de21bb36SSatish Balay          cp -fr bin ${INSTALL_DIR};\
2223c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR}/lib ]; then \
2233c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR}/lib ; \
2243c94ec11SBarry Smith          fi;\
225de21bb36SSatish Balay          for i in lib/lib*; do \
2263c94ec11SBarry Smith            if [ ! -d ${INSTALL_DIR}/$${i} ]; then \
2273c94ec11SBarry Smith              ${MKDIR} ${INSTALL_DIR}/$${i};\
2283c94ec11SBarry Smith            fi; \
2293c94ec11SBarry Smith            if [ -d $${i}/${PETSC_ARCH} ]; then \
230ab901514SBarry Smith              cp -fr $${i}/${PETSC_ARCH} ${INSTALL_DIR}/$${i};\
2313c94ec11SBarry Smith              ${RANLIB}  ${INSTALL_DIR}/$${i}/*.a > /dev/null 2>&1 ;\
2323c94ec11SBarry Smith              ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${INSTALL_DIR} shared; \
2333c94ec11SBarry Smith            fi;\
2343c94ec11SBarry Smith          done;\
235853b99e9SBarry Smith          echo "sh/bash: PETSC_DIR="${INSTALL_DIR}"; export PETSC_DIR";\
2363c94ec11SBarry Smith          echo "csh/tcsh: setenv PETSC_DIR "${INSTALL_DIR} ;\
2373c94ec11SBarry Smith          echo "Then do make test to verify correct install";\
2383c94ec11SBarry Smith        fi;
2390e98dc4aSKris Buschelman
2403c94ec11SBarry Smithinstall_src:
2413c94ec11SBarry Smith	-@if [ "${INSTALL_DIR}" = "${PETSC_DIR}" ]; then \
2423c94ec11SBarry Smith	  echo "You did not set a directory to install to";\
2433c94ec11SBarry Smith        else \
244de21bb36SSatish Balay	  echo Installing PETSc source at ${INSTALL_DIR};\
2453c94ec11SBarry Smith          if [ ! -d `dirname ${INSTALL_DIR}` ]; then \
2463c94ec11SBarry Smith	    ${MKDIR} `dirname ${INSTALL_DIR}` ; \
247de21bb36SSatish Balay          fi;\
2483c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR} ]; then \
2493c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR} ; \
2503c94ec11SBarry Smith          fi;\
2513c94ec11SBarry Smith          cp -fr src ${INSTALL_DIR};\
2523c94ec11SBarry Smith        fi;
2530e98dc4aSKris Buschelman
2543c94ec11SBarry Smithinstall_docs:
2553c94ec11SBarry Smith	-@if [ "${INSTALL_DIR}" = "${PETSC_DIR}" ]; then \
2563c94ec11SBarry Smith	  echo "You did not set a directory to install to";\
2573c94ec11SBarry Smith        else \
258de21bb36SSatish Balay	  echo Installing PETSc documentation at ${INSTALL_DIR};\
2593c94ec11SBarry Smith          if [ ! -d `dirname ${INSTALL_DIR}` ]; then \
2603c94ec11SBarry Smith	    ${MKDIR} `dirname ${INSTALL_DIR}` ; \
261de21bb36SSatish Balay          fi;\
2623c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR} ]; then \
2633c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR} ; \
2643c94ec11SBarry Smith          fi;\
2653c94ec11SBarry Smith          cp -fr docs ${INSTALL_DIR};\
2663677444aSSatish Balay          ${RM} -fr docs/tex;\
2673677444aSSatish Balay        fi;
2683677444aSSatish Balay# ------------------------------------------------------------------
2693677444aSSatish Balay#
2703677444aSSatish Balay# All remaining actions are intended for PETSc developers only.
2713677444aSSatish Balay# PETSc users should not generally need to use these commands.
27265783a8cSBarry Smith#
27365783a8cSBarry Smith
27465783a8cSBarry Smith# To access the tags in EMACS, type M-x visit-tags-table and specify
27565783a8cSBarry Smith# the file petsc/TAGS.
27665783a8cSBarry Smith# 1) To move to where a PETSc function is defined, enter M-. and the
27765783a8cSBarry Smith#     function name.
2787acb7333SLois Curfman McInnes# 2) To search for a string and move to the first occurrence,
27911b6ed10SLois Curfman McInnes#     use M-x tags-search and the string.
28011b6ed10SLois Curfman McInnes#     To locate later occurrences, use M-,
281bfcd69bfSBarry Smith# Builds all etags files
2820c805e24SSatish Balayalletags:
2839d6c0ac5SBarry Smith	-@maint/generateetags.py
2849d6c0ac5SBarry Smith	-@find python -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON
2859d6c0ac5SBarry Smith
286b38bb785SSatish Balayallfortranstubs:
287f20f7ba3SSatish Balay	-@maint/generatefortranstubs.py ${BFORT}
2883677444aSSatish Balay#
289b38bb785SSatish Balay# These are here for the target allci and allco, and etags
29040dd3bbbSBarry Smith#
2919e28597bSBarry Smith
292f587520bSBarry SmithBMAKEFILES = bmake/common/base bmake/common/test bmake/adic.init bmake/adicmf.init
293f587520bSBarry SmithDOCS	   = bmake/readme
29440dd3bbbSBarry SmithSCRIPTS    = maint/builddist  maint/wwwman maint/xclude maint/bugReport.py maint/buildconfigtest maint/builddistlite \
2952e111b49SBarry Smith             maint/buildtest maint/checkBuilds.py maint/copylognightly maint/copylognightly.tao maint/countfiles maint/findbadfiles \
2968a8e0b3aSBarry Smith             maint/fixinclude maint/getexlist maint/getpdflabels.py maint/helpindex.py maint/hosts.local maint/hosts.solaris  \
297f587520bSBarry Smith             maint/lex.py  maint/mapnameslatex.py maint/startnightly maint/startnightly.tao maint/submitPatch.py \
2989d6c0ac5SBarry Smith             maint/update-docs.py  maint/wwwindex.py maint/xcludebackup maint/xcludecblas maint/zap maint/zapall \
299d56c4d9fSBarry Smith             python/PETSc/Configure.py python/PETSc/Options.py \
300ad56a76cSSatish Balay             python/PETSc/packages/*.py python/PETSc/utilities/*.py
3010e98dc4aSKris Buschelman
302ad56a76cSSatish Balaychk_loc:
303ad56a76cSSatish Balay	@if [ ${LOC}foo = foo ] ; then \
304ad56a76cSSatish Balay	  echo "*********************** ERROR ************************" ; \
305de21bb36SSatish Balay	  echo " Please specify LOC variable for eg: make allmanualpages LOC=/sandbox/petsc"; \
3062496ca06SSatish Balay	  echo "******************************************************";  false; fi
307a2fc510eSBarry Smith	@${MKDIR} ${LOC}/docs/manualpages
308f1d13e97SSatish Balay
309f1d13e97SSatish Balay# Builds all the documentation - should be done every night
310f1d13e97SSatish Balayalldoc: alldoc1 alldoc2
311f1d13e97SSatish Balay
312130c9832SBarry Smith# Build everything that goes into 'doc' dir except html sources
313ae6175c4SSatish Balayalldoc1: chk_loc deletemanualpages chk_concepts_dir
314130c9832SBarry Smith	-${OMAKE} ACTION=manualpages_buildcite tree_basic LOC=${LOC}
31548b2c0e9SBarry Smith	cd src/docs/tex/manual; ${OMAKE} build_manual.pdf LOC=${LOC}
316e901ffdcSSatish Balay	-${OMAKE} ACTION=manualpages tree_basic LOC=${LOC}
317130c9832SBarry Smith	-maint/wwwindex.py ${PETSC_DIR} ${LOC}
318e901ffdcSSatish Balay	-${OMAKE} ACTION=manexamples tree_basic LOC=${LOC}
319e901ffdcSSatish Balay	-${OMAKE} manconcepts LOC=${LOC}
32048b2c0e9SBarry Smith	-${OMAKE} ACTION=getexlist tree_basic LOC=${LOC}
321045ff3e0SBarry Smith	-${OMAKE} ACTION=exampleconcepts tree_basic LOC=${LOC}
322eaa4f80dSBarry Smith	-maint/helpindex.py ${PETSC_DIR} ${LOC}
323e01137a2SSatish Balay	-grep -h PolymorphicSubroutine include/*.h | grep -v '#define ' | sed "s?PetscPolymorphicSubroutine(??g" | cut -f1 -d"{" > tmppoly
324435da068SBarry Smith	-maint/processpoly.py ${PETSC_DIR} ${LOC}
325062da8f7SSatish Balay
326f1d13e97SSatish Balay# Builds .html versions of the source
3273a2060ecSSatish Balay# html overwrites some stuff created by update-docs - hence this is done later.
328f95977b4SBarry Smithalldoc2: chk_loc
329435da068SBarry Smith	-${OMAKE} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC}
330efaa7783SSatish Balay	-maint/update-docs.py ${PETSC_DIR} ${LOC}
331efaa7783SSatish Balay
332efaa7783SSatish Balayalldocclean: deletemanualpages allcleanhtml
333efaa7783SSatish Balay
3341c2a3de1SBarry Smith# Deletes man pages (HTML version)
3351c2a3de1SBarry Smithdeletemanualpages: chk_loc
336f587520bSBarry Smith	-@if [ -d ${LOC} -a -d ${LOC}/docs/manualpages ]; then \
337f587520bSBarry Smith          find ${LOC}/docs/manualpages -type f -name "*.html" -exec ${RM} {} \; ;\
3381c2a3de1SBarry Smith          ${RM} ${LOC}/docs/exampleconcepts ;\
339f95977b4SBarry Smith          ${RM} ${LOC}/docs/manconcepts ;\
3401c2a3de1SBarry Smith          ${RM} ${LOC}/docs/manualpages/manualpages.cit ;\
341efaa7783SSatish Balay          maint/update-docs.py ${PETSC_DIR} ${LOC} clean;\
342115a300dSBarry Smith        fi
3432d156eb4SBarry Smith
344cc4dcc40SBarry Smithallcleanhtml:
345395565bcSBarry Smith	-${RM} include/adic/*.h.html
346ad56a76cSSatish Balay	-${OMAKE} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} alltree
347fe742e3dSSatish Balay
348bfe54af3SSatish Balaychk_concepts_dir: chk_loc
349bdde29a3SBarry Smith	@if [ ! -d "${LOC}/docs/manualpages/concepts" ]; then \
350f6ff2982SSatish Balay	  echo Making directory ${LOC}/docs/manualpages/concepts for library; ${MKDIR} ${LOC}/docs/manualpages/concepts; fi
351d55938c2SBarry Smith#
352ab901514SBarry Smith
353b951964fSBarry Smithallci:
354d55938c2SBarry Smith	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} ACTION=ci  alltree
355ab901514SBarry Smith
356d55938c2SBarry Smithallco:
357791d64f4SSatish Balay	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} ACTION=co  alltree
358791d64f4SSatish Balay
359ab901514SBarry Smith# usage make allrcslabel NEW_RCS_LABEL=v_2_0_28
360b334301eSBarry Smithallrcslabel:
361b334301eSBarry Smith	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} NEW_RCS_LABEL=${NEW_RCS_LABEL} ACTION=rcslabel  alltree
362b334301eSBarry Smith#
363b334301eSBarry Smith#   The commands below are for generating ADIC versions of the code;
3645eea60f9SBarry Smith# they are not currently used.
365b87434adSSatish Balay#
366ab901514SBarry Smithalladicignore:
3675eea60f9SBarry Smith	-@${RM} ${INSTALL_LIB_DIR}/adicignore
3685eea60f9SBarry Smith	-@${OMAKE}  PETSC_ARCH=${PETSC_ARCH} ACTION=adicignore  tree
369d18b0ea7SBarry Smith
37067b024f7SSatish Balayalladic:
371d18b0ea7SBarry Smith	-@echo "Beginning to compile ADIC source code in all directories"
37247794344SBarry Smith	-@echo "Using ADIC compiler: ${ADIC_CC} ${CCPPFLAGS}"
37367b024f7SSatish Balay	-@echo "========================================="
374ab901514SBarry Smith	-@cd include ; \
37547794344SBarry Smith           ${ADIC_CC} -s -f 1 ${CCPPFLAGS} petsc.h
376ab901514SBarry Smith	-@${OMAKE}  PETSC_ARCH=${PETSC_ARCH} ACTION=adic  tree
3776e81b665SBarry Smith	-@cd src/inline ; \
37847794344SBarry Smith            ${OMAKE} PETSC_ARCH=${PETSC_ARCH} adic
379d18b0ea7SBarry Smith
380d77bb2e1SSatish Balayalladiclib:
381d18b0ea7SBarry Smith	-@echo "Beginning to compile ADIC libraries in all directories"
382d77bb2e1SSatish Balay	-@echo "Using compiler: ${CC} ${COPTFLAGS}"
383d18b0ea7SBarry Smith	-@echo "-----------------------------------------"
384e0e703c1SSatish Balay	-@echo "Using PETSc flags: ${PETSCFLAGS} ${PCONF}"
385ba1077baSMatthew Knepley	-@echo "-----------------------------------------"
386d18b0ea7SBarry Smith	-@echo "Using configuration flags:"
387d77bb2e1SSatish Balay	-@grep "define " bmake/${INLUDE_ARCH}/petscconf.h
388d18b0ea7SBarry Smith	-@echo "-----------------------------------------"
389d77bb2e1SSatish Balay	-@echo "Using include paths: ${PETSC_INCLUDE}"
39019552e71SMatthew Knepley	-@echo "-----------------------------------------"
391d18b0ea7SBarry Smith	-@echo "Using PETSc directory: ${PETSC_DIR}"
392e5175200SBarry Smith	-@echo "Using PETSc arch: ${PETSC_ARCH}"
393ab901514SBarry Smith	-@echo "========================================="
3947e351921SBarry Smith	-@${RM} -f  ${INSTALL_LIB_DIR}/*adic.${AR_LIB_SUFFIX}
395ab901514SBarry Smith	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} ACTION=adiclib  tree
3965eea60f9SBarry Smith	-@cd src/adic/src ; \
3979e417c50SSatish Balay            ${OMAKE} PETSC_ARCH=${PETSC_ARCH} lib
3989e417c50SSatish Balay
3999e417c50SSatish Balay# -------------------------------------------------------------------------------
4009e417c50SSatish Balay#
4019e417c50SSatish Balay# Some macros to check if the fortran interface is up-to-date.
402d77bb2e1SSatish Balay#
40385c7cd6cSSatish Balaycountfortranfunctions:
4049e417c50SSatish Balay	-@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \
405b334301eSBarry Smith	cut -d'(' -f1 | tr -s  ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \
4069e417c50SSatish Balay	sed "s/_$$//" | sort > /tmp/countfortranfunctions
40785c7cd6cSSatish Balay
40885c7cd6cSSatish Balaycountcfunctions:
4099e417c50SSatish Balay	-@ grep extern ${PETSC_DIR}/include/*.h *.h | grep "(" | tr -s ' ' | \
4109e417c50SSatish Balay	cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' |  \
4119e417c50SSatish Balay	tr 'A-Z' 'a-z' |  sort > /tmp/countcfunctions
4129e417c50SSatish Balay
4139700b7f8SSatish Balaydifffortranfunctions: countfortranfunctions countcfunctions
4149e417c50SSatish Balay	-@echo -------------- Functions missing in the fortran interface ---------------------
4159700b7f8SSatish Balay	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2
416d77bb2e1SSatish Balay	-@echo ----------------- Functions missing in the C interface ------------------------
417b334301eSBarry Smith	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2
4183f4c9a3aSSatish Balay	-@${RM}  /tmp/countcfunctions /tmp/countfortranfunctions
4193f4c9a3aSSatish Balay
4203f4c9a3aSSatish Balaycheckbadfortranstubs:
4213f4c9a3aSSatish Balay	-@echo "========================================="
422d77bb2e1SSatish Balay	-@echo "Functions with MPI_Comm as an Argument"
42385c7cd6cSSatish Balay	-@echo "========================================="
4243f4c9a3aSSatish Balay	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \
4253f4c9a3aSSatish Balay	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
4263f4c9a3aSSatish Balay	-@echo "========================================="
427d77bb2e1SSatish Balay	-@echo "Functions with a String as an Argument"
42885c7cd6cSSatish Balay	-@echo "========================================="
4293f4c9a3aSSatish Balay	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \
4303f4c9a3aSSatish Balay	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
4313f4c9a3aSSatish Balay	-@echo "========================================="
432d77bb2e1SSatish Balay	-@echo "Functions with Pointers to PETSc Objects as Argument"
43385c7cd6cSSatish Balay	-@echo "========================================="
43485c7cd6cSSatish Balay	-@cd ${PETSC_DIR}/src/fortran/auto; \
4353f4c9a3aSSatish Balay	_p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \
4363f4c9a3aSSatish Balay	cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \
43785c7cd6cSSatish Balay	sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \
4383f4c9a3aSSatish Balay	for OBJ in $$_p_OBJ; do \
4393f4c9a3aSSatish Balay	grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \
4404556b810SBarry Smith	cut -d'(' -f1 | cut -d' ' -f1,3; \
4414556b810SBarry Smith	done
442b6ea66eeSBarry Smith#
44375df30afSSatish Balay# Automatically generates PETSc exercises in html from the tutorial examples.
444b6ea66eeSBarry Smith#
445b6ea66eeSBarry Smith# The introduction for each section is obtained from docs/manualpages/header_${MANSEC} is under RCS and may be edited
446b6ea66eeSBarry Smith#  (used also in introductions to the manual pages)
447b6ea66eeSBarry Smith# The overall introduction is in docs/exercises/introduction.html and is under RCS and may be edited
4484556b810SBarry Smith# The list of exercises is from TUTORIALS in each directory's makefile
4494556b810SBarry Smith#
4504556b810SBarry Smith# DO NOT EDIT the pageform.txt or *.htm files generated since they will be automatically replaced.
451843ae28eSBarry Smith# The pagemaker rule is in the file bmake/common (at the bottom)
45297e8d271SBarry Smith#
453843ae28eSBarry Smith# Eventually the line below will replace the two cd in the rule below, it is just this way now for speed
45497e8d271SBarry Smith#	-@${OMAKE} PETSC_DIR=${PETSC_DIR} pagemaker
45597e8d271SBarry Smith#
45697e8d271SBarry Smithexercises:
457467fbd6dSBarry Smith	-@echo "========================================="
45897e8d271SBarry Smith	-@echo "Generating HTML tutorial exercises"
45997e8d271SBarry Smith	-@${RM} docs/pageform.txt
460beb1b3a5SBarry Smith	-@echo "title=\"PETSc Exercises\""                >  docs/pageform.txt
46197e8d271SBarry Smith	-@echo "access_title=Exercise Sections"              >>  docs/pageform.txt
46297e8d271SBarry Smith	-@echo "access_format=short"                        >> docs/pageform.txt
46397e8d271SBarry Smith	-@echo "startpage=../exercises/introduction.htm"  >> docs/pageform.txt
46497e8d271SBarry Smith	-@echo "NONE title=\"Introduction\" command=link src=../exercises/introduction.htm" >> docs/pageform.txt
465beb1b3a5SBarry Smith	-@echo "Generating HTML for individual directories"
46697e8d271SBarry Smith	-@echo "========================================="
46797e8d271SBarry Smith	-@${OMAKE} PETSC_DIR=${PETSC_DIR} ACTION=pagemaker tree
46897e8d271SBarry Smith	-@echo "Completed HTML for individual directories"
46997e8d271SBarry Smith	-@echo "NONE title=\"<HR>\" " >> docs/pageform.txt;
47097e8d271SBarry Smith	-@echo "NONE title=\"PETSc Documentation\" command=link src=../index.html target=replace" >> docs/pageform.txt
47197e8d271SBarry Smith	/home/MPI/class/mpiexmpl/maint/makepage.new -pageform=docs/pageform.txt -access_extra=/dev/null -outdir=docs/exercises
472b4b3a923SMatthew Knepley	-@echo "========================================="
473b4b3a923SMatthew Knepley
474b4b3a923SMatthew Knepley# Make a tarball of all the Python code
475b4b3a923SMatthew Knepley#   This is currently used to release to the Teragrid
476b4b3a923SMatthew KnepleypetscPython.tgz:
477b4b3a923SMatthew Knepley	@tar cvzf $@ --exclude SCCS --exclude BitKeeper --dereference python/
4788852b4e5SMatthew Knepley	-@scp $@ tg-login2.uc.teragrid.org:./
479de21bb36SSatish Balay
4809d6c0ac5SBarry Smith.PHONY: info info_h all all_build build testexamples testfortran testexamples_uni testfortran_uni ranlib deletelibs allclean update chk_petsc_dir \
481b4b3a923SMatthew Knepley        alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanualpages \
482f7819401SBarry Smith        allhtml allcleanhtml  allci allco allrcslabel alladicignore alladic alladiclib countfortranfunctions \
483        start_configure configure_petsc configure_clean petscPython.tgz
484
485