xref: /petsc/makefile (revision e4643290c644df86f8c4e441ed3d7e94b192f1dd)
1753a1a87SJed Brown#
2753a1a87SJed Brown# This is the makefile for compiling PETSc. See
3753a1a87SJed Brown# http://www.mcs.anl.gov/petsc/documentation/installation.html for directions on installing PETSc.
4753a1a87SJed Brown# See also conf for additional commands.
5753a1a87SJed Brown#
6753a1a87SJed BrownALL: all
7753a1a87SJed BrownLOCDIR	 = ./
89895aa37SBarry SmithDIRS	 = src include tutorials lua
9753a1a87SJed BrownCFLAGS	 =
10753a1a87SJed BrownFFLAGS	 =
11d4f3a1abSSatish BalayCPPFLAGS =
12d4f3a1abSSatish BalayFPPFLAGS =
13753a1a87SJed Brown
14753a1a87SJed Brown# next line defines PETSC_DIR and PETSC_ARCH if they are not set
15753a1a87SJed Browninclude ././${PETSC_ARCH}/conf/petscvariables
16753a1a87SJed Browninclude ${PETSC_DIR}/conf/variables
17753a1a87SJed Browninclude ${PETSC_DIR}/conf/rules
18753a1a87SJed Browninclude ${PETSC_DIR}/conf/test
19753a1a87SJed Brown
20753a1a87SJed Brown#
21753a1a87SJed Brown# Basic targets to build PETSc libraries.
22753a1a87SJed Brown# all: builds the c, fortran, and f90 libraries
234a18a678SSatish Balayall: chk_makej
24ad5c76d5SBarry Smith	@${OMAKE}  PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} chk_petscdir chk_upgrade | tee ${PETSC_ARCH}/conf/make.log
25753a1a87SJed Brown	@ln -sf ${PETSC_ARCH}/conf/make.log make.log
26753a1a87SJed Brown	@if [ "${PETSC_BUILD_USING_CMAKE}" != "" ]; then \
274252f254SSatish Balay	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-cmake-local 2>&1 | tee -a ${PETSC_ARCH}/conf/make.log \
28753a1a87SJed Brown		| 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)'; \
29753a1a87SJed Brown	 else \
304252f254SSatish Balay	   ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} all-legacy-local 2>&1 | tee -a ${PETSC_ARCH}/conf/make.log \
31753a1a87SJed Brown                | ${GREP} -v "has no symbols"; \
32753a1a87SJed Brown	 fi
33753a1a87SJed Brown	@egrep -i "( error | error: |no such file or directory)" ${PETSC_ARCH}/conf/make.log | tee ${PETSC_ARCH}/conf/error.log > /dev/null
34753a1a87SJed Brown	@if test -s ${PETSC_ARCH}/conf/error.log; then \
355484e79dSBarry Smith           printf ${PETSC_TEXT_HILIGHT}"**************************ERROR************************************\n" 2>&1 | tee -a ${PETSC_ARCH}/conf/make.log; \
36753a1a87SJed Brown           echo "  Error during compile, check ${PETSC_ARCH}/conf/make.log" 2>&1 | tee -a ${PETSC_ARCH}/conf/make.log; \
37753a1a87SJed Brown           echo "  Send it and ${PETSC_ARCH}/conf/configure.log to petsc-maint@mcs.anl.gov" 2>&1 | tee -a ${PETSC_ARCH}/conf/make.log;\
385484e79dSBarry Smith           printf "********************************************************************"${PETSC_TEXT_NORMAL}"\n" 2>&1 | tee -a ${PETSC_ARCH}/conf/make.log;\
39753a1a87SJed Brown	 else \
40753a1a87SJed Brown	  ${OMAKE} shared_install PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} 2>&1 | tee -a ${PETSC_ARCH}/conf/make.log ;\
41753a1a87SJed Brown        fi #solaris make likes to print the whole command that gave error. So split this up into the smallest chunk below
42753a1a87SJed Brown	@if test -s ${PETSC_ARCH}/conf/error.log; then exit 1; fi
43753a1a87SJed Brown
444252f254SSatish Balayall-cmake:
454252f254SSatish Balay	@if [ "${PETSC_BUILD_USING_CMAKE}" != "" ]; then \
464252f254SSatish Balay          ${OMAKE}  PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} all;\
475484e79dSBarry Smith        else printf ${PETSC_TEXT_HILIGHT}"Build not configured for CMAKE. Quiting"${PETSC_TEXT_NORMAL}"\n"; exit 1; fi
48753a1a87SJed Brown
494252f254SSatish Balayall-legacy:
504252f254SSatish Balay	@${OMAKE}  PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} PETSC_BUILD_USING_CMAKE="" all
514252f254SSatish Balay
524252f254SSatish Balayall-cmake-local: chk_makej info cmakegen cmake
534252f254SSatish Balay
544252f254SSatish Balayall-legacy-local: chk_makej chklib_dir info deletelibs deletemods build shared_nomesg mpi4py petsc4py
55753a1a87SJed Brown#
56753a1a87SJed Brown# Prints information about the system and version of PETSc being compiled
57753a1a87SJed Brown#
584a18a678SSatish Balayinfo: chk_makej
59753a1a87SJed Brown	-@echo "=========================================="
60753a1a87SJed Brown	-@echo " "
61753a1a87SJed Brown	-@echo "See documentation/faq.html and documentation/bugreporting.html"
62753a1a87SJed Brown	-@echo "for help with installation problems. Please send EVERYTHING"
63753a1a87SJed Brown	-@echo "printed out below when reporting problems"
64753a1a87SJed Brown	-@echo " "
65753a1a87SJed Brown	-@echo "To subscribe to the PETSc announcement list, send mail to "
66753a1a87SJed Brown	-@echo "majordomo@mcs.anl.gov with the message: "
67753a1a87SJed Brown	-@echo "subscribe petsc-announce"
68753a1a87SJed Brown	-@echo " "
69753a1a87SJed Brown	-@echo "To subscribe to the PETSc users mailing list, send mail to "
70753a1a87SJed Brown	-@echo "majordomo@mcs.anl.gov with the message: "
71753a1a87SJed Brown	-@echo "subscribe petsc-users"
72753a1a87SJed Brown	-@echo " "
73753a1a87SJed Brown	-@echo "=========================================="
74753a1a87SJed Brown	-@echo On `date` on `hostname`
75753a1a87SJed Brown	-@echo Machine characteristics: `uname -a`
76753a1a87SJed Brown	-@echo "-----------------------------------------"
77753a1a87SJed Brown	-@echo "Using PETSc directory: ${PETSC_DIR}"
78753a1a87SJed Brown	-@echo "Using PETSc arch: ${PETSC_ARCH}"
79753a1a87SJed Brown	-@echo "-----------------------------------------"
80753a1a87SJed Brown	-@grep "define PETSC_VERSION" ${PETSC_DIR}/include/petscversion.h | ${SED} "s/........//"
81753a1a87SJed Brown	-@echo "-----------------------------------------"
82753a1a87SJed Brown	-@echo "Using configure Options: ${CONFIGURE_OPTIONS}"
83753a1a87SJed Brown	-@echo "Using configuration flags:"
84753a1a87SJed Brown	-@grep "\#define " ${PETSC_DIR}/${PETSC_ARCH}/include/petscconf.h
85753a1a87SJed Brown	-@echo "-----------------------------------------"
86da0b7683SSatish Balay	-@echo "Using C/C++ compile: ${PETSC_COMPILE}"
87607e78e0SSatish Balay	-@if [ "${PETSC_LANGUAGE}" = "CONLY" -a "${MPICC_SHOW}" != "" ]; then \
88fd0cdb26SSatish Balay             printf  "mpicc -show: %b\n" "${MPICC_SHOW}"; \
89607e78e0SSatish Balay	  elif [ "${PETSC_LANGUAGE}" = "CXXONLY" -a "${MPICXX_SHOW}" != "" ]; then \
90fd0cdb26SSatish Balay             printf "mpicxx -show: %b\n" "${MPICXX_SHOW}"; \
91607e78e0SSatish Balay          fi;
92753a1a87SJed Brown	-@if [ "${FC}" != "" ]; then \
93da0b7683SSatish Balay	   echo "Using Fortran compile: ${PETSC_FCOMPILE}";\
94607e78e0SSatish Balay           if [ "${MPIFC_SHOW}" != "" ]; then \
95fd0cdb26SSatish Balay             printf "mpif90 -show: %b\n" "${MPIFC_SHOW}"; \
96607e78e0SSatish Balay           fi; \
97da0b7683SSatish Balay         fi
98da0b7683SSatish Balay	-@if [ "${CUDAC}" != "" ]; then \
99da0b7683SSatish Balay	   echo "Using CUDA compile: ${PETSC_CUCOMPILE}";\
100753a1a87SJed Brown         fi
101753a1a87SJed Brown	-@echo "-----------------------------------------"
102753a1a87SJed Brown	-@echo "Using C/C++ linker: ${PCC_LINKER}"
103753a1a87SJed Brown	-@echo "Using C/C++ flags: ${PCC_LINKER_FLAGS}"
104753a1a87SJed Brown	-@if [ "${FC}" != "" ]; then \
105753a1a87SJed Brown	   echo "Using Fortran linker: ${FC_LINKER}";\
106753a1a87SJed Brown	   echo "Using Fortran flags: ${FC_LINKER_FLAGS}";\
107753a1a87SJed Brown         fi
108753a1a87SJed Brown	-@echo "-----------------------------------------"
109753a1a87SJed Brown	-@echo "Using libraries: ${PETSC_LIB}"
110753a1a87SJed Brown	-@echo "------------------------------------------"
111753a1a87SJed Brown	-@echo "Using mpiexec: ${MPIEXEC}"
112753a1a87SJed Brown	-@echo "=========================================="
113753a1a87SJed Brown
114753a1a87SJed Brown#
115753a1a87SJed Brown# Builds the PETSc libraries
116753a1a87SJed Brown# This target also builds fortran77 and f90 interface
117753a1a87SJed Brown# files and compiles .F files
118753a1a87SJed Brown#
1194a18a678SSatish Balaybuild: chk_makej
120753a1a87SJed Brown	-@echo "BEGINNING TO COMPILE LIBRARIES IN ALL DIRECTORIES"
121753a1a87SJed Brown	-@echo "========================================="
122753a1a87SJed Brown	-@${OMAKE}  PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=libfast tree
123753a1a87SJed Brown	-@${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}  > tmpf 2>&1 ; ${GREP} -v "has no symbols" tmpf; ${RM} tmpf;
124753a1a87SJed Brown	-@echo "Completed building libraries"
125753a1a87SJed Brown	-@echo "========================================="
126753a1a87SJed Brown#
127753a1a87SJed Brown#
128753a1a87SJed Brown# Builds PETSc test examples for a given architecture
129753a1a87SJed Brown#
13056879a31SBarry Smithcheck: test
131753a1a87SJed Browntest:
132753a1a87SJed Brown	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} test_build 2>&1 | tee ./${PETSC_ARCH}/conf/test.log
133753a1a87SJed Browntestx:
134753a1a87SJed Brown	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testx_build 2>&1 | tee ./${PETSC_ARCH}/conf/testx.log
135753a1a87SJed Browntest_build:
136753a1a87SJed Brown	-@echo "Running test examples to verify correct installation"
137753a1a87SJed Brown	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
138753a1a87SJed Brown	@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
139753a1a87SJed Brown	@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testex19
1404b66f5ecSSatish Balay	@if [ "${FC}" != "" ]; then \
1414b66f5ecSSatish Balay          egrep "^#define PETSC_USE_FORTRAN_DATATYPES 1" ${PETSC_DIR}/${PETSC_ARCH}/include/petscconf.h | tee .ftn-dtype.log > /dev/null; \
1424b66f5ecSSatish Balay          if test -s .ftn-dtype.log; then F90TEST="testex5f90t"; else F90TEST="testex5f"; fi; ${RM} .ftn-dtype.log; \
1434b66f5ecSSatish Balay          cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} $${F90TEST}; \
1444b66f5ecSSatish Balay         fi;
145753a1a87SJed Brown	@cd src/snes/examples/tutorials >/dev/null; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
146753a1a87SJed Brown	-@echo "Completed test examples"
147753a1a87SJed Browntestx_build:
148753a1a87SJed Brown	-@echo "Running graphics test example to verify correct X11 installation"
149753a1a87SJed Brown	-@echo "Using PETSC_DIR=${PETSC_DIR} and PETSC_ARCH=${PETSC_ARCH}"
150753a1a87SJed Brown	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
151753a1a87SJed Brown	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} testxex19
152753a1a87SJed Brown	@cd src/snes/examples/tutorials; ${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} clean
153753a1a87SJed Brown	-@echo "Completed graphics test example"
154753a1a87SJed Brown
155753a1a87SJed Browntestexamples: info
156753a1a87SJed Brown	-@echo "BEGINNING TO COMPILE AND RUN TEST EXAMPLES"
157753a1a87SJed Brown	-@echo "Due to different numerical round-off on certain"
158753a1a87SJed Brown	-@echo "machines some of the numbers may not match exactly."
159753a1a87SJed Brown	-@echo "========================================="
160753a1a87SJed Brown	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH}  PETSC_DIR=${PETSC_DIR} ACTION=testexamples_C  tree
161753a1a87SJed Brown	-@echo "Completed compiling and running test examples"
162753a1a87SJed Brown	-@echo "========================================="
163753a1a87SJed Browntestfortran: info
164753a1a87SJed Brown	-@echo "BEGINNING TO COMPILE AND RUN FORTRAN TEST EXAMPLES"
165753a1a87SJed Brown	-@echo "========================================="
166753a1a87SJed Brown	-@echo "Due to different numerical round-off on certain"
167753a1a87SJed Brown	-@echo "machines or the way Fortran formats numbers"
168753a1a87SJed Brown	-@echo "some of the results may not match exactly."
169753a1a87SJed Brown	-@echo "========================================="
170753a1a87SJed Brown	-@if [ "${FC}" != "" ]; then \
171753a1a87SJed Brown            ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_Fortran tree; \
172753a1a87SJed Brown            echo "Completed compiling and running Fortran test examples"; \
173753a1a87SJed Brown          else \
174753a1a87SJed Brown            echo "Error: No FORTRAN compiler available"; \
175753a1a87SJed Brown          fi
176753a1a87SJed Brown	-@echo "========================================="
177753a1a87SJed Browntestexamples_uni: info
178753a1a87SJed Brown	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR EXAMPLES"
179753a1a87SJed Brown	-@echo "Due to different numerical round-off on certain"
180753a1a87SJed Brown	-@echo "machines some of the numbers may not match exactly."
181753a1a87SJed Brown	-@echo "========================================="
182753a1a87SJed Brown	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_C_X_MPIUni  tree
183753a1a87SJed Brown	-@echo "Completed compiling and running uniprocessor test examples"
184753a1a87SJed Brown	-@echo "========================================="
185753a1a87SJed Browntestfortran_uni: info
186753a1a87SJed Brown	-@echo "BEGINNING TO COMPILE AND RUN TEST UNI-PROCESSOR FORTRAN EXAMPLES"
187753a1a87SJed Brown	-@echo "Due to different numerical round-off on certain"
188753a1a87SJed Brown	-@echo "machines some of the numbers may not match exactly."
189753a1a87SJed Brown	-@echo "========================================="
190753a1a87SJed Brown	-@if [ "${FC}" != "" ]; then \
191753a1a87SJed Brown            ${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=testexamples_Fortran_MPIUni  tree; \
192753a1a87SJed Brown            echo "Completed compiling and running uniprocessor fortran test examples"; \
193753a1a87SJed Brown          else \
194753a1a87SJed Brown            echo "Error: No FORTRAN compiler available"; \
195753a1a87SJed Brown          fi
196753a1a87SJed Brown	-@
197753a1a87SJed Brown	-@echo "========================================="
198753a1a87SJed Brown
199753a1a87SJed Brown# Ranlib on the libraries
200753a1a87SJed Brownranlib:
201753a1a87SJed Brown	${RANLIB} ${PETSC_LIB_DIR}/*.${AR_LIB_SUFFIX}
202753a1a87SJed Brown
203753a1a87SJed Brown# Deletes PETSc libraries
2044a18a678SSatish Balaydeletelibs: chk_makej
205753a1a87SJed Brown	-${RM} -rf ${PETSC_LIB_DIR}/libpetsc*.*
2064a18a678SSatish Balaydeletemods: chk_makej
207753a1a87SJed Brown	-${RM} -f ${PETSC_DIR}/${PETSC_ARCH}/include/petsc*.mod
208753a1a87SJed Brown
209753a1a87SJed Brown# Cleans up build
210753a1a87SJed Brownallclean: deletelibs deletemods
211753a1a87SJed Brown	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} PETSC_DIR=${PETSC_DIR} ACTION=clean tree
212753a1a87SJed Brown#
213753a1a87SJed Brownreconfigure:
214753a1a87SJed Brown	@${PYTHON} ${PETSC_ARCH}/conf/reconfigure-${PETSC_ARCH}.py
215753a1a87SJed Brown#
216753a1a87SJed Browninstall:
217753a1a87SJed Brown	@${PYTHON} ./config/install.py -destDir=${DESTDIR}
218753a1a87SJed Brown
219753a1a87SJed Brownnewall:
220753a1a87SJed Brown	-@cd src/sys;  @${PYTHON} ${PETSC_DIR}/config/builder.py
221753a1a87SJed Brown	-@cd src/vec;  @${PYTHON} ${PETSC_DIR}/config/builder.py
222753a1a87SJed Brown	-@cd src/mat;  @${PYTHON} ${PETSC_DIR}/config/builder.py
223753a1a87SJed Brown	-@cd src/dm;   @${PYTHON} ${PETSC_DIR}/config/builder.py
224753a1a87SJed Brown	-@cd src/ksp;  @${PYTHON} ${PETSC_DIR}/config/builder.py
225753a1a87SJed Brown	-@cd src/snes; @${PYTHON} ${PETSC_DIR}/config/builder.py
226753a1a87SJed Brown	-@cd src/ts;   @${PYTHON} ${PETSC_DIR}/config/builder.py
227753a1a87SJed Brown
228753a1a87SJed Brownstreams:
229753a1a87SJed Brown	cd src/benchmarks/streams; ${OMAKE} test
230753a1a87SJed Brown# ------------------------------------------------------------------
231753a1a87SJed Brown#
232753a1a87SJed Brown# All remaining actions are intended for PETSc developers only.
233753a1a87SJed Brown# PETSc users should not generally need to use these commands.
234753a1a87SJed Brown#
235753a1a87SJed Brown#  See the users manual for how the tags files may be used from Emacs and Vi/Vim
236753a1a87SJed Brown#
237753a1a87SJed Brownalletags:
238753a1a87SJed Brown	-@${PYTHON} bin/maint/generateetags.py
239753a1a87SJed Brown	-@find config -type f -name "*.py" |grep -v SCCS | xargs etags -o TAGS_PYTHON
240753a1a87SJed Brown
241762ef373SBarry Smith# obtain gtags from http://www.gnu.org/s/global/
242762ef373SBarry Smithallgtags:
243762ef373SBarry Smith	-@find -E ${PETSC_DIR}/{include,src,bin} -regex '(.*makefile|.*\.(cc|hh|cpp|C|hpp|c|h|cu|m)$$)' | grep -v ftn-auto  | gtags -f -
244762ef373SBarry Smith
245753a1a87SJed Brownallfortranstubs:
246753a1a87SJed Brown	-@${RM} -rf include/finclude/ftn-auto/*-tmpdir
247753a1a87SJed Brown	-@${PYTHON} bin/maint/generatefortranstubs.py ${BFORT}  ${VERBOSE}
248753a1a87SJed Brown	-@${PYTHON} bin/maint/generatefortranstubs.py -merge  ${VERBOSE}
249753a1a87SJed Brown	-@${RM} -rf include/finclude/ftn-auto/*-tmpdir
250753a1a87SJed Browndeletefortranstubs:
251753a1a87SJed Brown	-@find . -type d -name ftn-auto | xargs rm -rf
252753a1a87SJed Browncmakegen:
253753a1a87SJed Brown	-@${PYTHON} config/cmakegen.py
254753a1a87SJed Brown#
255753a1a87SJed Brown# These are here for the target allci and allco, and etags
256753a1a87SJed Brown#
257753a1a87SJed Brown
258bcaeba4dSBarry SmithBMAKEFILES = conf/variables conf/rules conf/test
259753a1a87SJed BrownSCRIPTS    = bin/maint/builddist  bin/maint/wwwman bin/maint/xclude bin/maint/bugReport.py bin/maint/buildconfigtest bin/maint/builddistlite \
260753a1a87SJed Brown             bin/maint/buildtest bin/maint/checkBuilds.py bin/maint/copylognightly bin/maint/copylognightly.tao bin/maint/countfiles bin/maint/findbadfiles \
261753a1a87SJed Brown             bin/maint/fixinclude bin/maint/getexlist bin/maint/getpdflabels.py bin/maint/helpindex.py bin/maint/hosts.local bin/maint/hosts.solaris  \
262753a1a87SJed Brown             bin/maint/lex.py  bin/maint/mapnameslatex.py bin/maint/startnightly bin/maint/startnightly.tao bin/maint/submitPatch.py \
263753a1a87SJed Brown             bin/maint/update-docs.py  bin/maint/wwwindex.py bin/maint/xcludebackup bin/maint/xcludecblas bin/maint/zap bin/maint/zapall \
264753a1a87SJed Brown             config/PETSc/Configure.py config/PETSc/Options.py \
265753a1a87SJed Brown             config/PETSc/packages/*.py config/PETSc/utilities/*.py
266753a1a87SJed Brown
267753a1a87SJed Brown
268753a1a87SJed Brown# Builds all the documentation - should be done every night
269753a1a87SJed Brownalldoc: alldoc1 alldoc2 alldoc3 docsetdate
270753a1a87SJed Brown
271753a1a87SJed Brown# Build everything that goes into 'doc' dir except html sources
272753a1a87SJed Brownalldoc1: chk_loc deletemanualpages chk_concepts_dir
273753a1a87SJed Brown	-${PYTHON} bin/maint/countpetsccits.py
274753a1a87SJed Brown	-${OMAKE} ACTION=manualpages_buildcite tree_basic LOC=${LOC}
275753a1a87SJed Brown	-@sed -e s%man+../%man+manualpages/% ${LOC}/docs/manualpages/manualpages.cit > ${LOC}/docs/manualpages/htmlmap
276753a1a87SJed Brown	-@cat ${PETSC_DIR}/src/docs/mpi.www.index >> ${LOC}/docs/manualpages/htmlmap
277753a1a87SJed Brown	-cd src/docs/tex/manual; ${OMAKE} manual.pdf LOC=${LOC}
278753a1a87SJed Brown	-cd src/docs/tex/manual; ${OMAKE} developers.pdf LOC=${LOC}
279753a1a87SJed Brown	-${OMAKE} ACTION=manualpages tree_basic LOC=${LOC}
280753a1a87SJed Brown	-${PYTHON} bin/maint/wwwindex.py ${PETSC_DIR} ${LOC}
281753a1a87SJed Brown	-${OMAKE} ACTION=manexamples tree_basic LOC=${LOC}
282753a1a87SJed Brown	-${OMAKE} manconcepts LOC=${LOC}
283753a1a87SJed Brown	-${OMAKE} ACTION=getexlist tree_basic LOC=${LOC}
284753a1a87SJed Brown	-${OMAKE} ACTION=exampleconcepts tree_basic LOC=${LOC}
285753a1a87SJed Brown	-${PYTHON} bin/maint/helpindex.py ${PETSC_DIR} ${LOC}
286753a1a87SJed Brown
287753a1a87SJed Brown# Builds .html versions of the source
288753a1a87SJed Brown# html overwrites some stuff created by update-docs - hence this is done later.
289753a1a87SJed Brownalldoc2: chk_loc
290753a1a87SJed Brown	-${OMAKE} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC}
291753a1a87SJed Brown	-${PYTHON} bin/maint/update-docs.py ${PETSC_DIR} ${LOC}
292753a1a87SJed Brown#
293753a1a87SJed Brown# Builds HTML versions of Matlab scripts
294753a1a87SJed Brownalldoc3: chk_loc
295753a1a87SJed Brown	if  [ "${MATLAB_COMMAND}" != "" ]; then\
296753a1a87SJed Brown          export MATLABPATH=${MATLABPATH}:${PETSC_DIR}/bin/matlab; \
297753a1a87SJed Brown          cd ${PETSC_DIR}/bin/matlab; ${MATLAB_COMMAND} -nodisplay -nodesktop -r "generatehtml;exit" ; \
298753a1a87SJed Brown          cd classes; ${MATLAB_COMMAND} -nodisplay -nodesktop -r "generatehtml;exit" ; \
299753a1a87SJed Brown          cd examples/tutorials; ${MATLAB_COMMAND} -nodisplay -nodesktop -r "generatehtml;exit" ; \
300753a1a87SJed Brown        fi
301753a1a87SJed Brown
302753a1a87SJed Brown# modify all generated html files and add in version number, date, canonical URL info.
303ad5c76d5SBarry Smithdocsetdate: chk_petscdir
304753a1a87SJed Brown	@echo "Updating generated html files with petsc version, date, canonical URL info";\
305753a1a87SJed Brown        version_release=`grep '^#define PETSC_VERSION_RELEASE ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
306753a1a87SJed Brown        version_major=`grep '^#define PETSC_VERSION_MAJOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
307753a1a87SJed Brown        version_minor=`grep '^#define PETSC_VERSION_MINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
308*e4643290SSatish Balay        version_subminor=`grep '^#define PETSC_VERSION_SUBMINOR ' include/petscversion.h |tr -s ' ' | cut -d ' ' -f 3`; \
309753a1a87SJed Brown        if  [ $${version_release} = 0 ]; then \
310753a1a87SJed Brown          petscversion=petsc-dev; \
311753a1a87SJed Brown          export petscversion; \
312753a1a87SJed Brown        elif [ $${version_release} = 1 ]; then \
313*e4643290SSatish Balay          petscversion=petsc-$${version_major}.$${version_minor}.$${version_subminor}; \
314753a1a87SJed Brown          export petscversion; \
315753a1a87SJed Brown        else \
316753a1a87SJed Brown          echo "Unknown PETSC_VERSION_RELEASE: $${version_release}"; \
317753a1a87SJed Brown          exit; \
318753a1a87SJed Brown        fi; \
3199c5cad75SSatish Balay        datestr=`git log -1 --pretty=format:%ci | cut -d ' ' -f 1`; \
320753a1a87SJed Brown        export datestr; \
321753a1a87SJed Brown        find * -type d -wholename src/docs/website -prune -o -type d -wholename src/benchmarks/results -prune -o \
322e6b20741SSatish Balay          -type d -wholename config/BuildSystem/docs/website -prune -o -type d -wholename include/web -prune -o \
32388f0584fSBarry Smith          -type d -wholename 'arch-*' -prune -o -type d -wholename src/tops -prune -o -type d -wholename externalpackages -prune -o \
324753a1a87SJed Brown          -type f -wholename tutorials/multiphysics/tutorial.html -prune -o -type f -name \*.html \
325753a1a87SJed Brown          -exec perl -pi -e 's^(<body.*>)^$$1\n   <div id=\"version\" align=right><b>$$ENV{petscversion} $$ENV{datestr}</b></div>^i' {} \; \
326753a1a87SJed Brown          -exec perl -pi -e 's^(<head>)^$$1 <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/{}" />^i' {} \; ; \
327753a1a87SJed Brown        echo "Done fixing version number, date, canonical URL info"
328753a1a87SJed Brown
329753a1a87SJed Brownalldocclean: deletemanualpages allcleanhtml
330753a1a87SJed Brown
331753a1a87SJed Brown# Deletes man pages (HTML version)
332753a1a87SJed Browndeletemanualpages: chk_loc
333753a1a87SJed Brown	-@if [ -d ${LOC} -a -d ${LOC}/docs/manualpages ]; then \
334753a1a87SJed Brown          find ${LOC}/docs/manualpages -type f -name "*.html" -exec ${RM} {} \; ;\
335753a1a87SJed Brown          ${RM} ${LOC}/docs/exampleconcepts ;\
336753a1a87SJed Brown          ${RM} ${LOC}/docs/manconcepts ;\
337753a1a87SJed Brown          ${RM} ${LOC}/docs/manualpages/manualpages.cit ;\
338753a1a87SJed Brown          ${PYTHON} bin/maint/update-docs.py ${PETSC_DIR} ${LOC} clean;\
339753a1a87SJed Brown        fi
340753a1a87SJed Brown
341753a1a87SJed Brownallcleanhtml:
342753a1a87SJed Brown	-${OMAKE} ACTION=cleanhtml PETSC_DIR=${PETSC_DIR} alltree
343753a1a87SJed Brown
344753a1a87SJed Brownchk_concepts_dir: chk_loc
345753a1a87SJed Brown	@if [ ! -d "${LOC}/docs/manualpages/concepts" ]; then \
346753a1a87SJed Brown	  echo Making directory ${LOC}/docs/manualpages/concepts for library; ${MKDIR} ${LOC}/docs/manualpages/concepts; fi
347753a1a87SJed Brown
348753a1a87SJed Brown###########################################################
349753a1a87SJed Brown# targets to build distribution and update docs
350753a1a87SJed Brown###########################################################
351753a1a87SJed Brown
352753a1a87SJed Brown# Creates ${HOME}/petsc.tar.gz [and petsc-lite.tar.gz]
353753a1a87SJed Browndist:
35491656f70SSatish Balay	${PETSC_DIR}/bin/maint/builddist ${PETSC_DIR} master
355753a1a87SJed Brown
356753a1a87SJed Brown# This target works only if you can do 'ssh petsc@login.mcs.anl.gov'
357753a1a87SJed Brown# also copy the file over to ftp site.
358753a1a87SJed Brownweb-snapshot:
359753a1a87SJed Brown	@if [ ! -f "${HOME}/petsc-dev.tar.gz" ]; then \
360753a1a87SJed Brown	    echo "~/petsc-dev.tar.gz missing! cannot update petsc-dev snapshot on mcs-web-site"; \
361753a1a87SJed Brown	  else \
362753a1a87SJed Brown            echo "updating petsc-dev snapshot on mcs-web-site"; \
363753a1a87SJed Brown	    tmpdir=`mktemp -d -t petsc-doc.XXXXXXXX`; \
364753a1a87SJed Brown	    cd $${tmpdir}; tar -xzf ${HOME}/petsc-dev.tar.gz; \
365753a1a87SJed Brown	    /usr/bin/rsync  -e ssh -az --delete $${tmpdir}/petsc-dev/ \
366753a1a87SJed Brown              petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/petsc-dev ;\
367753a1a87SJed Brown	    /bin/cp -f /home/petsc/petsc-dev.tar.gz /mcs/ftp/pub/petsc/petsc-dev.tar.gz;\
368753a1a87SJed Brown	    ${RM} -rf $${tmpdir} ;\
369753a1a87SJed Brown	  fi
370753a1a87SJed Brown
371753a1a87SJed Brown# build the tarfile - and then update petsc-dev snapshot on mcs-web-site
372753a1a87SJed Brownupdate-web-snapshot: dist web-snapshot
373753a1a87SJed Brown
374753a1a87SJed Brown# This target updates website main pages
375753a1a87SJed Brownupdate-web:
376753a1a87SJed Brown	@cd ${PETSC_DIR}/src/docs; make PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} bib2html; \
377753a1a87SJed Brown	/usr/bin/rsync -az -C --exclude=documentation/index.html \
378753a1a87SJed Brown          --exclude=documentation/installation.html --exclude=download/index.html \
379753a1a87SJed Brown	  ${PETSC_DIR}/src/docs/website/ petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc
380753a1a87SJed Brown	@cd ${PETSC_DIR}/docs; /usr/bin/rsync -az developers.pdf petsc@login.mcs.anl.gov:/mcs/web/research/projects/petsc/developers/
38192df35d2SSatish Balay	@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
382753a1a87SJed Brown
383753a1a87SJed Brown#
384753a1a87SJed Brown#  builds a single list of files for each PETSc library so they may all be built in parallel
385753a1a87SJed Brown#  without a recursive set of make calls
386753a1a87SJed Browncreatefastbuild:
3872d507118SSatish Balay	cd src/vec; ${RM} -f files; /bin/echo -n "SOURCEC = " > files; make tree ACTION=sourcelist BASE_DIR=${PETSC_DIR}/src/vec
388753a1a87SJed Brown
389753a1a87SJed Brown###########################################################
390753a1a87SJed Brown#
391753a1a87SJed Brown#  See script for details
392753a1a87SJed Brown#
393753a1a87SJed Browngcov:
394753a1a87SJed Brown	-@${PETSC_DIR}/bin/maint/gcov.py -run_gcov
395753a1a87SJed Brown
396753a1a87SJed Brownmergegcov:
397753a1a87SJed Brown	-@${PETSC_DIR}/bin/maint/gcov.py -merge_gcov ${LOC} *.tar.gz
398753a1a87SJed Brown
399753a1a87SJed Brown# usage make allrcslabel NEW_RCS_LABEL=v_2_0_28
400753a1a87SJed Brownallrcslabel:
401753a1a87SJed Brown	-@${OMAKE} PETSC_ARCH=${PETSC_ARCH} NEW_RCS_LABEL=${NEW_RCS_LABEL} ACTION=rcslabel  alltree
402753a1a87SJed Brown#
403753a1a87SJed Brown# -------------------------------------------------------------------------------
404753a1a87SJed Brown#
405753a1a87SJed Brown# Some macros to check if the fortran interface is up-to-date.
406753a1a87SJed Brown#
407753a1a87SJed Browncountfortranfunctions:
408753a1a87SJed Brown	-@cd ${PETSC_DIR}/src/fortran; egrep '^void' custom/*.c auto/*.c | \
409753a1a87SJed Brown	cut -d'(' -f1 | tr -s  ' ' | cut -d' ' -f2 | uniq | egrep -v "(^$$|Petsc)" | \
410753a1a87SJed Brown	sed "s/_$$//" | sort > /tmp/countfortranfunctions
411753a1a87SJed Brown
412753a1a87SJed Browncountcfunctions:
413753a1a87SJed Brown	-@grep extern ${PETSC_DIR}/include/*.h  | grep "(" | tr -s ' ' | \
414753a1a87SJed Brown	cut -d'(' -f1 | cut -d' ' -f3 | grep -v "\*" | tr -s '\012' |  \
415753a1a87SJed Brown	tr 'A-Z' 'a-z' |  sort > /tmp/countcfunctions
416753a1a87SJed Brown
417753a1a87SJed Browndifffortranfunctions: countfortranfunctions countcfunctions
418753a1a87SJed Brown	-@echo -------------- Functions missing in the fortran interface ---------------------
419753a1a87SJed Brown	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^<" | cut -d' ' -f2
420753a1a87SJed Brown	-@echo ----------------- Functions missing in the C interface ------------------------
421753a1a87SJed Brown	-@${DIFF} /tmp/countcfunctions /tmp/countfortranfunctions | grep "^>" | cut -d' ' -f2
422753a1a87SJed Brown	-@${RM}  /tmp/countcfunctions /tmp/countfortranfunctions
423753a1a87SJed Brown
424753a1a87SJed Browncheckbadfortranstubs:
425753a1a87SJed Brown	-@echo "========================================="
426753a1a87SJed Brown	-@echo "Functions with MPI_Comm as an Argument"
427753a1a87SJed Brown	-@echo "========================================="
428753a1a87SJed Brown	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'MPI_Comm' | \
429753a1a87SJed Brown	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
430753a1a87SJed Brown	-@echo "========================================="
431753a1a87SJed Brown	-@echo "Functions with a String as an Argument"
432753a1a87SJed Brown	-@echo "========================================="
433753a1a87SJed Brown	-@cd ${PETSC_DIR}/src/fortran/auto; grep '^void' *.c | grep 'char \*' | \
434753a1a87SJed Brown	tr -s ' ' | tr -s ':' ' ' |cut -d'(' -f1 | cut -d' ' -f1,3
435753a1a87SJed Brown	-@echo "========================================="
436753a1a87SJed Brown	-@echo "Functions with Pointers to PETSc Objects as Argument"
437753a1a87SJed Brown	-@echo "========================================="
438753a1a87SJed Brown	-@cd ${PETSC_DIR}/src/fortran/auto; \
439753a1a87SJed Brown	_p_OBJ=`grep _p_ ${PETSC_DIR}/include/*.h | tr -s ' ' | \
440753a1a87SJed Brown	cut -d' ' -f 3 | tr -s '\012' | grep -v '{' | cut -d'*' -f1 | \
441753a1a87SJed Brown	sed "s/_p_//g" | tr -s '\012 ' ' *|' ` ; \
442753a1a87SJed Brown	for OBJ in $$_p_OBJ; do \
443753a1a87SJed Brown	grep "$$OBJ \*" *.c | tr -s ' ' | tr -s ':' ' ' | \
444753a1a87SJed Brown	cut -d'(' -f1 | cut -d' ' -f1,3; \
445753a1a87SJed Brown	done
446753a1a87SJed Brown#
447753a1a87SJed Brown# Automatically generates PETSc exercises in html from the tutorial examples.
448753a1a87SJed Brown#
449753a1a87SJed Brown# The introduction for each section is obtained from docs/manualpages/header_${MANSEC} is under RCS and may be edited
450753a1a87SJed Brown#  (used also in introductions to the manual pages)
451753a1a87SJed Brown# The overall introduction is in docs/exercises/introduction.html and is under RCS and may be edited
452753a1a87SJed Brown# The list of exercises is from TUTORIALS in each directory's makefile
453753a1a87SJed Brown#
454753a1a87SJed Brown# DO NOT EDIT the pageform.txt or *.htm files generated since they will be automatically replaced.
455753a1a87SJed Brown# The pagemaker rule is in the file conf (at the bottom)
456753a1a87SJed Brown#
457753a1a87SJed Brown# Eventually the line below will replace the two cd in the rule below, it is just this way now for speed
458753a1a87SJed Brown#	-@${OMAKE} PETSC_DIR=${PETSC_DIR} pagemaker
459753a1a87SJed Brown#
460753a1a87SJed Brownexercises:
461753a1a87SJed Brown	-@echo "========================================="
462753a1a87SJed Brown	-@echo "Generating HTML tutorial exercises"
463753a1a87SJed Brown	-@${RM} docs/pageform.txt
464753a1a87SJed Brown	-@echo "title=\"PETSc Exercises\""                >  docs/pageform.txt
465753a1a87SJed Brown	-@echo "access_title=Exercise Sections"              >>  docs/pageform.txt
466753a1a87SJed Brown	-@echo "access_format=short"                        >> docs/pageform.txt
467753a1a87SJed Brown	-@echo "startpage=../exercises/introduction.htm"  >> docs/pageform.txt
468753a1a87SJed Brown	-@echo "NONE title=\"Introduction\" command=link src=../exercises/introduction.htm" >> docs/pageform.txt
469753a1a87SJed Brown	-@echo "Generating HTML for individual directories"
470753a1a87SJed Brown	-@echo "========================================="
471753a1a87SJed Brown	-@${OMAKE} PETSC_DIR=${PETSC_DIR} ACTION=pagemaker tree
472753a1a87SJed Brown	-@echo "Completed HTML for individual directories"
473753a1a87SJed Brown	-@echo "NONE title=\"<HR>\" " >> docs/pageform.txt;
474753a1a87SJed Brown	-@echo "NONE title=\"PETSc Documentation\" command=link src=../index.html target=replace" >> docs/pageform.txt
475753a1a87SJed Brown	/home/MPI/class/mpiexmpl/maint/makepage.new -pageform=docs/pageform.txt -access_extra=/dev/null -outdir=docs/exercises
476753a1a87SJed Brown	-@echo "========================================="
477753a1a87SJed Brown
478753a1a87SJed Brown.PHONY: info info_h all build testexamples testfortran testexamples_uni testfortran_uni ranlib deletelibs allclean update \
479753a1a87SJed Brown        alletags etags etags_complete etags_noexamples etags_makefiles etags_examples etags_fexamples alldoc allmanualpages \
480bcaeba4dSBarry Smith        allhtml allcleanhtml  allci allco allrcslabel countfortranfunctions \
481753a1a87SJed Brown        start_configure configure_petsc configure_clean
482753a1a87SJed Brown
483753a1a87SJed Brownpetscao : petscmat petscao.f90.h
484753a1a87SJed Brownpetscdm : petscksp petscdm.f90.h
485753a1a87SJed Brownpetscdraw : petsc petscdraw.f90.h
486753a1a87SJed Brownpetscis : petsc petscis.f90.h
487753a1a87SJed Brownpetscksp : petscpc  petscksp.f90.h
488753a1a87SJed Brownpetsclog : petsc petsclog.f90.h
489753a1a87SJed Brownpetscmat : petscvec petscmat.f90.h
490753a1a87SJed Brownpetscmg : petscksp petscmg.f90.h
491753a1a87SJed Brownpetscpc : petscmat petscpc.f90.h
492753a1a87SJed Brownpetscsnes : petscksp petscsnes.f90.h
493753a1a87SJed Brownpetscsys : petsc petscsys.f90.h
494753a1a87SJed Brownpetscts : petscsnes petscts.f90.h
495753a1a87SJed Brownpetsc : petsc.f90.h
496753a1a87SJed Brownpetscvec : petscis petscvec.f90.h
497753a1a87SJed Brownpetscviewer : petsc petscviewer.f90.h
498753a1a87SJed Brownpetscmesh : petsc petscmesh.f90.h
499753a1a87SJed Brownmodules : petscao petscdm petscdraw petscis petscksp petsclog petscmat petscmg petscpc petscsnes petscsys petscts petsc petscvec petscviewer petscmesh
500