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