xref: /petsc/makefile (revision feff33ee0b5b037fa8f9f294dede656a2f85cc47)
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 make run at `date +'%a, %d %b %Y %H:%M:%S %z'`" >> ${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 make run on `hostname` at `date +'%a, %d %b %Y %H:%M:%S %z'`
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	-@TESTDIR=`mktemp -q -d -t petscmpi-XXXXXXXX` && \
123           echo '#include <mpi.h>' > $${TESTDIR}/mpitest.c && \
124           BUF=`${CPP} ${PETSC_CCPPFLAGS} $${TESTDIR}/mpitest.c |grep 'mpi\.h' | ( head -1 ; cat > /dev/null )` && \
125           echo Using mpi.h: $${BUF}; ${RM} -rf $${TESTDIR}
126	-@echo "-----------------------------------------"
127	-@echo "Using libraries: ${PETSC_LIB}"
128	-@echo "------------------------------------------"
129	-@echo "Using mpiexec: ${MPIEXEC}"
130	-@echo "------------------------------------------"
131	-@echo "Using MAKEFLAGS: -j$(MAKE_NP) -l$(NPMAX) $(MAKEFLAGS)"
132	-@echo "=========================================="
133
134#
135# Builds the PETSc libraries
136# This target also builds fortran77 and f90 interface
137# files and compiles .F files
138#
139build:
140	-@echo "BEGINNING TO COMPILE LIBRARIES IN ALL DIRECTORIES"
141	-@echo "========================================="
142	-@${OMAKE}  PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=libfast tree
143	-@${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}  > tmpf 2>&1 ; ${GREP} -v "has no symbols" tmpf; ${RM} tmpf;
144	-@echo "Completed building libraries"
145	-@echo "========================================="
146#
147# Build MatLab binaries
148#
149matlabbin:
150	-@if [ "${MATLAB_MEX}" != "" -a "${PETSC_SCALAR}" = "real" -a "${PETSC_PRECISION}" = "double" ]; then \
151          echo "BEGINNING TO COMPILE MATLAB INTERFACE"; \
152            if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc" ] ; then ${MKDIR}  ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc; fi; \
153            if [ ! -d "${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab" ] ; then ${MKDIR}  ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/matlab; fi; \
154            cd src/sys/classes/viewer/impls/socket/matlab && ${OMAKE} matlabcodes PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR}; \
155            echo "========================================="; \
156        fi
157#
158# Builds PETSc test examples for a given architecture
159#
160test_install: test
161check: test
162test:
163	-+@${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
164	-@if [ "${PETSC_WITH_BATCH}" = "" ]; then \
165          printf "=========================================\n"; \
166          printf "Now to evaluate the computer systems you plan use - do:\n"; \
167          printf "make PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} streams\n"; \
168        fi
169testx:
170	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testx_build 2>&1 | tee ./${PETSC_ARCH}/lib/petsc/conf/testx.log
171test_build:
172	-@echo "Running test examples to verify correct installation"
173	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
174	+@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
175	+@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex19
176	+@if [ "${HYPRE_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
177          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; \
178         fi;
179	+@if [ "${MUMPS_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
180          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; \
181         fi;
182	+@if [ "${SUPERLU_DIST_LIB}" != "" ] && [ "${PETSC_WITH_BATCH}" = "" ]; then \
183          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; \
184         fi;
185	+@if ( [ "${ML_LIB}" != "" ] ||  [ "${TRILINOS_LIB}" != "" ] ) && [ "${PETSC_WITH_BATCH}" = "" ]; then \
186          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; \
187         fi;
188	+@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ex19.rm
189	+@if [ "${PETSC4PY}" = "yes" ]; then \
190          cd src/ksp/ksp/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex100; \
191         fi;
192	+@egrep "^#define PETSC_HAVE_FORTRAN 1" ${PETSCCONF_H} | tee .ftn.log > /dev/null; \
193         if test -s .ftn.log; then \
194          cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex5f; \
195         fi; ${RM} .ftn.log;
196	+@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
197	-@echo "Completed test examples"
198testx_build:
199	-@echo "Running graphics test example to verify correct X11 installation"
200	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
201	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
202	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testxex19
203	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
204	-@echo "Completed graphics test example"
205
206# Ranlib on the libraries
207ranlib:
208	${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}
209
210# Deletes PETSc libraries
211deletelibs:
212	-${RM} -rf ${PETSC_LIB_DIR}/libpetsc*.*
213deletemods:
214	-${RM} -f ${PETSC_DIR}/${PETSC_ARCH}/include/petsc*.mod
215
216# Cleans up build
217allclean-legacy: deletelibs deletemods
218	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=clean-legacy tree
219allclean-cmake:
220	-@cd ${PETSC_ARCH} && ${OMAKE} clean
221allclean-gnumake:
222	-@${OMAKE} -f gmakefile clean
223
224allclean:
225	@if [ "${MAKE_IS_GNUMAKE}" != "" ]; then \
226	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} allclean-gnumake; \
227	elif [ "${PETSC_BUILD_USING_CMAKE}" != "" ]; then \
228	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} allclean-cmake; \
229	else \
230	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} allclean-legacy; \
231	fi
232
233clean:: allclean
234
235distclean: chk_petscdir
236	@if [ -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ]; then \
237	  echo "*** Preserving ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py in ${PETSC_DIR} ***"; \
238          mv -f ${PETSC_DIR}/${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py ${PETSC_DIR}/; fi
239	@echo "*** Deleting all build files in ${PETSC_DIR}/${PETSC_ARCH} ***"
240	-${RM} -rf ${PETSC_DIR}/${PETSC_ARCH}/
241
242
243#
244reconfigure:
245	@${PYTHON} ${PETSC_ARCH}/lib/petsc/conf/reconfigure-${PETSC_ARCH}.py
246#
247install:
248	@${PYTHON} ./config/install.py -destDir=${DESTDIR}
249	+${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} mpi4py-install petsc4py-install libmesh-install slepc-install
250
251newall:
252	-@cd src/sys;  @${PYTHON} ${PETSC_DIR}/config/builder.py
253	-@cd src/vec;  @${PYTHON} ${PETSC_DIR}/config/builder.py
254	-@cd src/mat;  @${PYTHON} ${PETSC_DIR}/config/builder.py
255	-@cd src/dm;   @${PYTHON} ${PETSC_DIR}/config/builder.py
256	-@cd src/ksp;  @${PYTHON} ${PETSC_DIR}/config/builder.py
257	-@cd src/snes; @${PYTHON} ${PETSC_DIR}/config/builder.py
258	-@cd src/ts;   @${PYTHON} ${PETSC_DIR}/config/builder.py
259
260streams:
261	+cd src/benchmarks/streams; ${OMAKE} PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} streams
262
263stream:
264	+cd src/benchmarks/streams; ${OMAKE} PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} stream
265# ------------------------------------------------------------------
266#
267# All remaining actions are intended for PETSc developers only.
268# PETSc users should not generally need to use these commands.
269#
270#  See the users manual for how the tags files may be used from Emacs and Vi/Vim
271#
272alletags:
273	-@${PYTHON} lib/petsc/bin/maint/generateetags.py
274	-@find config -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON
275
276# obtain gtags from http://www.gnu.org/s/global/
277allgtags:
278	-@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 -
279
280allfortranstubs:
281	-@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir
282	@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py ${BFORT}  ${VERBOSE}
283	-@${PYTHON} lib/petsc/bin/maint/generatefortranstubs.py -merge  ${VERBOSE}
284	-@${RM} -rf ${PETSC_ARCH}/include/petsc/finclude/ftn-auto/*-tmpdir
285deletefortranstubs:
286	-@find . -type d -name ftn-auto | xargs rm -rf
287cmakegen:
288	-@${PYTHON} config/cmakegen.py
289#
290# These are here for the target allci and allco, and etags
291#
292
293BMAKEFILES = conf/variables conf/rules conf/test
294SCRIPTS    = 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 \
295             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 \
296             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  \
297             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 \
298             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 \
299             config/PETSc/Configure.py config/PETSc/Options.py \
300             config/PETSc/utilities/*.py
301
302
303# Builds all the documentation - should be done every night
304alldoc: allcite allpdf alldoc1 alldoc2 alldoc3 docsetdate
305
306# Build just citations
307allcite: chk_loc deletemanualpages
308	-${PYTHON} lib/petsc/bin/maint/countpetsccits.py
309	-${OMAKE} ACTION=manualpages_buildcite tree_basic LOC=${LOC}
310	-@sed -e s%man+../%man+manualpages/% ${LOC}/docs/manualpages/manualpages.cit > ${LOC}/docs/manualpages/htmlmap
311	-@cat ${PETSC_DIR}/src/docs/mpi.www.index >> ${LOC}/docs/manualpages/htmlmap
312
313# Build just PDF manuals + prerequisites
314allpdf: chk_loc allcite
315	-cd src/docs/tex/manual; ${OMAKE} manual.pdf LOC=${LOC}
316	-cd src/docs/tex/manual; ${OMAKE} developers.pdf LOC=${LOC}
317	-cd src/docs/tao_tex/manual; ${OMAKE} manual.pdf LOC=${LOC}
318
319# Build just manual pages + prerequisites
320allmanpages: chk_loc allcite
321	-${OMAKE} ACTION=manualpages tree_basic LOC=${LOC}
322
323# Build just manual examples + prerequisites
324allmanexamples: chk_loc allmanpages
325	-${OMAKE} ACTION=manexamples tree_basic LOC=${LOC}
326
327# Build everything that goes into 'doc' dir except html sources
328alldoc1: chk_loc chk_concepts_dir allcite allmanpages allmanexamples
329	-${OMAKE} manimplementations LOC=${LOC}
330	-${PYTHON} lib/petsc/bin/maint/wwwindex.py ${PETSC_DIR} ${LOC}
331	-${OMAKE} manconcepts LOC=${LOC}
332	-${OMAKE} ACTION=getexlist tree_basic LOC=${LOC}
333	-${OMAKE} ACTION=exampleconcepts tree_basic LOC=${LOC}
334	-${PYTHON} lib/petsc/bin/maint/helpindex.py ${PETSC_DIR} ${LOC}
335
336# Builds .html versions of the source
337# html overwrites some stuff created by update-docs - hence this is done later.
338alldoc2: chk_loc
339	-${OMAKE} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC}
340	-${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC}
341#
342# Builds HTML versions of Matlab scripts
343alldoc3: chk_loc
344	if  [ "${MATLAB_COMMAND}" != "" ]; then\
345          export MATLABPATH=${MATLABPATH}:${PETSC_DIR}/share/petsc/matlab; \
346          cd ${PETSC_DIR}/share/petsc/matlab; ${MATLAB_COMMAND} -nodisplay -nodesktop -r "generatehtml;exit" ; \
347        fi
348
349#
350# Makes links for all manual pages in $LOC/docs/manualpages/all
351allman:
352	@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 \;
353
354DOCSETDATE_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
355
356# modify all generated html files and add in version number, date, canonical URL info.
357docsetdate: chk_petscdir
358	@echo "Updating generated html files with petsc version, date, canonical URL info";\
359        version_release=`grep '^#define PETSC_VERSION_RELEASE ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
360        version_major=`grep '^#define PETSC_VERSION_MAJOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
361        version_minor=`grep '^#define PETSC_VERSION_MINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
362        version_subminor=`grep '^#define PETSC_VERSION_SUBMINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
363        if  [ $${version_release} = 0 ]; then \
364          petscversion=petsc-master; \
365          export petscversion; \
366        elif [ $${version_release} = 1 ]; then \
367          petscversion=petsc-$${version_major}.$${version_minor}.$${version_subminor}; \
368          export petscversion; \
369        else \
370          echo "Unknown PETSC_VERSION_RELEASE: $${version_release}"; \
371          exit; \
372        fi; \
373        datestr=`git log -1 --pretty=format:%ci | cut -d ' ' -f 1`; \
374        export datestr; \
375        gitver=`git describe --match "v*"`; \
376        export gitver; \
377        find * -type d -wholename src/docs/website -prune -o -type d -wholename src/benchmarks/results -prune -o \
378          -type d -wholename config/BuildSystem/docs/website -prune -o -type d -wholename include/web -prune -o \
379          -type d -wholename 'arch-*' -prune -o -type d -wholename src/tops -prune -o -type d -wholename externalpackages -prune ${DOCSETDATE_PRUNE_LIST} -o \
380          -type f -name \*.html \
381          -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' {} \; \
382          -exec perl -pi -e 's^(<head>)^$$1 <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/{}" />^i' {} \; ; \
383        echo "Done fixing version number, date, canonical URL info"
384
385alldocclean: deletemanualpages allcleanhtml
386
387# Deletes man pages (HTML version)
388deletemanualpages: chk_loc
389	-@if [ -d ${LOC} -a -d ${LOC}/docs/manualpages ]; then \
390          find ${LOC}/docs/manualpages -type f -name "*.html" -exec ${RM} {} \; ;\
391          ${RM} ${LOC}/docs/exampleconcepts ;\
392          ${RM} ${LOC}/docs/manconcepts ;\
393          ${RM} ${LOC}/docs/manualpages/manualpages.cit ;\
394          ${PYTHON} lib/petsc/bin/maint/update-docs.py ${PETSC_DIR} ${LOC} clean;\
395        fi
396
397allcleanhtml:
398	-${OMAKE} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} alltree
399
400chk_concepts_dir: chk_loc
401	@if [ ! -d "${LOC}/docs/manualpages/concepts" ]; then \
402	  echo Making directory ${LOC}/docs/manualpages/concepts for library; ${MKDIR} ${LOC}/docs/manualpages/concepts; fi
403
404###########################################################
405# targets to build distribution and update docs
406###########################################################
407
408# Creates ${HOME}/petsc.tar.gz [and petsc-lite.tar.gz]
409dist:
410	${PETSC_DIR}/lib/petsc/bin/maint/builddist ${PETSC_DIR} master
411
412# This target works only if you can do 'ssh petsc@login.mcs.anl.gov'
413# also copy the file over to ftp site.
414web-snapshot:
415	@if [ ! -f "${HOME}/petsc-master.tar.gz" ]; then \
416	    echo "~/petsc-master.tar.gz missing! cannot update petsc-master snapshot on mcs-web-site"; \
417	  else \
418            echo "updating petsc-master snapshot on mcs-web-site"; \
419	    tmpdir=`mktemp -d -t petsc-doc.XXXXXXXX`; \
420	    cd $${tmpdir}; tar -xzf ${HOME}/petsc-master.tar.gz; \
421	    /usr/bin/rsync  -e ssh -az --delete $${tmpdir}/petsc-master/ \
422              petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/petsc-master ;\
423	    /bin/cp -f /home/petsc/petsc-master.tar.gz /mcs/ftp/pub/petsc/petsc-master.tar.gz;\
424	    ${RM} -rf $${tmpdir} ;\
425	  fi
426
427# build the tarfile - and then update petsc-master snapshot on mcs-web-site
428update-web-snapshot: dist web-snapshot
429
430# This target updates website main pages
431update-web:
432	@cd ${PETSC_DIR}/src/docs; make PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} bib2html; \
433	/usr/bin/rsync -az -C --exclude=documentation/index.html \
434          --exclude=documentation/installation.html --exclude=download/index.html \
435	  ${PETSC_DIR}/src/docs/website/ petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc
436	@cd ${PETSC_DIR}/docs; /usr/bin/rsync -az developers.pdf petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/developers/
437	@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
438
439#
440#  builds a single list of files for each PETSc library so they may all be built in parallel
441#  without a recursive set of make calls
442createfastbuild:
443	cd src/vec; ${RM} -f files; /bin/echo -n "SOURCEC = " > files; make tree ACTION=sourcelist BASE_DIR=${PETSC_DIR}/src/vec
444
445###########################################################
446#
447#  See script for details
448#
449gcov:
450	-@$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py -run_gcov
451
452mergegcov:
453	-@$(PYTHON) ${PETSC_DIR}/lib/petsc/bin/maint/gcov.py -merge_gcov ${LOC} *.tar.gz
454
455########################
456#
457# Create the include dependency graph (requires graphviz to be available)
458#
459includegraph:
460	-@${PETSC_DIR}/src/contrib/style/include-graph.sh includegraph.pdf
461	-@echo Include dependency graph written to includegraph.pdf
462
463#
464# -------------------------------------------------------------------------------
465#
466# Some macros to check if the fortran interface is up-to-date.
467#
468countfortranfunctions:
469	-@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \
470	cut -d'(' -f1 | tr -s  ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \
471	sed "s/_$$//" | sort > /tmp/countfortranfunctions
472
473countcfunctions:
474	-@grep PETSC_EXTERN ${PETSC_DIR}/include/*.h  | grep "(" | tr -s ' ' | \
475	cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' |  \
476	tr 'A-Z' 'a-z' |  sort | uniq > /tmp/countcfunctions
477
478difffortranfunctions: countfortranfunctions countcfunctions
479	-@echo -------------- Functions missing in the fortran interface ---------------------
480	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2
481	-@echo ----------------- Functions missing in the C interface ------------------------
482	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2
483	-@${RM}  /tmp/countcfunctions /tmp/countfortranfunctions
484
485checkbadfortranstubs:
486	-@echo "========================================="
487	-@echo "Functions with MPI_Comm as an Argument"
488	-@echo "========================================="
489	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \
490	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
491	-@echo "========================================="
492	-@echo "Functions with a String as an Argument"
493	-@echo "========================================="
494	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \
495	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
496	-@echo "========================================="
497	-@echo "Functions with Pointers to PETSc Objects as Argument"
498	-@echo "========================================="
499	-@cd ${PETSC_DIR}/src/fortran/auto; \
500	_p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \
501	cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \
502	sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \
503	for OBJ in $$_p_OBJ; do \
504	grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \
505	cut -d'(' -f1 | cut -d' ' -f1,3; \
506	done
507
508checkpackagetests:
509	-@echo "Missing package tests"
510	-@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
511	-@echo "Missing download package tests"
512	-@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
513
514#
515# Automatically generates PETSc exercises in html from the tutorial examples.
516#
517# The introduction for each section is obtained from docs/manualpages-cite/header_${MANSEC} may be edited
518#  (used also in introductions to the manual pages)
519#
520# DO NOT EDIT the *.htm files generated since they will be automatically replaced.
521#
522# Eventually the line below will replace the two cd in the rule below, it is just this way now for speed
523#	-@${OMAKE} PETSC_DIR=${PETSC_DIR} pagemaker
524#
525exercises:
526	-@echo "========================================="
527	-@echo "Generating HTML tutorial exercises"
528	-@${RM} docs/pageform.txt
529	-@echo "title=\"PETSc Exercises\""                >  docs/pageform.txt
530	-@echo "access_title=Exercise Sections"              >>  docs/pageform.txt
531	-@echo "access_format=short"                        >> docs/pageform.txt
532	-@echo "startpage=../exercises/introduction.htm"  >> docs/pageform.txt
533	-@echo "NONE title=\"Introduction\" command=link src=../exercises/introduction.htm" >> docs/pageform.txt
534	-@echo "Generating HTML for individual directories"
535	-@echo "========================================="
536	-@${OMAKE} PETSC_DIR=${PETSC_DIR} ACTION=pagemaker tree
537	-@echo "Completed HTML for individual directories"
538	-@echo "NONE title=\"<HR>\" " >> docs/pageform.txt;
539	-@echo "NONE title=\"PETSc Documentation\" command=link src=../index.html target=replace" >> docs/pageform.txt
540	/home/MPI/class/mpiexmpl/maint/makepage.new -pageform=docs/pageform.txt -access_extra=/dev/null -outdir=docs/exercises
541	-@echo "========================================="
542
543.PHONY: info info_h all build ranlib deletelibs allclean update \
544        alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanualpages \
545        allhtml allcleanhtml  allci allco allrcslabel countfortranfunctions \
546        start_configure configure_petsc configure_clean matlabbin install
547
548petscao : petscmat petscao.f90.h
549petscdm : petscksp petscdm.f90.h
550petscdraw : petsc petscdraw.f90.h
551petscis : petsc petscis.f90.h
552petscksp : petscpc  petscksp.f90.h
553petsclog : petsc petsclog.f90.h
554petscmat : petscvec petscmat.f90.h
555petscmg : petscksp petscmg.f90.h
556petscpc : petscmat petscpc.f90.h
557petscsnes : petscksp petscsnes.f90.h
558petscsys : petsc petscsys.f90.h
559petscts : petscsnes petscts.f90.h
560petsc : petsc.f90.h
561petscvec : petscis petscvec.f90.h
562petscviewer : petsc petscviewer.f90.h
563petscmesh : petsc petscmesh.f90.h
564modules : petscao petscdm petscdraw petscis petscksp petsclog petscmat petscmg petscpc petscsnes petscsys petscts petsc petscvec petscviewer petscmesh
565