xref: /petsc/makefile (revision 967582eba84cc53dc1fbf6b54d6aa49b7d83bae6)
1#
2# This is the makefile for compiling PETSc. See
3# http://www.mcs.anl.gov/petsc/documentation/installation.html for directions on installing PETSc.
4# See also conf for additional commands.
5#
6ALL: all
7LOCDIR	 = ./
8DIRS	 = src include tutorials interfaces share/petsc/matlab
9CFLAGS	 =
10FFLAGS	 =
11CPPFLAGS =
12FPPFLAGS =
13
14# next line defines PETSC_DIR and PETSC_ARCH if they are not set
15include ././${PETSC_ARCH}/lib/petsc/conf/petscvariables
16include ${PETSC_DIR}/lib/petsc/conf/variables
17include ${PETSC_DIR}/lib/petsc/conf/rules
18include ${PETSC_DIR}/lib/petsc/conf/test.common
19
20# This makefile contains a lot of PHONY targets with improperly specified prerequisites
21# where correct execution instead depends on the targets being processed in the correct
22# order.  This is gross, but this makefile doesn't really do any work.  Sub-makes still
23# benefit from parallelism.
24.NOTPARALLEL:
25
26OMAKE_SELF = $(OMAKE) -f makefile
27OMAKE_SELF_PRINTDIR = $(OMAKE_PRINTDIR) -f makefile
28
29#
30# Basic targets to build PETSc libraries.
31#
32all:
33	+@${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} chk_petscdir chk_upgrade | tee ${PETSC_ARCH}/lib/petsc/conf/make.log
34	@ln -sf ${PETSC_ARCH}/lib/petsc/conf/make.log make.log
35	+@${OMAKE_SELF_PRINTDIR} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-local 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;
36	@egrep -i "( error | error: |no such file or directory)" ${PETSC_ARCH}/lib/petsc/conf/make.log | tee ${PETSC_ARCH}/lib/petsc/conf/error.log > /dev/null
37	+@if test -s ${PETSC_ARCH}/lib/petsc/conf/error.log; then \
38           printf ${PETSC_TEXT_HILIGHT}"**************************ERROR*************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \
39           echo "  Error during compile, check ${PETSC_ARCH}/lib/petsc/conf/make.log" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \
40           echo "  Send it and ${PETSC_ARCH}/lib/petsc/conf/configure.log to petsc-maint@mcs.anl.gov" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\
41           printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\
42	 else \
43	  ${OMAKE_SELF} print_mesg_after_build PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log ;\
44        fi #solaris make likes to print the whole command that gave error. So split this up into the smallest chunk below
45	@echo "Finishing make run at `date +'%a, %d %b %Y %H:%M:%S %z'`" >> ${PETSC_ARCH}/lib/petsc/conf/make.log
46	@if test -s ${PETSC_ARCH}/lib/petsc/conf/error.log; then exit 1; fi
47
48all-local: info libs matlabbin mpi4py-build petsc4py-build libmesh-build mfem-build slepc-build hpddm-build amrex-build
49
50#
51# Prints information about the system and version of PETSc being compiled
52#
53info:
54	-@echo "=========================================="
55	-@echo " "
56	-@echo "See documentation/faq.html and documentation/bugreporting.html"
57	-@echo "for help with installation problems.  Please send EVERYTHING"
58	-@echo "printed out below when reporting problems.  Please check the"
59	-@echo "mailing list archives and consider subscribing."
60	-@echo " "
61	-@echo "  http://www.mcs.anl.gov/petsc/miscellaneous/mailing-lists.html"
62	-@echo " "
63	-@echo "=========================================="
64	-@echo Starting make run on `hostname` at `date +'%a, %d %b %Y %H:%M:%S %z'`
65	-@echo Machine characteristics: `uname -a`
66	-@echo "-----------------------------------------"
67	-@echo "Using PETSc directory: ${PETSC_DIR}"
68	-@echo "Using PETSc arch: ${PETSC_ARCH}"
69	-@echo "-----------------------------------------"
70	-@grep "define PETSC_VERSION" ${PETSC_DIR}/include/petscversion.h | ${SED} "s/........//"
71	-@echo "-----------------------------------------"
72	-@echo "Using configure Options: ${CONFIGURE_OPTIONS}"
73	-@echo "Using configuration flags:"
74	-@grep "\#define " ${PETSCCONF_H}
75	-@echo "-----------------------------------------"
76	-@echo "Using C compile: ${PETSC_CCOMPILE}"
77	-@if [  "${MPICC_SHOW}" != "" ]; then \
78             printf  "mpicc -show: %b\n" "${MPICC_SHOW}";\
79          fi; \
80        printf  "C compiler version: %b\n" "${C_VERSION}"; \
81        if [ "${PETSC_CXXCOMPILE}" != "" ]; then \
82        echo "Using C++ compile: ${PETSC_CXXCOMPILE}";\
83        if [ "${MPICXX_SHOW}" != "" ]; then \
84               printf "mpicxx -show: %b\n" "${MPICXX_SHOW}"; \
85            fi;\
86            printf  "C++ compiler version: %b\n" "${Cxx_VERSION}"; \
87          fi
88	-@if [ "${FC}" != "" ]; then \
89	   echo "Using Fortran compile: ${PETSC_FCOMPILE}";\
90           if [ "${MPIFC_SHOW}" != "" ]; then \
91             printf "mpif90 -show: %b\n" "${MPIFC_SHOW}"; \
92           fi; \
93             printf  "Fortran compiler version: %b\n" "${FC_VERSION}"; \
94         fi
95	-@if [ "${CUDAC}" != "" ]; then \
96	   echo "Using CUDA compile: ${PETSC_CUCOMPILE}";\
97         fi
98	-@if [ "${CLANGUAGE}" = "CXX" ]; then \
99           echo "Using C++ compiler to compile PETSc";\
100        fi
101	-@echo "-----------------------------------------"
102	-@echo "Using C/C++ linker: ${PCC_LINKER}"
103	-@echo "Using C/C++ flags: ${PCC_LINKER_FLAGS}"
104	-@if [ "${FC}" != "" ]; then \
105	   echo "Using Fortran linker: ${FC_LINKER}";\
106	   echo "Using Fortran flags: ${FC_LINKER_FLAGS}";\
107         fi
108	-@echo "-----------------------------------------"
109	-@echo "Using system modules: ${LOADEDMODULES}"
110	-@if [ "${MPI_IS_MPIUNI}" = "1" ]; then \
111           echo Using mpi.h: mpiuni; \
112        else \
113           TESTDIR=`mktemp -q -d -t petscmpi-XXXXXXXX` && \
114           echo '#include <mpi.h>' > $${TESTDIR}/mpitest.c && \
115           BUF=`${CPP} ${PETSC_CPPFLAGS} ${PETSC_CC_INCLUDES} $${TESTDIR}/mpitest.c |grep 'mpi\.h' | ( head -1 ; cat > /dev/null )` && \
116           echo Using mpi.h: $${BUF}; ${RM} -rf $${TESTDIR}; \
117        fi
118	-@echo "-----------------------------------------"
119	-@echo "Using libraries: ${PETSC_LIB}"
120	-@echo "------------------------------------------"
121	-@echo "Using mpiexec: ${MPIEXEC}"
122	-@echo "------------------------------------------"
123	-@echo "Using MAKEFLAGS: -j$(MAKE_NP) -l$(MAKE_LOAD) $(MAKEFLAGS)"
124	-@echo "=========================================="
125
126#
127# Build MatLab binaries
128#
129matlabbin:
130	-@if [ "${MATLAB_MEX}" != "" -a "${MATLAB_SOCKET}" != "" -a "${PETSC_SCALAR}" = "real" -a "${PETSC_PRECISION}" = "double" ]; then \
131          echo "BEGINNING TO COMPILE MATLAB INTERFACE"; \
132            if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc" ] ; then ${MKDIR}  ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc; fi; \
133            if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab" ] ; then ${MKDIR}  ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab; fi; \
134            cd src/sys/classes/viewer/impls/socket/matlab && ${OMAKE_SELF} matlabcodes PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR}; \
135            echo "========================================="; \
136        fi
137#
138# Builds PETSc check examples for a given architecture
139#
140check_install: check
141check:
142	-+@${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} check_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/check.log
143checkx:
144	-@${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} checkx_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/checkx.log
145check_build:
146	-@echo "Running check examples to verify correct installation"
147	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
148	+@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
149	+@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex19
150	+@if [ "${HYPRE_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ] &&  [ "${PETSC_SCALAR}" = "real" ]; then \
151          cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_hypre; \
152         fi;
153	+@if [ "${MUMPS_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
154          cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR}  DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_fieldsplit_mumps; \
155         fi;
156	+@if [ "${SUPERLU_DIST_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
157          cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR}  DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_superlu_dist; \
158         fi;
159	+@if [ "${HDF5_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
160          cd src/vec/vec/tests >/dev/null; \
161          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy; \
162          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ex47.PETSc DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex47; \
163          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy; \
164         fi;
165	+@if [ "${AMREX_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
166           echo "Running testamres examples to verify correct installation";\
167           echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}";\
168           cd src/ksp/ksp/tutorials/amrex >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy;\
169           ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testamrex;\
170         fi;
171	+@if ( [ "${ML_LIB}" != "" ] ||  [ "${TRILINOS_LIB}" != "" ] ) && [ "${PETSC_WITH_BATCH}" = "" ]; then \
172          cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR}  DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_ml; \
173         fi;
174	+@if [ "${SUITESPARSE_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
175          cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_suitesparse; \
176         fi;
177	+@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ex19.rm
178	+@if [ "${PETSC4PY}" = "yes" ]; then \
179          cd src/ksp/ksp/tutorials >/dev/null; \
180          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy; \
181          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex100; \
182          ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy; \
183         fi;
184	+@egrep "^#define PETSC_HAVE_FORTRAN 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \
185         if test -s .ftn.log; then \
186          cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex5f; \
187         fi; ${RM} .ftn.log;
188	+@cd src/snes/tutorials >/dev/null; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
189	-@echo "Completed test examples"
190checkx_build:
191	-@echo "Running graphics check example to verify correct X11 installation"
192	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
193	@cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
194	@cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testxex19
195	@cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
196	-@echo "Completed graphics check example"
197check_usermakefile:
198	-@echo "Testing compile with user makefile"
199	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
200	@cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex19
201	@egrep "^#define PETSC_HAVE_FORTRAN 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \
202         if test -s .ftn.log; then \
203          cd src/snes/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} -f ${PETSC_DIR}/share/petsc/Makefile.user ex5f; \
204         fi; ${RM} .ftn.log;
205	@cd src/snes/tutorials; ${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean-legacy
206	-@echo "Completed compile with user makefile"
207
208# Compare ABI/API of two versions of PETSc library with the old one defined by PETSC_{DIR,ARCH}_ABI_OLD
209abitest:
210	@if [ "${PETSC_DIR_ABI_OLD}" = "" ] || [ "${PETSC_ARCH_ABI_OLD}" = "" ]; \
211		then printf "You must set environment variables PETSC_DIR_ABI_OLD and PETSC_ARCH_ABI_OLD to run abitest\n"; \
212		exit 1; \
213	fi;
214	-@echo "Comparing ABI/API of the following two PETSc versions (you must have already configured and built them using GCC and with -g):"
215	-@echo "========================================================================================="
216	-@echo "    Old: PETSC_DIR_ABI_OLD  = ${PETSC_DIR_ABI_OLD}"
217	-@echo "         PETSC_ARCH_ABI_OLD = ${PETSC_ARCH_ABI_OLD}"
218	-@pushd ${PETSC_DIR_ABI_OLD} >> /dev/null ; echo "         Branch             = "`git rev-parse --abbrev-ref HEAD`
219	-@echo "    New: PETSC_DIR          = ${PETSC_DIR}"
220	-@echo "         PETSC_ARCH         = ${PETSC_ARCH}"
221	-@echo "         Branch             = "`git rev-parse --abbrev-ref HEAD`
222	-@echo "========================================================================================="
223	-@$(PYTHON)	${PETSC_DIR}/lib/petsc/bin/maint/abicheck.py -old_dir ${PETSC_DIR_ABI_OLD} -old_arch ${PETSC_ARCH_ABI_OLD} -new_dir ${PETSC_DIR} -new_arch ${PETSC_ARCH} -report_format html
224
225# Compare ABI/API of current PETSC_ARCH/PETSC_DIR with a previous branch
226abitestcomplete:
227	-@if [[ -f "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/configure.log" ]]; then \
228          OPTIONS=`grep -h -m 1 "Configure Options: " ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/configure.log  | sed "s!Configure Options: --configModules=PETSc.Configure --optionsModule=config.compilerOptions!!g"` ;\
229echo $${OPTIONS} ;\
230        fi ; \
231        if [[ "${PETSC_DIR_ABI_OLD}" != "" ]]; then \
232          PETSC_DIR_OLD=${PETSC_DIR_ABI_OLD}; \
233        else \
234          PETSC_DIR_OLD=${PETSC_DIR}/../petsc-abi; \
235        fi ; \
236        echo "=================================================================================================" ;\
237        echo "Doing ABI/API comparison between" ${branch} " and " `git rev-parse --abbrev-ref HEAD` "using " $${OPTIONS} ;\
238        echo "=================================================================================================" ;\
239        if [[ ! -d $${PETSC_DIR_OLD} ]]; then \
240          git clone ${PETSC_DIR} $${PETSC_DIR_OLD} ; \
241        else \
242          cd $${PETSC_DIR_OLD} ; \
243          git pull ; \
244        fi ; \
245        cd $${PETSC_DIR_OLD} ; \
246        git checkout ${branch} ; \
247        PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` ./configure $${OPTIONS} ; \
248        PETSC_DIR=`pwd` PETSC_ARCH=arch-branch-`git rev-parse ${branch}` make all test ; \
249        cd ${PETSC_DIR} ; \
250        ./configure $${OPTIONS}; \
251        make all test ; \
252        PETSC_DIR_ABI_OLD=$${PETSC_DIR_OLD} PETSC_ARCH_ABI_OLD=arch-branch-`git rev-parse ${branch}` make abitest
253
254# Deletes PETSc libraries
255deletelibs:
256	-${RM} -rf ${PETSC_LIB_DIR}/libpetsc*.*
257deletemods:
258	-${RM} -f ${PETSC_DIR}/${PETSC_ARCH}/include/petsc*.mod
259
260allclean:
261	-@${OMAKE} -f gmakefile clean
262
263clean:: allclean
264
265distclean: chk_petscdir
266	@if [ -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ]; then \
267	  echo "*** Preserving ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py in ${PETSC_DIR} ***"; \
268          mv -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ${PETSC_DIR}/; fi
269	@echo "*** Deleting all build files in ${PETSC_DIR}/${PETSC_ARCH} ***"
270	-${RM} -rf ${PETSC_DIR}/${PETSC_ARCH}/
271
272
273#
274reconfigure:
275	@unset MAKEFLAGS && ${PYTHON} ${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py
276#
277install:
278	@${PYTHON} ./config/install.py -destDir=${DESTDIR}
279	+${OMAKE_SELF} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} mpi4py-install petsc4py-install libmesh-install mfem-install slepc-install hpddm-install amrex-install
280
281mpistreams:
282	+@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistreams
283
284mpistream:
285	+@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} mpistream
286
287openmpstreams:
288	+@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstreams
289
290openmpstream:
291	+@cd src/benchmarks/streams; ${OMAKE_SELF} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} openmpstream
292
293# for legacy reasons
294stream: mpistream
295
296streams: mpistreams
297
298# ------------------------------------------------------------------
299#
300# All remaining actions are intended for PETSc developers only.
301# PETSc users should not generally need to use these commands.
302#
303#  See the users manual for how the tags files may be used from Emacs and Vi/Vim
304#
305alletags:
306	-@${PYTHON} lib/petsc/bin/maint/generateetags.py
307	-@find config -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON
308
309# obtain gtags from http://www.gnu.org/s/global/
310allgtags:
311	-@find ${PETSC_DIR}/include ${PETSC_DIR}/src -regex '\(.*makefile\|.*\.\(cc\|hh\|cpp\|C\|hpp\|c\|h\|cu\|m\)$$\)' | grep -v ftn-auto  | gtags -f -
312
313allfortranstubs:
314	-@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir
315	@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py ${BFORT}  ${VERBOSE}
316	-@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py -merge  ${VERBOSE}
317	-@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir
318deletefortranstubs:
319	-@find . -type d -name ftn-auto | xargs rm -rf
320
321# Builds all the documentation - should be done every night
322alldoc: allcite allpdf alldoc1 alldoc2 docsetdate
323
324# Build just citations
325allcite: chk_loc deletemanualpages
326	-${PYTHON} lib/petsc/bin/maint/countpetsccits.py
327	-${OMAKE_SELF} ACTION=manualpages_buildcite tree_basic LOC=${LOC}
328	-@sed -e s%man+../%man+manualpages/% ${LOC}/docs/manualpages/manualpages.cit > ${LOC}/docs/manualpages/htmlmap
329	-@cat ${PETSC_DIR}/src/docs/mpi.www.index >> ${LOC}/docs/manualpages/htmlmap
330
331# Build just PDF manuals + prerequisites
332allpdf: chk_loc allcite
333	-cd src/docs/tex/manual; ${OMAKE_SELF} manual.pdf LOC=${LOC}
334	-cd src/docs/tao_tex/manual; ${OMAKE_SELF} manual.pdf LOC=${LOC}
335
336# Build just manual pages + prerequisites
337allmanpages: chk_loc allcite
338	-${OMAKE_SELF} ACTION=manualpages tree_basic LOC=${LOC}
339
340# Build just manual examples + prerequisites
341allmanexamples: chk_loc allmanpages
342	-${OMAKE_SELF} ACTION=manexamples tree_basic LOC=${LOC}
343
344# Build everything that goes into 'doc' dir except html sources
345alldoc1: chk_loc chk_concepts_dir allcite allmanpages allmanexamples
346	-${OMAKE_SELF} manimplementations LOC=${LOC}
347	-${PYTHON} lib/petsc/bin/maint/wwwindex.py ${PETSC_DIR} ${LOC}
348	-${OMAKE_SELF} ACTION=getexlist tree_basic LOC=${LOC}
349	-${OMAKE_SELF} ACTION=exampleconcepts tree_basic LOC=${LOC}
350	-${PYTHON} lib/petsc/bin/maint/helpindex.py ${PETSC_DIR} ${LOC}
351
352# Builds .html versions of the source
353# html overwrites some stuff created by update-docs - hence this is done later.
354alldoc2: chk_loc allcite
355	-${OMAKE_SELF} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC}
356	-${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC}
357#
358# Makes links for all manual pages in $LOC/docs/manualpages/all
359allman:
360	@cd ${LOC}/docs/manualpages; rm -rf all ; mkdir all ; find *  -type d -wholename all -prune -o -name index.html -prune  -o -type f -name \*.html -exec ln -s  -f ../{} all \;
361
362DOCSETDATE_PRUNE_LIST=-o -type f -wholename share/petsc/saws/linearsolveroptions.html -prune -o -type f -wholename tutorials/HandsOnExercise.html -prune -o -type f -wholename tutorials/TAOHandsOnExercise.html -prune
363
364# modify all generated html files and add in version number, date, canonical URL info.
365docsetdate: chk_petscdir
366	@echo "Updating generated html files with petsc version, date, canonical URL info";\
367        version_release=`grep '^#define PETSC_VERSION_RELEASE ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
368        version_major=`grep '^#define PETSC_VERSION_MAJOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
369        version_minor=`grep '^#define PETSC_VERSION_MINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
370        version_subminor=`grep '^#define PETSC_VERSION_SUBMINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
371        if  [ $${version_release} = 0 ]; then \
372          petscversion=petsc-master; \
373          export petscversion; \
374        elif [ $${version_release} = 1 ]; then \
375          petscversion=petsc-$${version_major}.$${version_minor}.$${version_subminor}; \
376          export petscversion; \
377        else \
378          echo "Unknown PETSC_VERSION_RELEASE: $${version_release}"; \
379          exit; \
380        fi; \
381        datestr=`git log -1 --pretty=format:%ci | cut -d ' ' -f 1`; \
382        export datestr; \
383        gitver=`git describe --match "v*"`; \
384        export gitver; \
385        find * -type d -wholename src/docs/website \
386          -prune -o -type d -wholename src/benchmarks/results \
387          -prune -o -type d -wholename config/BuildSystem/docs/website \
388          -prune -o -type d -wholename include/web \
389          -prune -o -type d -wholename 'arch-*' \
390          -prune -o -type d -wholename lib/petsc/bin/maint \
391          -prune -o -type d -wholename externalpackages \
392          -prune ${DOCSETDATE_PRUNE_LIST} -o -type f -name \*.html \
393          -exec perl -pi -e 's^(<body.*>)^$$1\n   <div id=\"version\" align=right><b>$$ENV{petscversion} $$ENV{datestr}</b></div>\n   <div id="bugreport" align=right><a href="mailto:petsc-maint\@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: $$ENV{petscversion} $$ENV{gitver} {} "><small>Report Typos and Errors</small></a></div>^i' {} \; \
394          -exec perl -pi -e 's^(<head>)^$$1 <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/{}" />^i' {} \; ; \
395        echo "Done fixing version number, date, canonical URL info"
396
397alldocclean: deletemanualpages allcleanhtml
398
399# Deletes man pages (HTML version)
400deletemanualpages: chk_loc
401	-@if [ -d ${LOC} -a -d ${LOC}/docs/manualpages ]; then \
402          find ${LOC}/docs/manualpages -type f -name "*.html" -exec ${RM} {} \; ;\
403          ${RM} ${LOC}/docs/exampleconcepts ;\
404          ${RM} ${LOC}/docs/manualpages/manualpages.cit ;\
405          ${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC} clean;\
406        fi
407
408allcleanhtml:
409	-${OMAKE_SELF} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} alltree
410
411chk_concepts_dir: chk_loc
412	@if [ ! -d "${LOC}/docs/manualpages/concepts" ]; then \
413	  echo Making directory ${LOC}/docs/manualpages/concepts for library; ${MKDIR} ${LOC}/docs/manualpages/concepts; fi
414
415###########################################################
416# targets to build distribution and update docs
417###########################################################
418
419# Creates ${HOME}/petsc.tar.gz [and petsc-lite.tar.gz]
420dist:
421	${PETSC_DIR}/lib/petsc/bin/maint/builddist ${PETSC_DIR} master
422
423# This target works only if you can do 'ssh petsc@login.mcs.anl.gov'
424# also copy the file over to ftp site.
425web-snapshot:
426	@if [ ! -f "${HOME}/petsc-master.tar.gz" ]; then \
427	    echo "~/petsc-master.tar.gz missing! cannot update petsc-master snapshot on mcs-web-site"; \
428	  else \
429            echo "updating petsc-master snapshot on mcs-web-site"; \
430	    tmpdir=`mktemp -d -t petsc-doc.XXXXXXXX`; \
431	    cd $${tmpdir}; tar -xzf ${HOME}/petsc-master.tar.gz; \
432	    /usr/bin/rsync  -e ssh -az --delete $${tmpdir}/petsc-master/ \
433              petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/petsc-master ;\
434	    /bin/cp -f /home/petsc/petsc-master.tar.gz /mcs/ftp/pub/petsc/petsc-master.tar.gz;\
435	    ${RM} -rf $${tmpdir} ;\
436	  fi
437
438# build the tarfile - and then update petsc-master snapshot on mcs-web-site
439update-web-snapshot: dist web-snapshot
440
441# This target updates website main pages
442update-web:
443	@cd ${PETSC_DIR}/src/docs; make PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} bib2html; \
444	/usr/bin/rsync -az -C --exclude=documentation/index.html \
445          --exclude=documentation/installation.html --exclude=download/index.html \
446	  ${PETSC_DIR}/src/docs/website/ petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc
447	@cd ${PETSC_DIR}/src/docs/tex; /usr/bin/rsync -az petscapp.bib petsc.bib petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/publications
448
449###########################################################
450#
451#  See script for details
452#
453gcov:
454	-@$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py --run_gcov --petsc_arch ${PETSC_ARCH}
455
456mergegcov:
457	-@$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py --merge_gcov --loc=${LOC} --petsc_arch ${PETSC_ARCH}
458
459
460########################
461#
462# Create the include dependency graph (requires graphviz to be available)
463#
464includegraph:
465	-@${PETSC_DIR}/src/contrib/style/include-graph.sh includegraph.pdf
466	-@echo Include dependency graph written to includegraph.pdf
467
468#
469# -------------------------------------------------------------------------------
470#
471# Some macros to check if the fortran interface is up-to-date.
472#
473countfortranfunctions:
474	-@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \
475	cut -d'(' -f1 | tr -s  ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \
476	sed "s/_$$//" | sort > /tmp/countfortranfunctions
477
478countcfunctions:
479	-@grep PETSC_EXTERN ${PETSC_DIR}/include/*.h  | grep "(" | tr -s ' ' | \
480	cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' |  \
481	tr 'A-Z' 'a-z' |  sort | uniq > /tmp/countcfunctions
482
483difffortranfunctions: countfortranfunctions countcfunctions
484	-@echo -------------- Functions missing in the fortran interface ---------------------
485	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2
486	-@echo ----------------- Functions missing in the C interface ------------------------
487	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2
488	-@${RM}  /tmp/countcfunctions /tmp/countfortranfunctions
489
490checkbadfortranstubs:
491	-@echo "========================================="
492	-@echo "Functions with MPI_Comm as an Argument"
493	-@echo "========================================="
494	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \
495	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
496	-@echo "========================================="
497	-@echo "Functions with a String as an Argument"
498	-@echo "========================================="
499	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \
500	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
501	-@echo "========================================="
502	-@echo "Functions with Pointers to PETSc Objects as Argument"
503	-@echo "========================================="
504	-@cd ${PETSC_DIR}/src/fortran/auto; \
505	_p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \
506	cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \
507	sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \
508	for OBJ in $$_p_OBJ; do \
509	grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \
510	cut -d'(' -f1 | cut -d' ' -f1,3; \
511	done
512
513checkpackagetests:
514	-@echo "Missing package tests"
515	-@cat config/examples/*.py > configexamples; pushd config/BuildSystem/config/packages/; packages=`ls *.py | sed "s/\\.py//g"`;popd; for i in $${packages}; do j=`echo $${i} | tr '[:upper:]' '[:lower:]'`; printf $${j} ; egrep "(with-$${j}|download-$${j})" configexamples | grep -v "=0" | wc -l ; done
516	-@echo "Missing download package tests"
517	-@cat config/examples/*.py > configexamples; pushd config/BuildSystem/config/packages/; packages=`grep -l "download " *.py  | sed "s/\\.py//g"`;popd; for i in $${packages}; do j=`echo $${i} | tr '[:upper:]' '[:lower:]'`; printf $${j} ; egrep "(download-$${j})" configexamples | grep -v "=0" | wc -l ; done
518
519.PHONY: info info_h all deletelibs allclean update \
520        alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanualpages \
521        allhtml allcleanhtml  countfortranfunctions \
522        start_configure configure_petsc configure_clean matlabbin install
523