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