xref: /petsc/makefile (revision 40dd3bbb42d466a243a86400762d3285c0873f94)
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:
17b5fa40b8SBarry Smith	@${OMAKE}  PETSC_ARCH=${PETSC_ARCH} BOPT=${BOPT} chkpetsc_dir
1829cdbbc8SSatish Balay	-@${OMAKE} all_build 2>&1 | tee make_log_${PETSC_ARCH}_${BOPT}
199d6c0ac5SBarry Smithall_build: chk_petsc_dir chklib_dir info info_h deletelibs  blaslapack 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 " "
26d76296fbSBarry Smith	-@echo "See docs/troubleshooting.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`
37efd74e9bSBarry Smith	-@echo "-----------------------------------------"
38e481929fSSatish Balay	-@echo "Using PETSc directory: ${PETSC_DIR}"
39e481929fSSatish Balay	-@echo "Using PETSc arch: ${PETSC_ARCH}"
4047794344SBarry Smith	-@echo "-----------------------------------------"
41bdd8b494SSatish Balay	-@grep "define PETSC_VERSION" ${PETSC_DIR}/include/petscversion.h | ${SED} "s/........//"
42f265ae5cSBarry Smith	-@echo "-----------------------------------------"
43e0e703c1SSatish Balay	-@echo "Using configuration flags:"
4419552e71SMatthew Knepley	-@grep "\#define " ${PETSC_DIR}/bmake/${PETSC_ARCH}/petscconf.h
4547794344SBarry Smith	-@echo "-----------------------------------------"
46d77bb2e1SSatish Balay	-@echo "Using include paths: ${PETSC_INCLUDE}"
47e481929fSSatish Balay	-@echo "Using PETSc flags: ${PETSCFLAGS} ${PCONF}"
48efd74e9bSBarry Smith	-@echo "------------------------------------------"
49e481929fSSatish Balay	-@echo "Using C/C++ compiler: ${CC} ${COPTFLAGS} ${CCPPFLAGS}"
50e481929fSSatish Balay	-@echo "C/C++ Compiler version: " `${CCV}`
51e481929fSSatish Balay	-@if [ "${FC}" != "" ]; then \
52e481929fSSatish Balay	   echo "Using Fortran compiler: ${FC} ${FOPTFLAGS} ${FCPPFLAGS}";\
53e481929fSSatish Balay	   echo "Fortran Compiler version: " `${FCV}`;\
54e481929fSSatish Balay         fi
55e481929fSSatish Balay	-@echo "-----------------------------------------"
564a44a727SBarry Smith	-@echo "Using C/C++ linker: ${CLINKER}"
57e481929fSSatish Balay	-@if [ "${FC}" != "" ]; then \
58e6ee457dSBarry Smith	   echo "Using Fortran linker: ${FLINKER}";\
59e6ee457dSBarry Smith         fi
60e481929fSSatish Balay	-@echo "-----------------------------------------"
61f2b01315SBarry Smith	-@echo "Using libraries: ${PETSC_LIB}"
62e3353558SSatish Balay	-@echo "------------------------------------------"
63e3353558SSatish Balay	-@echo "Using mpirun: ${MPIRUN}"
64efd74e9bSBarry Smith	-@echo "=========================================="
65b8d81f61SBarry Smith#
66b8d81f61SBarry Smith#
6719552e71SMatthew KnepleyMINFO = ${PETSC_DIR}/bmake/${PETSC_ARCH}/petscmachineinfo.h
68b8d81f61SBarry Smithinfo_h:
69ddbfe947SBarry Smith	-@$(RM) -f MINFO ${MINFO}
702fc52814SBarry Smith	-@echo  "static const char *petscmachineinfo = \"  " >> MINFO
7134a92de5SBarry Smith	-@echo  "Libraries compiled on `date` on `hostname` " >> MINFO
72c5e9c7dfSBarry Smith	-@echo  Machine characteristics: `uname -a` "" >> MINFO
73f6a9982fSBarry Smith	-@echo  "Using PETSc directory: ${PETSC_DIR}" >> MINFO
7419552e71SMatthew Knepley	-@echo  "Using PETSc arch: ${PETSC_ARCH}" >> MINFO
7593520af8SSatish Balay	-@echo  "-----------------------------------------\"; " >> MINFO
762fc52814SBarry Smith	-@echo  "static const char *petsccompilerinfo = \"  " >> MINFO
775323642bSKris Buschelman	-@echo  "Using C compiler: ${C_CC} ${COPTFLAGS} ${CCPPFLAGS} " >> MINFO
78dffd13fbSMatthew Knepley	-@echo  "C Compiler version:"  >> MINFO ; ${C_CCV} >> MINFO 2>&1 ; true
79dffd13fbSMatthew Knepley	-@echo  "C++ Compiler version:"  >> MINFO; ${CXX_CCV} >> MINFO 2>&1 ; true
805323642bSKris Buschelman	-@echo  "Using Fortran compiler: ${C_FC} ${FOPTFLAGS} ${FCPPFLAGS}" >> MINFO
81dffd13fbSMatthew Knepley	-@echo  "Fortran Compiler version:" >> MINFO ; ${C_FCV} >> MINFO 2>&1 ; true
8293520af8SSatish Balay	-@echo  "-----------------------------------------\"; " >> MINFO
832fc52814SBarry Smith	-@echo  "static const char *petsccompilerflagsinfo = \"  " >> MINFO
84c5e9c7dfSBarry Smith	-@echo  "Using PETSc flags: ${PETSCFLAGS} ${PCONF}" >> MINFO
85c5e9c7dfSBarry Smith	-@echo  "-----------------------------------------" >> MINFO
86c5e9c7dfSBarry Smith	-@echo  "Using configuration flags:" >> MINFO
87c5e9c7dfSBarry Smith	-@echo  "-----------------------------------------" >> MINFO
88c5e9c7dfSBarry Smith	-@echo  "Using include paths: ${PETSC_INCLUDE}" >> MINFO
8993520af8SSatish Balay	-@echo  "------------------------------------------\"; " >> MINFO
902fc52814SBarry Smith	-@echo  "static const char *petsclinkerinfo = \"  " >> MINFO
91c5e9c7dfSBarry Smith	-@echo  "Using C linker: ${CLINKER}" >> MINFO
92c5e9c7dfSBarry Smith	-@echo  "Using Fortran linker: ${FLINKER}" >> MINFO
9393520af8SSatish Balay	-@echo  "Using libraries: ${PETSC_LIB} \"; " >> MINFO
94a2d9a622SKris Buschelman	-@cat MINFO | ${SED} -e 's/\^M//g' | ${SED} -e 's/\\/\\\\/g' | ${SED} -e 's/$$/ \\n\\/' | sed -e 's/\;  \\n\\/\;/'> MINFO_
95aa0c092eSKris Buschelman	-@cat MINFO_ | ${SED} -e 's/\
96aa0c092eSKris Buschelman//g'  > /dev/null; foobar=$$?; \
97a2d9a622SKris Buschelman          if [ "$$foobar" = "0" ]; then \
98a2d9a622SKris Buschelman	    cat MINFO_ | ${SED} -e 's/\
99a2d9a622SKris Buschelman//g' > ${MINFO}; \
100f194edaeSKris Buschelman          else cat MINFO | ${SED} -e 's/\^M//g' | ${SED} -e 's/\\/\\\\/g' | ${SED} -e 's/$$/ \\n\\/' | sed -e 's/\;  \\n\\/\;/'> ${MINFO}; \
101ce0f4ea0SKris Buschelman          fi
1023677444aSSatish Balay	-@$(RM) MINFO MINFO_
103fa527775SLois Curfman McInnes
104fa527775SLois Curfman McInnes#
105f6a9982fSBarry Smith# Builds the PETSc libraries
1063677444aSSatish Balay# This target also builds fortran77 and f90 interface
107f6a9982fSBarry Smith# files and compiles .F files
108efd74e9bSBarry Smith#
10947794344SBarry Smithbuild:
11044ecba3fSMatthew Knepley	-@echo "BEGINNING TO COMPILE LIBRARIES IN ALL DIRECTORIES"
111e5175200SBarry Smith	-@echo "========================================="
1120b3634f8SBarry Smith	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=libfast tree
11347794344SBarry Smith	-@${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}
11435ca7349SBarry Smith	-@echo "Completed building libraries"
115c8fd01ffSBarry Smith	-@echo "========================================="
116c8fd01ffSBarry Smith#
1179d6c0ac5SBarry Smith#  Compiles the blas and lapack source code if found
118c8fd01ffSBarry Smithblaslapack:
119c8fd01ffSBarry Smith	-@if [ -d externalpackages/f2cblaslapack/${PETSC_ARCH} -a ! -s externalpackages/f2cblaslapack/${PETSC_ARCH}/libf2cblas.a ] ; then cd externalpackages/f2cblaslapack;\
120c8fd01ffSBarry Smith        echo "=========================================";\
121c8fd01ffSBarry Smith        echo "Building C Blas/Lapack libraries";\
12282fb4bcfSBarry Smith        ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ;\
123c8fd01ffSBarry Smith        ${MV} libf2cblas.a libf2clapack.a ${PETSC_ARCH};\
124c8fd01ffSBarry Smith        ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} cleanblaslapack ;\
125c8fd01ffSBarry Smith        echo "Completed C building Blas/Lapack libraries";\
1266f02d409SBarry Smith        echo "========================================="; fi
1279d6c0ac5SBarry Smith#
1288744090aSBarry Smith#
1292492ecdbSBarry Smith# Builds PETSc test examples for a given architecture
13004f117c6SBarry Smith#
13104f117c6SBarry Smithtest:
1324f5ab15aSBarry Smith	-@echo "Running test examples to verify correct installation"
13304f117c6SBarry Smith	@cd src/snes/examples/tutorials; ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex19
1340ce59502SBarry Smith	@if [ "${FC}" != "" ]; then cd src/snes/examples/tutorials; ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex5f; fi;
1352492ecdbSBarry Smith	-@echo "Completed test examples"
1363677444aSSatish Balay
1373677444aSSatish Balaytestexamples: info
1383677444aSSatish Balay	-@echo "BEGINNING TO COMPILE AND RUN TEST EXAMPLES"
1393677444aSSatish Balay	-@echo "Due to different numerical round-off on certain"
14019552e71SMatthew Knepley	-@echo "machines some of the numbers may not match exactly."
1413677444aSSatish Balay	-@echo "========================================="
1423677444aSSatish Balay	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ACTION=testexamples_1  tree
1432492ecdbSBarry Smith	-@echo "Completed compiling and running test examples"
1443677444aSSatish Balay	-@echo "========================================="
1453677444aSSatish Balaytestfortran: info
1463677444aSSatish Balay	-@echo "BEGINNING TO COMPILE AND RUN FORTRAN TEST EXAMPLES"
1473677444aSSatish Balay	-@echo "========================================="
1483677444aSSatish Balay	-@echo "Due to different numerical round-off on certain"
1493677444aSSatish Balay	-@echo "machines or the way Fortran formats numbers"
1504b5d664cSKris Buschelman	-@echo "some of the results may not match exactly."
1514b5d664cSKris Buschelman	-@echo "========================================="
1526d2f2efaSKris Buschelman	-@if [ "${C_FC}" != "" ]; then \
1536d2f2efaSKris Buschelman            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_3 tree; \
1546d2f2efaSKris Buschelman            echo "Completed compiling and running Fortran test examples"; \
1554b5d664cSKris Buschelman          else \
1563677444aSSatish Balay            echo "Error: No FORTRAN compiler available"; \
1572492ecdbSBarry Smith          fi
15801c5c36fSSatish Balay	-@echo "========================================="
15901c5c36fSSatish Balaytestexamples_uni: info
16001c5c36fSSatish Balay	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR EXAMPLES"
16101c5c36fSSatish Balay	-@echo "Due to different numerical round-off on certain"
16219552e71SMatthew Knepley	-@echo "machines some of the numbers may not match exactly."
16301c5c36fSSatish Balay	-@echo "========================================="
16401c5c36fSSatish Balay	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_4  tree
1652492ecdbSBarry Smith	-@echo "Completed compiling and running uniprocessor test examples"
1663677444aSSatish Balay	-@echo "========================================="
1673677444aSSatish Balaytestfortran_uni: info
1683677444aSSatish Balay	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR FORTRAN EXAMPLES"
1693677444aSSatish Balay	-@echo "Due to different numerical round-off on certain"
1704b5d664cSKris Buschelman	-@echo "machines some of the numbers may not match exactly."
1714b5d664cSKris Buschelman	-@echo "========================================="
1726d2f2efaSKris Buschelman	-@if [ "${C_FC}" != "" ]; then \
1736d2f2efaSKris Buschelman            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_9  tree; \
1746d2f2efaSKris Buschelman            echo "Completed compiling and running uniprocessor fortran test examples"; \
1754b5d664cSKris Buschelman          else \
1766d2f2efaSKris Buschelman            echo "Error: No FORTRAN compiler available"; \
1773677444aSSatish Balay          fi
178ad96cc0dSLois Curfman McInnes	-@
179f3eacedaSSatish Balay	-@echo "========================================="
1808c37ef55SBarry Smith
181e5175200SBarry Smith# Ranlib on the libraries
18261523587SBarry Smithranlib:
18311b6ed10SLois Curfman McInnes	${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}
1842492ecdbSBarry Smith
185b87434adSSatish Balay# Deletes PETSc libraries
186d44968ceSBarry Smithdeletelibs:
187a42cec9dSMatthew Knepley	-${RM} -f ${PETSC_LIB_DIR}/*
188a42cec9dSMatthew Knepley
18919552e71SMatthew Knepley# Cleans up build
190a42cec9dSMatthew Knepleyallclean: deletelibs
1913677444aSSatish Balay	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=clean tree
1924918a6b0SSatish Balay
1934918a6b0SSatish Balay
1944918a6b0SSatish Balay#
1954918a6b0SSatish Balay# Check if PETSC_DIR variable specified is valid
1964918a6b0SSatish Balay#
1971390f061SBarry Smithchk_petsc_dir:
1981390f061SBarry Smith	@if [ ! -f ${PETSC_DIR}/include/petscversion.h ]; then \
1991390f061SBarry Smith	  echo "Incorrect PETSC_DIR specified: ${PETSC_DIR}!"; \
2004918a6b0SSatish Balay	  echo "You need to use / to separate directories, not \\!"; \
20175910670SSatish Balay	  echo "Aborting build"; \
20275910670SSatish Balay	  false; fi
20375910670SSatish Balay#
20475910670SSatish Balay# ${PETSC_DIR}/bmake/common/bopt_ is generated by configure - but if non-configure PETSC_ARCH
2053c94ec11SBarry Smith# is used - create this file manually when libraries are created.
2063c94ec11SBarry Smith#
207fe0e97ccSBarry Smithinstall:
2083c94ec11SBarry Smith	-@if [ "${INSTALL_DIR}" == "${PETSC_DIR}" ]; then \
2093c94ec11SBarry Smith	  echo "Install directory is current directory; nothing needs to be done";\
2103c94ec11SBarry Smith        else \
211de21bb36SSatish Balay	  echo Installing PETSc at ${INSTALL_DIR};\
2123c94ec11SBarry Smith          if [ ! -d `dirname ${INSTALL_DIR}` ]; then \
2133c94ec11SBarry Smith	    ${MKDIR} `dirname ${INSTALL_DIR}` ; \
214de21bb36SSatish Balay          fi;\
2153c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR} ]; then \
2163c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR} ; \
2173c94ec11SBarry Smith          fi;\
218de21bb36SSatish Balay          cp -fr include ${INSTALL_DIR};\
2193c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR}/bmake ]; then \
2203c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR}/bmake ; \
2213c94ec11SBarry Smith          fi;\
2223c94ec11SBarry Smith          cp -f bmake/adic* bmake/variables ${INSTALL_DIR}/bmake ; \
2233c94ec11SBarry Smith          cp -fr bmake/common ${INSTALL_DIR}/bmake;\
2243c94ec11SBarry Smith          cp -fr bmake/${PETSC_ARCH} ${INSTALL_DIR}/bmake;\
225de21bb36SSatish Balay          cp -fr bin ${INSTALL_DIR};\
2263c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR}/lib ]; then \
2273c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR}/lib ; \
2283c94ec11SBarry Smith          fi;\
2293c94ec11SBarry Smith          for i in lib/lib*; do \
230de21bb36SSatish Balay            bopt=`echo $${i} | ${SED} s=lib/lib==g`;\
2313c94ec11SBarry Smith            if [ ! -d ${INSTALL_DIR}/$${i} ]; then \
2323c94ec11SBarry Smith              ${MKDIR} ${INSTALL_DIR}/$${i};\
2333c94ec11SBarry Smith            fi; \
2343c94ec11SBarry Smith            if [ -d $${i}/${PETSC_ARCH} ]; then \
2353c94ec11SBarry Smith              cp -fr $${i}/${PETSC_ARCH} ${INSTALL_DIR}/$${i};\
2363c94ec11SBarry Smith              ${RANLIB}  ${INSTALL_DIR}/$${i}/*.a > /dev/null 2>&1 ;\
2373c94ec11SBarry Smith              ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${INSTALL_DIR} BOPT=$${bopt} shared; \
2383c94ec11SBarry Smith            fi;\
2393c94ec11SBarry Smith          done;\
2403c94ec11SBarry Smith          echo "sh/bash: PETSC_DIR="${INSTALL_DIR}"; export PETSC_DIR";\
2413c94ec11SBarry Smith          echo "csh/tcsh: setenv PETSC_DIR "${INSTALL_DIR} ;\
2423c94ec11SBarry Smith          echo "The do make test to verify correct install";\
2433c94ec11SBarry Smith        fi;
2443c94ec11SBarry Smith
2453c94ec11SBarry Smithinstall_src:
2463c94ec11SBarry Smith	-@if [ "${INSTALL_DIR}" == "${PETSC_DIR}" ]; then \
2473c94ec11SBarry Smith	  echo "You did not set a directory to install to";\
2483c94ec11SBarry Smith        else \
249de21bb36SSatish Balay	  echo Installing PETSc source at ${INSTALL_DIR};\
2503c94ec11SBarry Smith          if [ ! -d `dirname ${INSTALL_DIR}` ]; then \
2513c94ec11SBarry Smith	    ${MKDIR} `dirname ${INSTALL_DIR}` ; \
252de21bb36SSatish Balay          fi;\
2533c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR} ]; then \
2543c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR} ; \
2553c94ec11SBarry Smith          fi;\
2563c94ec11SBarry Smith          cp -fr src ${INSTALL_DIR};\
2573c94ec11SBarry Smith        fi;
2583c94ec11SBarry Smith
2593c94ec11SBarry Smithinstall_docs:
2603c94ec11SBarry Smith	-@if [ "${INSTALL_DIR}" == "${PETSC_DIR}" ]; then \
2613c94ec11SBarry Smith	  echo "You did not set a directory to install to";\
2623c94ec11SBarry Smith        else \
263de21bb36SSatish Balay	  echo Installing PETSc documentation at ${INSTALL_DIR};\
2643c94ec11SBarry Smith          if [ ! -d `dirname ${INSTALL_DIR}` ]; then \
2653c94ec11SBarry Smith	    ${MKDIR} `dirname ${INSTALL_DIR}` ; \
266de21bb36SSatish Balay          fi;\
2673c94ec11SBarry Smith          if [ ! -d ${INSTALL_DIR} ]; then \
2683c94ec11SBarry Smith	    ${MKDIR} ${INSTALL_DIR} ; \
2693c94ec11SBarry Smith          fi;\
2703c94ec11SBarry Smith          cp -fr docs ${INSTALL_DIR};\
2713677444aSSatish Balay          ${RM} -fr docs/tex;\
2723677444aSSatish Balay        fi;
2733677444aSSatish Balay# ------------------------------------------------------------------
2743677444aSSatish Balay#
2753677444aSSatish Balay# All remaining actions are intended for PETSc developers only.
2763677444aSSatish Balay# PETSc users should not generally need to use these commands.
27765783a8cSBarry Smith#
27865783a8cSBarry Smith
27965783a8cSBarry Smith# To access the tags in EMACS, type M-x visit-tags-table and specify
28065783a8cSBarry Smith# the file petsc/TAGS.
28165783a8cSBarry Smith# 1) To move to where a PETSc function is defined, enter M-. and the
28265783a8cSBarry Smith#     function name.
2837acb7333SLois Curfman McInnes# 2) To search for a string and move to the first occurrence,
28411b6ed10SLois Curfman McInnes#     use M-x tags-search and the string.
28511b6ed10SLois Curfman McInnes#     To locate later occurrences, use M-,
286bfcd69bfSBarry Smith# Builds all etags files
2879d6c0ac5SBarry Smithalletags:
2889d6c0ac5SBarry Smith	-@maint/generateetags.py
2899d6c0ac5SBarry Smith
290b38bb785SSatish Balayallfortranstubs:
291f20f7ba3SSatish Balay	-@maint/generatefortranstubs.py ${BFORT}
2923677444aSSatish Balay#
293b38bb785SSatish Balay# These are here for the target allci and allco, and etags
294*40dd3bbbSBarry Smith#
2959e28597bSBarry Smith
296f587520bSBarry SmithBMAKEFILES = bmake/common/base bmake/common/test bmake/adic.init bmake/adicmf.init
297f587520bSBarry SmithDOCS	   = bmake/readme
298*40dd3bbbSBarry SmithSCRIPTS    = maint/builddist  maint/wwwman maint/xclude maint/bugReport.py maint/buildconfigtest maint/builddistlite \
2992e111b49SBarry Smith             maint/buildtest maint/checkBuilds.py maint/copylognightly maint/copylognightly.tao maint/countfiles maint/findbadfiles \
3008a8e0b3aSBarry Smith             maint/fixinclude maint/getexlist maint/getpdflabels.py maint/helpindex.py maint/hosts.local maint/hosts.solaris  \
301f587520bSBarry Smith             maint/lex.py  maint/mapnameslatex.py maint/startnightly maint/startnightly.tao maint/submitPatch.py \
3029d6c0ac5SBarry Smith             maint/update-docs.py  maint/wwwindex.py maint/xcludebackup maint/xcludecblas maint/zap maint/zapall \
303d56c4d9fSBarry Smith             python/PETSc/Configure.py python/PETSc/Options.py \
304ad56a76cSSatish Balay             python/PETSc/packages/*.py python/PETSc/utilities/*.py
305ad56a76cSSatish Balay
306ad56a76cSSatish Balaychk_loc:
307ad56a76cSSatish Balay	@if [ ${LOC}foo = foo ] ; then \
308ad56a76cSSatish Balay	  echo "*********************** ERROR ************************" ; \
309de21bb36SSatish Balay	  echo " Please specify LOC variable for eg: make allmanualpages LOC=/sandbox/petsc"; \
3102496ca06SSatish Balay	  echo "******************************************************";  false; fi
311a2fc510eSBarry Smith	@${MKDIR} ${LOC}/docs/manualpages
312f1d13e97SSatish Balay
313f1d13e97SSatish Balay# Builds all the documentation - should be done every night
314f1d13e97SSatish Balayalldoc: alldoc1 alldoc2
315f1d13e97SSatish Balay
316130c9832SBarry Smith# Build everything that goes into 'doc' dir except html sources
317ae6175c4SSatish Balayalldoc1: chk_loc deletemanualpages chk_concepts_dir
318130c9832SBarry Smith	-${OMAKE} ACTION=manualpages_buildcite tree_basic LOC=${LOC}
31948b2c0e9SBarry Smith	cd src/docs/tex/manual; ${OMAKE} build_manual.pdf LOC=${LOC}
320130c9832SBarry Smith	-${OMAKE} ACTION=manualpages tree_basic LOC=${LOC}
321130c9832SBarry Smith	-maint/wwwindex.py ${PETSC_DIR} ${LOC}
32248b2c0e9SBarry Smith	-${OMAKE} ACTION=manexamples tree LOC=${LOC}
32348b2c0e9SBarry Smith	-${OMAKE} manconcepts LOC=${LOC}
32448b2c0e9SBarry Smith	-${OMAKE} ACTION=getexlist tree LOC=${LOC}
325e01137a2SSatish Balay	-${OMAKE} ACTION=exampleconcepts tree LOC=${LOC}
326435da068SBarry Smith	-maint/helpindex.py ${PETSC_DIR} ${LOC}
327062da8f7SSatish Balay
328f1d13e97SSatish Balay# Builds .html versions of the source
3293a2060ecSSatish Balay# html overwrites some stuff created by update-docs - hence this is done later.
330f95977b4SBarry Smithalldoc2: chk_loc
331435da068SBarry Smith	-${OMAKE} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC}
332efaa7783SSatish Balay	-maint/update-docs.py ${PETSC_DIR} ${LOC}
333efaa7783SSatish Balay
334efaa7783SSatish Balayalldocclean: deletemanualpages allcleanhtml
335efaa7783SSatish Balay
3361c2a3de1SBarry Smith# Deletes man pages (HTML version)
3371c2a3de1SBarry Smithdeletemanualpages: chk_loc
338f587520bSBarry Smith	-@if [ -d ${LOC} -a -d ${LOC}/docs/manualpages ]; then \
339f587520bSBarry Smith          find ${LOC}/docs/manualpages -type f -name "*.html" -exec ${RM} {} \; ;\
3401c2a3de1SBarry Smith          ${RM} ${LOC}/docs/exampleconcepts ;\
341f95977b4SBarry Smith          ${RM} ${LOC}/docs/manconcepts ;\
3421c2a3de1SBarry Smith          ${RM} ${LOC}/docs/manualpages/manualpages.cit ;\
343efaa7783SSatish Balay          maint/update-docs.py ${PETSC_DIR} ${LOC} clean;\
344115a300dSBarry Smith        fi
3452d156eb4SBarry Smith
346cc4dcc40SBarry Smithallcleanhtml:
347395565bcSBarry Smith	-${RM} include/adic/*.h.html
348ad56a76cSSatish Balay	-${OMAKE} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} alltree
349fe742e3dSSatish Balay
350bfe54af3SSatish Balaychk_concepts_dir: chk_loc
351bdde29a3SBarry Smith	@if [ ! -d "${LOC}/docs/manualpages/concepts" ]; then \
352f6ff2982SSatish Balay	  echo Making directory ${LOC}/docs/manualpages/concepts for library; ${MKDIR} ${LOC}/docs/manualpages/concepts; fi
353d55938c2SBarry Smith#
35419552e71SMatthew Knepley
355b951964fSBarry Smithallci:
356d55938c2SBarry Smith	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=ci  alltree
35719552e71SMatthew Knepley
358d55938c2SBarry Smithallco:
359791d64f4SSatish Balay	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=co  alltree
360791d64f4SSatish Balay
36119552e71SMatthew Knepley# usage make allrcslabel NEW_RCS_LABEL=v_2_0_28
362b334301eSBarry Smithallrcslabel:
363b334301eSBarry Smith	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} NEW_RCS_LABEL=${NEW_RCS_LABEL} ACTION=rcslabel  alltree
364b334301eSBarry Smith#
365b334301eSBarry Smith#   The commands below are for generating ADIC versions of the code;
3665eea60f9SBarry Smith# they are not currently used.
367b87434adSSatish Balay#
36819552e71SMatthew Knepleyalladicignore:
3695eea60f9SBarry Smith	-@${RM} ${INSTALL_LIB_DIR}/adicignore
3705eea60f9SBarry Smith	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adicignore  tree
371d18b0ea7SBarry Smith
37267b024f7SSatish Balayalladic:
373d18b0ea7SBarry Smith	-@echo "Beginning to compile ADIC source code in all directories"
37447794344SBarry Smith	-@echo "Using ADIC compiler: ${ADIC_CC} ${CCPPFLAGS}"
37567b024f7SSatish Balay	-@echo "========================================="
37619552e71SMatthew Knepley	-@cd include ; \
37747794344SBarry Smith           ${ADIC_CC} -s -f 1 ${CCPPFLAGS} petsc.h
37819552e71SMatthew Knepley	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adic  tree
37977ed5343SBarry Smith	-@cd src/inline ; \
38019552e71SMatthew Knepley            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} adic
3816e81b665SBarry Smith	-@cd src/blaslapack ; \
38247794344SBarry Smith            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adic  tree
383d18b0ea7SBarry Smith
384d77bb2e1SSatish Balayalladiclib:
385d18b0ea7SBarry Smith	-@echo "Beginning to compile ADIC libraries in all directories"
386d77bb2e1SSatish Balay	-@echo "Using compiler: ${CC} ${COPTFLAGS}"
387d18b0ea7SBarry Smith	-@echo "-----------------------------------------"
388e0e703c1SSatish Balay	-@echo "Using PETSc flags: ${PETSCFLAGS} ${PCONF}"
389ba1077baSMatthew Knepley	-@echo "-----------------------------------------"
390d18b0ea7SBarry Smith	-@echo "Using configuration flags:"
391d77bb2e1SSatish Balay	-@grep "define " bmake/${INLUDE_ARCH}/petscconf.h
392d18b0ea7SBarry Smith	-@echo "-----------------------------------------"
393d77bb2e1SSatish Balay	-@echo "Using include paths: ${PETSC_INCLUDE}"
39419552e71SMatthew Knepley	-@echo "-----------------------------------------"
395d18b0ea7SBarry Smith	-@echo "Using PETSc directory: ${PETSC_DIR}"
396e5175200SBarry Smith	-@echo "Using PETSc arch: ${PETSC_ARCH}"
39719552e71SMatthew Knepley	-@echo "========================================="
39877ed5343SBarry Smith	-@${RM} -f  ${INSTALL_LIB_DIR}/*adic.${AR_LIB_SUFFIX}
39919552e71SMatthew Knepley	-@${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adiclib  tree
4007e351921SBarry Smith	-@cd src/blaslapack ; \
40119552e71SMatthew Knepley            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} ACTION=adiclib  tree
4025eea60f9SBarry Smith	-@cd src/adic/src ; \
4039e417c50SSatish Balay            ${OMAKE} BOPT=${BOPT} PETSC_ARCH=${PETSC_ARCH} lib
4049e417c50SSatish Balay
4059e417c50SSatish Balay# -------------------------------------------------------------------------------
4069e417c50SSatish Balay#
4079e417c50SSatish Balay# Some macros to check if the fortran interface is up-to-date.
408d77bb2e1SSatish Balay#
40985c7cd6cSSatish Balaycountfortranfunctions:
4109e417c50SSatish Balay	-@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \
411b334301eSBarry Smith	cut -d'(' -f1 | tr -s  ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \
4129e417c50SSatish Balay	sed "s/_$$//" | sort > /tmp/countfortranfunctions
41385c7cd6cSSatish Balay
41485c7cd6cSSatish Balaycountcfunctions:
4159e417c50SSatish Balay	-@ grep extern ${PETSC_DIR}/include/*.h *.h | grep "(" | tr -s ' ' | \
4169e417c50SSatish Balay	cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' |  \
4179e417c50SSatish Balay	tr 'A-Z' 'a-z' |  sort > /tmp/countcfunctions
4189e417c50SSatish Balay
4199700b7f8SSatish Balaydifffortranfunctions: countfortranfunctions countcfunctions
4209e417c50SSatish Balay	-@echo -------------- Functions missing in the fortran interface ---------------------
4219700b7f8SSatish Balay	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2
422d77bb2e1SSatish Balay	-@echo ----------------- Functions missing in the C interface ------------------------
423b334301eSBarry Smith	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2
4243f4c9a3aSSatish Balay	-@${RM}  /tmp/countcfunctions /tmp/countfortranfunctions
4253f4c9a3aSSatish Balay
4263f4c9a3aSSatish Balaycheckbadfortranstubs:
4273f4c9a3aSSatish Balay	-@echo "========================================="
428d77bb2e1SSatish Balay	-@echo "Functions with MPI_Comm as an Argument"
42985c7cd6cSSatish Balay	-@echo "========================================="
4303f4c9a3aSSatish Balay	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \
4313f4c9a3aSSatish Balay	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
4323f4c9a3aSSatish Balay	-@echo "========================================="
433d77bb2e1SSatish Balay	-@echo "Functions with a String as an Argument"
43485c7cd6cSSatish Balay	-@echo "========================================="
4353f4c9a3aSSatish Balay	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \
4363f4c9a3aSSatish Balay	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
4373f4c9a3aSSatish Balay	-@echo "========================================="
438d77bb2e1SSatish Balay	-@echo "Functions with Pointers to PETSc Objects as Argument"
43985c7cd6cSSatish Balay	-@echo "========================================="
44085c7cd6cSSatish Balay	-@cd ${PETSC_DIR}/src/fortran/auto; \
4413f4c9a3aSSatish Balay	_p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \
4423f4c9a3aSSatish Balay	cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \
44385c7cd6cSSatish Balay	sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \
4443f4c9a3aSSatish Balay	for OBJ in $$_p_OBJ; do \
4453f4c9a3aSSatish Balay	grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \
4464556b810SBarry Smith	cut -d'(' -f1 | cut -d' ' -f1,3; \
4474556b810SBarry Smith	done
448b6ea66eeSBarry Smith#
44975df30afSSatish Balay# Automatically generates PETSc exercises in html from the tutorial examples.
450b6ea66eeSBarry Smith#
451b6ea66eeSBarry Smith# The introduction for each section is obtained from docs/manualpages/header_${MANSEC} is under RCS and may be edited
452b6ea66eeSBarry Smith#  (used also in introductions to the manual pages)
453b6ea66eeSBarry Smith# The overall introduction is in docs/exercises/introduction.html and is under RCS and may be edited
4544556b810SBarry Smith# The list of exercises is from TUTORIALS in each directory's makefile
4554556b810SBarry Smith#
4564556b810SBarry Smith# DO NOT EDIT the pageform.txt or *.htm files generated since they will be automatically replaced.
457843ae28eSBarry Smith# The pagemaker rule is in the file bmake/common (at the bottom)
45897e8d271SBarry Smith#
459843ae28eSBarry Smith# Eventually the line below will replace the two cd in the rule below, it is just this way now for speed
46097e8d271SBarry Smith#	-@${OMAKE} PETSC_DIR=${PETSC_DIR} pagemaker
46197e8d271SBarry Smith#
46297e8d271SBarry Smithexercises:
463467fbd6dSBarry Smith	-@echo "========================================="
46497e8d271SBarry Smith	-@echo "Generating HTML tutorial exercises"
46597e8d271SBarry Smith	-@${RM} docs/pageform.txt
466beb1b3a5SBarry Smith	-@echo "title=\"PETSc Exercises\""                >  docs/pageform.txt
46797e8d271SBarry Smith	-@echo "access_title=Exercise Sections"              >>  docs/pageform.txt
46897e8d271SBarry Smith	-@echo "access_format=short"                        >> docs/pageform.txt
46997e8d271SBarry Smith	-@echo "startpage=../exercises/introduction.htm"  >> docs/pageform.txt
47097e8d271SBarry Smith	-@echo "NONE title=\"Introduction\" command=link src=../exercises/introduction.htm" >> docs/pageform.txt
471beb1b3a5SBarry Smith	-@echo "Generating HTML for individual directories"
47297e8d271SBarry Smith	-@echo "========================================="
47397e8d271SBarry Smith	-@${OMAKE} PETSC_DIR=${PETSC_DIR} ACTION=pagemaker tree
47497e8d271SBarry Smith	-@echo "Completed HTML for individual directories"
47597e8d271SBarry Smith	-@echo "NONE title=\"<HR>\" " >> docs/pageform.txt;
47697e8d271SBarry Smith	-@echo "NONE title=\"PETSc Documentation\" command=link src=../index.html target=replace" >> docs/pageform.txt
47797e8d271SBarry Smith	/home/MPI/class/mpiexmpl/maint/makepage.new -pageform=docs/pageform.txt -access_extra=/dev/null -outdir=docs/exercises
478b4b3a923SMatthew Knepley	-@echo "========================================="
479b4b3a923SMatthew Knepley
480b4b3a923SMatthew Knepley# Make a tarball of all the Python code
481b4b3a923SMatthew Knepley#   This is currently used to release to the Teragrid
482b4b3a923SMatthew KnepleypetscPython.tgz:
483b4b3a923SMatthew Knepley	@tar cvzf $@ --exclude SCCS --exclude BitKeeper --dereference python/
4848852b4e5SMatthew Knepley	-@scp $@ tg-login2.uc.teragrid.org:./
485de21bb36SSatish Balay
4869d6c0ac5SBarry Smith.PHONY: info info_h all all_build build testexamples testfortran testexamples_uni testfortran_uni ranlib deletelibs allclean update chk_petsc_dir \
487b4b3a923SMatthew Knepley        alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanualpages \
488f7819401SBarry Smith        allhtml allcleanhtml  allci allco allrcslabel alladicignore alladic alladiclib countfortranfunctions \
489        start_configure configure_petsc configure_clean petscPython.tgz
490
491