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