xref: /petsc/makefile (revision fa2665b11af1f1dc6f9e294ff52715717dc5c355)
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
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
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
26#
27# Basic targets to build PETSc libraries.
28# all: builds the c, fortran, and f90 libraries
29all:
30	+@${OMAKE}  PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} chk_petscdir chk_upgrade | tee ${PETSC_ARCH}/lib/petsc/conf/make.log
31	@ln -sf ${PETSC_ARCH}/lib/petsc/conf/make.log make.log
32	+@if [ "${MAKE_IS_GNUMAKE}" != "" ]; then \
33	   ${OMAKE_PRINTDIR} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-gnumake-local 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \
34	elif [ "${PETSC_BUILD_USING_CMAKE}" != "" ]; then \
35	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-cmake-local 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log \
36		| egrep -v '( --check-build-system |cmake -E | -o CMakeFiles/petsc[[:lower:]]*.dir/| -o lib/libpetsc|CMakeFiles/petsc[[:lower:]]*\.dir/(build|depend|requires)|-f CMakeFiles/Makefile2|Dependee .* is newer than depender |provides\.build. is up to date)'; \
37	 else \
38	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-legacy-local 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log \
39                | ${GREP} -v "has no symbols"; \
40	 fi
41	@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
42	+@if test -s ${PETSC_ARCH}/lib/petsc/conf/error.log; then \
43           printf ${PETSC_TEXT_HILIGHT}"**************************ERROR*************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \
44           echo "  Error during compile, check ${PETSC_ARCH}/lib/petsc/conf/make.log" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log; \
45           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;\
46           printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log;\
47	 else \
48	  ${OMAKE} shared_install PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} 2>&1 | tee -a ${PETSC_ARCH}/lib/petsc/conf/make.log ;\
49        fi #solaris make likes to print the whole command that gave error. So split this up into the smallest chunk below
50	@echo "Finishing at: `date`" >> ${PETSC_ARCH}/lib/petsc/conf/make.log
51	@if test -s ${PETSC_ARCH}/lib/petsc/conf/error.log; then exit 1; fi
52
53all-gnumake:
54	@if [ "${MAKE_IS_GNUMAKE}" != "" ]; then \
55          ${OMAKE_PRINTDIR}  PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} PETSC_BUILD_USING_CMAKE="" all;\
56        else printf ${PETSC_TEXT_HILIGHT}"Build not configured for GNUMAKE. Quiting"${PETSC_TEXT_NORMAL}"\n"; exit 1; fi
57
58all-cmake:
59	@if [ "${PETSC_BUILD_USING_CMAKE}" != "" ]; then \
60          ${OMAKE}  PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} MAKE_IS_GNUMAKE="" all;\
61        else printf ${PETSC_TEXT_HILIGHT}"Build not configured for CMAKE. Quiting"${PETSC_TEXT_NORMAL}"\n"; exit 1; fi
62
63all-legacy:
64	@${OMAKE}  PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} PETSC_BUILD_USING_CMAKE="" MAKE_IS_GNUMAKE="" all
65
66all-gnumake-local: info gnumake matlabbin mpi4py-build petsc4py-build libmesh-build slepc-build
67
68all-cmake-local: info cmakegen cmake matlabbin mpi4py-build petsc4py-build
69
70all-legacy-local: chklib_dir info deletelibs deletemods build matlabbin shared_nomesg mpi4py-build petsc4py-build
71
72#
73# Prints information about the system and version of PETSc being compiled
74#
75info:
76	-@echo "=========================================="
77	-@echo " "
78	-@echo "See documentation/faq.html and documentation/bugreporting.html"
79	-@echo "for help with installation problems.  Please send EVERYTHING"
80	-@echo "printed out below when reporting problems.  Please check the"
81	-@echo "mailing list archives and consider subscribing."
82	-@echo " "
83	-@echo "  http://www.mcs.anl.gov/petsc/miscellaneous/mailing-lists.html"
84	-@echo " "
85	-@echo "=========================================="
86	-@echo Starting on `hostname` at `date`
87	-@echo Machine characteristics: `uname -a`
88	-@echo "-----------------------------------------"
89	-@echo "Using PETSc directory: ${PETSC_DIR}"
90	-@echo "Using PETSc arch: ${PETSC_ARCH}"
91	-@echo "-----------------------------------------"
92	-@grep "define PETSC_VERSION" ${PETSC_DIR}/include/petscversion.h | ${SED} "s/........//"
93	-@echo "-----------------------------------------"
94	-@echo "Using configure Options: ${CONFIGURE_OPTIONS}"
95	-@echo "Using configuration flags:"
96	-@grep "\#define " ${PETSCCONF_H}
97	-@echo "-----------------------------------------"
98	-@echo "Using C/C++ compile: ${PETSC_COMPILE}"
99	-@if [ "${PETSC_LANGUAGE}" = "CONLY" -a "${MPICC_SHOW}" != "" ]; then \
100             printf  "mpicc -show: %b\n" "${MPICC_SHOW}"; \
101	  elif [ "${PETSC_LANGUAGE}" = "CXXONLY" -a "${MPICXX_SHOW}" != "" ]; then \
102             printf "mpicxx -show: %b\n" "${MPICXX_SHOW}"; \
103          fi;
104	-@if [ "${FC}" != "" ]; then \
105	   echo "Using Fortran compile: ${PETSC_FCOMPILE}";\
106           if [ "${MPIFC_SHOW}" != "" ]; then \
107             printf "mpif90 -show: %b\n" "${MPIFC_SHOW}"; \
108           fi; \
109         fi
110	-@if [ "${CUDAC}" != "" ]; then \
111	   echo "Using CUDA compile: ${PETSC_CUCOMPILE}";\
112         fi
113	-@echo "-----------------------------------------"
114	-@echo "Using C/C++ linker: ${PCC_LINKER}"
115	-@echo "Using C/C++ flags: ${PCC_LINKER_FLAGS}"
116	-@if [ "${FC}" != "" ]; then \
117	   echo "Using Fortran linker: ${FC_LINKER}";\
118	   echo "Using Fortran flags: ${FC_LINKER_FLAGS}";\
119         fi
120	-@echo "-----------------------------------------"
121	-@echo "Using system modules: ${LOADEDMODULES}"
122	-@echo Using mpi.h: `echo '#include <mpi.h>' > ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/mpitest.c; ${CPP} ${PETSC_CCPPFLAGS} ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/mpitest.c |grep 'mpi\.h' |  ( head -1 ; cat > /dev/null )`
123	-@echo "-----------------------------------------"
124	-@echo "Using libraries: ${PETSC_LIB}"
125	-@echo "------------------------------------------"
126	-@echo "Using mpiexec: ${MPIEXEC}"
127	-@echo "=========================================="
128
129#
130# Builds the PETSc libraries
131# This target also builds fortran77 and f90 interface
132# files and compiles .F files
133#
134build:
135	-@echo "BEGINNING TO COMPILE LIBRARIES IN ALL DIRECTORIES"
136	-@echo "========================================="
137	-@${OMAKE}  PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=libfast tree
138	-@${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}  > tmpf 2>&1 ; ${GREP} -v "has no symbols" tmpf; ${RM} tmpf;
139	-@echo "Completed building libraries"
140	-@echo "========================================="
141#
142# Build MatLab binaries
143#
144matlabbin:
145	-@if [ "${MATLAB_MEX}" != "" -a "${PETSC_SCALAR}" = "real" -a "${PETSC_PRECISION}" = "double" ]; then \
146          echo "BEGINNING TO COMPILE MATLAB INTERFACE"; \
147            if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc" ] ; then ${MKDIR}  ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc; fi; \
148            if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab" ] ; then ${MKDIR}  ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab; fi; \
149            cd src/sys/classes/viewer/impls/socket/matlab && ${OMAKE} matlabcodes PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR}; \
150            echo "========================================="; \
151        fi
152#
153# Builds PETSc test examples for a given architecture
154#
155test_install: test
156check: test
157test:
158	-@${OMAKE} PATH="${PETSC_DIR}/${PETSC_ARCH}/lib:${PATH}" PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} test_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/test.log
159	-@if [ "${PETSC_WITH_BATCH}" = "" ]; then \
160          printf "=========================================\n"; \
161          printf "Now to evaluate the computer systems you plan use - do:\n"; \
162          printf "make PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} streams\n"; \
163        fi
164testx:
165	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testx_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/testx.log
166test_build:
167	-@echo "Running test examples to verify correct installation"
168	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
169	@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
170	@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex19
171	@if [ "${HYPRE_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
172          cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_hypre; \
173         fi;
174	@if [ "${MUMPS_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
175          cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR}  DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_fieldsplit_mumps; \
176         fi;
177	@if [ "${SUPERLU_DIST_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
178          cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR}  DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_superlu_dist; \
179         fi;
180	@if ( [ "${ML_LIB}" != "" ] ||  [ "${TRILINOS_LIB}" != "" ] ) && [ "${PETSC_WITH_BATCH}" = "" ]; then \
181          cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR}  DIFF=${PETSC_DIR}/lib/petsc/bin/petscdiff runex19_ml; \
182         fi;
183	@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ex19.rm
184	@if [ "${PETSC4PY}" = "yes" ]; then \
185          cd src/ksp/ksp/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex100; \
186         fi;
187	@egrep "^#define PETSC_HAVE_FORTRAN 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \
188         if test -s .ftn.log; then \
189          cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex5f; \
190         fi; ${RM} .ftn.log;
191	@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
192	-@echo "Completed test examples"
193testx_build:
194	-@echo "Running graphics test example to verify correct X11 installation"
195	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
196	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
197	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testxex19
198	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
199	-@echo "Completed graphics test example"
200
201testexamples: info
202	-@echo "BEGINNING TO COMPILE AND RUN TEST EXAMPLES"
203	-@echo "Due to different numerical round-off on certain"
204	-@echo "machines some of the numbers may not match exactly."
205	-@echo "========================================="
206	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ACTION=testexamples_C  tree
207	-@echo "Completed compiling and running test examples"
208	-@echo "========================================="
209testfortran: info
210	-@echo "BEGINNING TO COMPILE AND RUN FORTRAN TEST EXAMPLES"
211	-@echo "========================================="
212	-@echo "Due to different numerical round-off on certain"
213	-@echo "machines or the way Fortran formats numbers"
214	-@echo "some of the results may not match exactly."
215	-@echo "========================================="
216	-@if [ "${FC}" != "" ]; then \
217            ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_Fortran tree; \
218            echo "Completed compiling and running Fortran test examples"; \
219          else \
220            echo "Error: No FORTRAN compiler available"; \
221          fi
222	-@echo "========================================="
223testexamples_uni: info
224	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR EXAMPLES"
225	-@echo "Due to different numerical round-off on certain"
226	-@echo "machines some of the numbers may not match exactly."
227	-@echo "========================================="
228	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_C_X_MPIUni  tree
229	-@echo "Completed compiling and running uniprocessor test examples"
230	-@echo "========================================="
231testfortran_uni: info
232	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR FORTRAN EXAMPLES"
233	-@echo "Due to different numerical round-off on certain"
234	-@echo "machines some of the numbers may not match exactly."
235	-@echo "========================================="
236	-@if [ "${FC}" != "" ]; then \
237            ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_Fortran_MPIUni  tree; \
238            echo "Completed compiling and running uniprocessor fortran test examples"; \
239          else \
240            echo "Error: No FORTRAN compiler available"; \
241          fi
242	-@
243	-@echo "========================================="
244
245# Ranlib on the libraries
246ranlib:
247	${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}
248
249# Deletes PETSc libraries
250deletelibs:
251	-${RM} -rf ${PETSC_LIB_DIR}/libpetsc*.*
252deletemods:
253	-${RM} -f ${PETSC_DIR}/${PETSC_ARCH}/include/petsc*.mod
254
255# Cleans up build
256allclean-legacy: deletelibs deletemods
257	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=clean-legacy tree
258allclean-cmake:
259	-@cd ${PETSC_ARCH} && ${OMAKE} clean
260allclean-gnumake:
261	-@${OMAKE} -f gmakefile clean
262
263allclean:
264	@if [ "${MAKE_IS_GNUMAKE}" != "" ]; then \
265	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} allclean-gnumake; \
266	elif [ "${PETSC_BUILD_USING_CMAKE}" != "" ]; then \
267	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} allclean-cmake; \
268	else \
269	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} allclean-legacy; \
270	fi
271
272clean:: allclean
273
274distclean: chk_petscdir
275	@if [ -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ]; then \
276	  echo "*** Preserving ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py in ${PETSC_DIR} ***"; \
277          mv -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ${PETSC_DIR}/; fi
278	@echo "*** Deleting all build files in ${PETSC_DIR}/${PETSC_ARCH} ***"
279	-${RM} -rf ${PETSC_DIR}/${PETSC_ARCH}/
280
281
282#
283reconfigure:
284	@${PYTHON} ${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py
285#
286install:
287	@${PYTHON} ./config/install.py -destDir=${DESTDIR}
288	${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} mpi4py-install petsc4py-install libmesh-install slepc-install
289
290newall:
291	-@cd src/sys;  @${PYTHON} ${PETSC_DIR}/config/builder.py
292	-@cd src/vec;  @${PYTHON} ${PETSC_DIR}/config/builder.py
293	-@cd src/mat;  @${PYTHON} ${PETSC_DIR}/config/builder.py
294	-@cd src/dm;   @${PYTHON} ${PETSC_DIR}/config/builder.py
295	-@cd src/ksp;  @${PYTHON} ${PETSC_DIR}/config/builder.py
296	-@cd src/snes; @${PYTHON} ${PETSC_DIR}/config/builder.py
297	-@cd src/ts;   @${PYTHON} ${PETSC_DIR}/config/builder.py
298
299streams:
300	cd src/benchmarks/streams; ${OMAKE} PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} streams
301
302stream:
303	cd src/benchmarks/streams; ${OMAKE} PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} stream
304# ------------------------------------------------------------------
305#
306# All remaining actions are intended for PETSc developers only.
307# PETSc users should not generally need to use these commands.
308#
309#  See the users manual for how the tags files may be used from Emacs and Vi/Vim
310#
311alletags:
312	-@${PYTHON} lib/petsc/bin/maint/generateetags.py
313	-@find config -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON
314
315# obtain gtags from http://www.gnu.org/s/global/
316allgtags:
317	-@find ${PETSC_DIR}/include ${PETSC_DIR}/src ${PETSC_DIR}/bin -regex '\(.*makefile\|.*\.\(cc\|hh\|cpp\|C\|hpp\|c\|h\|cu\|m\)$$\)' | grep -v ftn-auto  | gtags -f -
318
319allfortranstubs:
320	-@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir
321	@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py ${BFORT}  ${VERBOSE}
322	-@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py -merge  ${VERBOSE}
323	-@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir
324deletefortranstubs:
325	-@find . -type d -name ftn-auto | xargs rm -rf
326cmakegen:
327	-@${PYTHON} config/cmakegen.py
328#
329# These are here for the target allci and allco, and etags
330#
331
332BMAKEFILES = conf/variables conf/rules conf/test
333SCRIPTS    = lib/petsc/bin/maint/builddist  lib/petsc/bin/maint/wwwman lib/petsc/bin/maint/xclude lib/petsc/bin/maint/bugReport.py lib/petsc/bin/maint/buildconfigtest lib/petsc/bin/maint/builddistlite \
334             lib/petsc/bin/maint/buildtest lib/petsc/bin/maint/checkBuilds.py lib/petsc/bin/maint/copylognightly lib/petsc/bin/maint/copylognightly.tao lib/petsc/bin/maint/countfiles lib/petsc/bin/maint/findbadfiles \
335             lib/petsc/bin/maint/fixinclude lib/petsc/bin/maint/getexlist lib/petsc/bin/maint/getpdflabels.py lib/petsc/bin/maint/helpindex.py lib/petsc/bin/maint/hosts.local lib/petsc/bin/maint/hosts.solaris  \
336             lib/petsc/bin/maint/lex.py  lib/petsc/bin/maint/mapnameslatex.py lib/petsc/bin/maint/startnightly lib/petsc/bin/maint/startnightly.tao lib/petsc/bin/maint/submitPatch.py \
337             lib/petsc/bin/maint/update-docs.py  lib/petsc/bin/maint/wwwindex.py lib/petsc/bin/maint/xcludebackup lib/petsc/bin/maint/xcludecblas lib/petsc/bin/maint/zap lib/petsc/bin/maint/zapall \
338             config/PETSc/Configure.py config/PETSc/Options.py \
339             config/PETSc/utilities/*.py
340
341
342# Builds all the documentation - should be done every night
343alldoc: allcite allpdf alldoc1 alldoc2 alldoc3 docsetdate
344
345# Build just citations
346allcite: chk_loc deletemanualpages
347	-${PYTHON} lib/petsc/bin/maint/countpetsccits.py
348	-${OMAKE} ACTION=manualpages_buildcite tree_basic LOC=${LOC}
349	-@sed -e s%man+../%man+manualpages/% ${LOC}/docs/manualpages/manualpages.cit > ${LOC}/docs/manualpages/htmlmap
350	-@cat ${PETSC_DIR}/src/docs/mpi.www.index >> ${LOC}/docs/manualpages/htmlmap
351
352# Build just PDF manuals + prerequisites
353allpdf: chk_loc allcite
354	-cd src/docs/tex/manual; ${OMAKE} manual.pdf LOC=${LOC}
355	-cd src/docs/tex/manual; ${OMAKE} developers.pdf LOC=${LOC}
356	-cd src/docs/tao_tex/manual; ${OMAKE} manual.pdf LOC=${LOC}
357
358# Build just manual pages + prerequisites
359allmanpages: chk_loc allcite
360	-${OMAKE} ACTION=manualpages tree_basic LOC=${LOC}
361
362# Build just manual examples + prerequisites
363allmanexamples: chk_loc allmanpages
364	-${OMAKE} ACTION=manexamples tree_basic LOC=${LOC}
365
366# Build everything that goes into 'doc' dir except html sources
367alldoc1: chk_loc chk_concepts_dir allcite allmanpages allmanexamples
368	-${OMAKE} manimplementations LOC=${LOC}
369	-${PYTHON} lib/petsc/bin/maint/wwwindex.py ${PETSC_DIR} ${LOC}
370	-${OMAKE} manconcepts LOC=${LOC}
371	-${OMAKE} ACTION=getexlist tree_basic LOC=${LOC}
372	-${OMAKE} ACTION=exampleconcepts tree_basic LOC=${LOC}
373	-${PYTHON} lib/petsc/bin/maint/helpindex.py ${PETSC_DIR} ${LOC}
374
375# Builds .html versions of the source
376# html overwrites some stuff created by update-docs - hence this is done later.
377alldoc2: chk_loc
378	-${OMAKE} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC}
379	-${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC}
380#
381# Builds HTML versions of Matlab scripts
382alldoc3: chk_loc
383	if  [ "${MATLAB_COMMAND}" != "" ]; then\
384          export MATLABPATH=${MATLABPATH}:${PETSC_DIR}/share/petsc/matlab; \
385          cd ${PETSC_DIR}/share/petsc/matlab; ${MATLAB_COMMAND} -nodisplay -nodesktop -r "generatehtml;exit" ; \
386        fi
387
388#
389# Makes links for all manual pages in $LOC/docs/manualpages/all
390allman:
391	@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 \;
392
393DOCSETDATE_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
394
395# modify all generated html files and add in version number, date, canonical URL info.
396docsetdate: chk_petscdir
397	@echo "Updating generated html files with petsc version, date, canonical URL info";\
398        version_release=`grep '^#define PETSC_VERSION_RELEASE ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
399        version_major=`grep '^#define PETSC_VERSION_MAJOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
400        version_minor=`grep '^#define PETSC_VERSION_MINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
401        version_subminor=`grep '^#define PETSC_VERSION_SUBMINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
402        if  [ $${version_release} = 0 ]; then \
403          petscversion=petsc-master; \
404          export petscversion; \
405        elif [ $${version_release} = 1 ]; then \
406          petscversion=petsc-$${version_major}.$${version_minor}.$${version_subminor}; \
407          export petscversion; \
408        else \
409          echo "Unknown PETSC_VERSION_RELEASE: $${version_release}"; \
410          exit; \
411        fi; \
412        datestr=`git log -1 --pretty=format:%ci | cut -d ' ' -f 1`; \
413        export datestr; \
414        gitver=`git describe --match "v*"`; \
415        export gitver; \
416        find * -type d -wholename src/docs/website -prune -o -type d -wholename src/benchmarks/results -prune -o \
417          -type d -wholename config/BuildSystem/docs/website -prune -o -type d -wholename include/web -prune -o \
418          -type d -wholename 'arch-*' -prune -o -type d -wholename src/tops -prune -o -type d -wholename externalpackages -prune ${DOCSETDATE_PRUNE_LIST} -o \
419          -type f -name \*.html \
420          -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' {} \; \
421          -exec perl -pi -e 's^(<head>)^$$1 <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/{}" />^i' {} \; ; \
422        echo "Done fixing version number, date, canonical URL info"
423
424alldocclean: deletemanualpages allcleanhtml
425
426# Deletes man pages (HTML version)
427deletemanualpages: chk_loc
428	-@if [ -d ${LOC} -a -d ${LOC}/docs/manualpages ]; then \
429          find ${LOC}/docs/manualpages -type f -name "*.html" -exec ${RM} {} \; ;\
430          ${RM} ${LOC}/docs/exampleconcepts ;\
431          ${RM} ${LOC}/docs/manconcepts ;\
432          ${RM} ${LOC}/docs/manualpages/manualpages.cit ;\
433          ${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC} clean;\
434        fi
435
436allcleanhtml:
437	-${OMAKE} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} alltree
438
439chk_concepts_dir: chk_loc
440	@if [ ! -d "${LOC}/docs/manualpages/concepts" ]; then \
441	  echo Making directory ${LOC}/docs/manualpages/concepts for library; ${MKDIR} ${LOC}/docs/manualpages/concepts; fi
442
443###########################################################
444# targets to build distribution and update docs
445###########################################################
446
447# Creates ${HOME}/petsc.tar.gz [and petsc-lite.tar.gz]
448dist:
449	${PETSC_DIR}/lib/petsc/bin/maint/builddist ${PETSC_DIR} master
450
451# This target works only if you can do 'ssh petsc@login.mcs.anl.gov'
452# also copy the file over to ftp site.
453web-snapshot:
454	@if [ ! -f "${HOME}/petsc-master.tar.gz" ]; then \
455	    echo "~/petsc-master.tar.gz missing! cannot update petsc-master snapshot on mcs-web-site"; \
456	  else \
457            echo "updating petsc-master snapshot on mcs-web-site"; \
458	    tmpdir=`mktemp -d -t petsc-doc.XXXXXXXX`; \
459	    cd $${tmpdir}; tar -xzf ${HOME}/petsc-master.tar.gz; \
460	    /usr/bin/rsync  -e ssh -az --delete $${tmpdir}/petsc-master/ \
461              petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/petsc-master ;\
462	    /bin/cp -f /home/petsc/petsc-master.tar.gz /mcs/ftp/pub/petsc/petsc-master.tar.gz;\
463	    ${RM} -rf $${tmpdir} ;\
464	  fi
465
466# build the tarfile - and then update petsc-master snapshot on mcs-web-site
467update-web-snapshot: dist web-snapshot
468
469# This target updates website main pages
470update-web:
471	@cd ${PETSC_DIR}/src/docs; make PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} bib2html; \
472	/usr/bin/rsync -az -C --exclude=documentation/index.html \
473          --exclude=documentation/installation.html --exclude=download/index.html \
474	  ${PETSC_DIR}/src/docs/website/ petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc
475	@cd ${PETSC_DIR}/docs; /usr/bin/rsync -az developers.pdf petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/developers/
476	@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
477
478#
479#  builds a single list of files for each PETSc library so they may all be built in parallel
480#  without a recursive set of make calls
481createfastbuild:
482	cd src/vec; ${RM} -f files; /bin/echo -n "SOURCEC = " > files; make tree ACTION=sourcelist BASE_DIR=${PETSC_DIR}/src/vec
483
484###########################################################
485#
486#  See script for details
487#
488gcov:
489	-@$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py -run_gcov
490
491mergegcov:
492	-@$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py -merge_gcov ${LOC} *.tar.gz
493
494########################
495#
496# Create the include dependency graph (requires graphviz to be available)
497#
498includegraph:
499	-@${PETSC_DIR}/src/contrib/style/include-graph.sh includegraph.pdf
500	-@echo Include dependency graph written to includegraph.pdf
501
502#
503# -------------------------------------------------------------------------------
504#
505# Some macros to check if the fortran interface is up-to-date.
506#
507countfortranfunctions:
508	-@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \
509	cut -d'(' -f1 | tr -s  ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \
510	sed "s/_$$//" | sort > /tmp/countfortranfunctions
511
512countcfunctions:
513	-@grep PETSC_EXTERN ${PETSC_DIR}/include/*.h  | grep "(" | tr -s ' ' | \
514	cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' |  \
515	tr 'A-Z' 'a-z' |  sort | uniq > /tmp/countcfunctions
516
517difffortranfunctions: countfortranfunctions countcfunctions
518	-@echo -------------- Functions missing in the fortran interface ---------------------
519	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2
520	-@echo ----------------- Functions missing in the C interface ------------------------
521	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2
522	-@${RM}  /tmp/countcfunctions /tmp/countfortranfunctions
523
524checkbadfortranstubs:
525	-@echo "========================================="
526	-@echo "Functions with MPI_Comm as an Argument"
527	-@echo "========================================="
528	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \
529	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
530	-@echo "========================================="
531	-@echo "Functions with a String as an Argument"
532	-@echo "========================================="
533	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \
534	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
535	-@echo "========================================="
536	-@echo "Functions with Pointers to PETSc Objects as Argument"
537	-@echo "========================================="
538	-@cd ${PETSC_DIR}/src/fortran/auto; \
539	_p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \
540	cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \
541	sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \
542	for OBJ in $$_p_OBJ; do \
543	grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \
544	cut -d'(' -f1 | cut -d' ' -f1,3; \
545	done
546
547checkpackagetests:
548	-@echo "Missing package tests"
549	-@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
550	-@echo "Missing download package tests"
551	-@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
552
553#
554# Automatically generates PETSc exercises in html from the tutorial examples.
555#
556# The introduction for each section is obtained from docs/manualpages-cite/header_${MANSEC} may be edited
557#  (used also in introductions to the manual pages)
558#
559# DO NOT EDIT the *.htm files generated since they will be automatically replaced.
560#
561# Eventually the line below will replace the two cd in the rule below, it is just this way now for speed
562#	-@${OMAKE} PETSC_DIR=${PETSC_DIR} pagemaker
563#
564exercises:
565	-@echo "========================================="
566	-@echo "Generating HTML tutorial exercises"
567	-@${RM} docs/pageform.txt
568	-@echo "title=\"PETSc Exercises\""                >  docs/pageform.txt
569	-@echo "access_title=Exercise Sections"              >>  docs/pageform.txt
570	-@echo "access_format=short"                        >> docs/pageform.txt
571	-@echo "startpage=../exercises/introduction.htm"  >> docs/pageform.txt
572	-@echo "NONE title=\"Introduction\" command=link src=../exercises/introduction.htm" >> docs/pageform.txt
573	-@echo "Generating HTML for individual directories"
574	-@echo "========================================="
575	-@${OMAKE} PETSC_DIR=${PETSC_DIR} ACTION=pagemaker tree
576	-@echo "Completed HTML for individual directories"
577	-@echo "NONE title=\"<HR>\" " >> docs/pageform.txt;
578	-@echo "NONE title=\"PETSc Documentation\" command=link src=../index.html target=replace" >> docs/pageform.txt
579	/home/MPI/class/mpiexmpl/maint/makepage.new -pageform=docs/pageform.txt -access_extra=/dev/null -outdir=docs/exercises
580	-@echo "========================================="
581
582.PHONY: info info_h all build testexamples testfortran testexamples_uni testfortran_uni ranlib deletelibs allclean update \
583        alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanualpages \
584        allhtml allcleanhtml  allci allco allrcslabel countfortranfunctions \
585        start_configure configure_petsc configure_clean matlabbin install
586
587petscao : petscmat petscao.f90.h
588petscdm : petscksp petscdm.f90.h
589petscdraw : petsc petscdraw.f90.h
590petscis : petsc petscis.f90.h
591petscksp : petscpc  petscksp.f90.h
592petsclog : petsc petsclog.f90.h
593petscmat : petscvec petscmat.f90.h
594petscmg : petscksp petscmg.f90.h
595petscpc : petscmat petscpc.f90.h
596petscsnes : petscksp petscsnes.f90.h
597petscsys : petsc petscsys.f90.h
598petscts : petscsnes petscts.f90.h
599petsc : petsc.f90.h
600petscvec : petscis petscvec.f90.h
601petscviewer : petsc petscviewer.f90.h
602petscmesh : petsc petscmesh.f90.h
603modules : petscao petscdm petscdraw petscis petscksp petsclog petscmat petscmg petscpc petscsnes petscsys petscts petsc petscvec petscviewer petscmesh
604