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