Ticket #3798: mythtv_docs_v3a.diff
File mythtv_docs_v3a.diff, 8.7 KB (added by , 17 years ago) |
---|
-
configure
64 64 echo " --libdir-name=LIBNAME search/install libraries in PREFIX/LIBNAME [$libdir_name]" 65 65 echo " --disable-ccache disable compiler cache (ccache)" 66 66 echo " --disable-distcc disable distributed compilation (distcc)" 67 echo " --enable-dev-docs builds the developer documentation" 67 68 <<BLOCK_QUOTE 68 69 echo " --libdir=DIR install libs in DIR [PREFIX/lib]" 69 70 echo " --shlibdir=DIR install shared libs in DIR [PREFIX/lib]" … … 862 863 MYTHTV_CONFIG_LIST=' 863 864 backend 864 865 dbox2 866 dev_docbuild 865 867 directfb 866 868 directx 867 869 dvb … … 874 876 lirc 875 877 opengl_vsync 876 878 opengl_video 879 user_docbuild 877 880 v4l 878 881 valgrind 879 882 x11 … … 1144 1147 enable audio_oss 1145 1148 bindings_perl="yes" 1146 1149 dbox2="yes" 1150 dev_docbuild="no" 1151 directx="no" 1147 1152 directfb="yes" 1148 1153 dvb_path="/usr/include" 1149 1154 dvb="yes" … … 1157 1162 lamemp3="yes" 1158 1163 lirc="yes" 1159 1164 opengl="yes" 1165 user_docbuild="no" 1160 1166 v4l="yes" 1161 1167 x11="yes" 1162 1168 x11_include_path="/usr/X11R6/include" … … 1311 1317 ;; 1312 1318 --arch=*) arch="$optval" && arch_raw="$optval" && enable cpu_override 1313 1319 ;; 1320 --disable-distcc) distcc="no" 1321 ;; 1314 1322 --cpu=*) cpu="$optval" && enable cpu_override 1315 1323 ;; 1316 1324 … … 1379 1387 fi 1380 1388 done 1381 1389 ;; 1390 --disable-dev-docs) dev_docbuild="no" 1391 ;; 1392 --enable-dev-docs) dev_docbuild="yes" 1393 doxygen --version > /dev/null 2>&1 1394 if test $? -ne 0 ; then 1395 dev_docbuild="no" 1396 echo "*** Doxygen unavailable, disabling dev-docs!" 1397 fi 1398 ;; 1399 --disable-user-docs) user_docbuild="no" 1400 ;; 1401 --enable-user-docs) user_docbuild="yes" 1402 which htmldoc > /dev/null 2>&1 1403 if test $? -ne 0 ; then 1404 user_docbuild="no" 1405 echo "*** htmldoc unavailable, disabling user-docs!" 1406 fi 1407 which linuxdoc > /dev/null 2>&1 1408 if test $? -ne 0 ; then 1409 user_docbuild="no" 1410 echo "*** linuxdoc unavailable, disabling user-docbuild!" 1411 fi 1412 ;; 1382 1413 --disable-encoders) disable $ENCODER_LIST 1383 1414 ;; 1384 1415 --disable-decoders) disable $DECODER_LIST … … 2969 3000 echo "# Misc Features" 2970 3001 echo "Frontend ${frontend-no}" 2971 3002 echo "Backend ${backend-no}" 3003 echo "Build Developer Docs ${dev_docbuild}" 3004 if test x"${user_docbuild}" = x"yes"; then 3005 echo "Build User Docs ${user_docbuild}" 3006 fi 2972 3007 echo 2973 3008 2974 3009 echo "# Bindings" -
docs/docs.pro
1 # To build this stuff, you need the linuxdoc tools and htmldoc. On Debian, 2 # this means: linuxdoc-tools linuxdoc-tools-text htmldoc 3 # 4 # - mdz 5 6 # 7 # The dev docs need "doxygen" to build. 8 # 9 10 include ( ../config.mak ) 11 include ( ../settings.pro ) 12 13 INSTALLDIR = $${PREFIX}/share/doc/mythtv 14 15 TARGET = dummy 16 SOURCES = dummy.c 17 QMAKE_CLEAN += $${TARGET} 18 19 phony.target = .PHONY 20 phony.depends = clean install doc_installer 21 QMAKE_EXTRA_UNIX_TARGETS += phony 22 23 validate.target = validate 24 validate.depends = mythtv-HOWTO.sgml 25 validate.commands = linuxdoc -B check mythtv-HOWTO.sgml 2>&1 | tee validate 26 QMAKE_EXTRA_UNIX_TARGETS += validate 27 CLEAN_FILES += validate 28 29 splithtml.target = index.html 30 splithtml.depends = validate 31 splithtml.commands = linuxdoc -B html --split=1 --toc=2 mythtv-HOWTO.sgml; \ 32 $${QMAKE_MOVE} mythtv-HOWTO.html index.html 33 QMAKE_EXTRA_UNIX_TARGETS += splithtml 34 USER_INSTALLS += index.html mythtv-HOWTO-[0-9]*.html 35 using_user_docbuild { 36 CLEAN_FILES += index.html mythtv-HOWTO-[0-9]*.html 37 } 38 39 singlehtml.target = mythtv-HOWTO-singlehtml.html 40 singlehtml.depends = validate 41 singlehtml.commands = linuxdoc -B html --split=0 --toc=2 mythtv-HOWTO.sgml; \ 42 $${QMAKE_MOVE} mythtv-HOWTO.html mythtv-HOWTO-singlehtml.html 43 QMAKE_EXTRA_UNIX_TARGETS += singlehtml 44 #USER_INSTALLS += mythtv-HOWTO-singlehtml.html 45 using_user_docbuild { 46 CLEAN_FILES += mythtv-HOWTO-singlehtml.html 47 } 48 49 textdoc.target = mythtv-HOWTO.txt 50 textdoc.depends = validate 51 textdoc.commands = linuxdoc -B txt mythtv-HOWTO.sgml 52 QMAKE_EXTRA_UNIX_TARGETS += textdoc 53 USER_INSTALLS += mythtv-HOWTO.txt 54 using_user_docbuild { 55 CLEAN_FILES += mythtv-HOWTO.txt 56 } 57 58 pdf.target = mythtv-HOWTO.pdf 59 pdf.depends = mythtv-HOWTO-singlehtml.html 60 pdf.commands = htmldoc --book --quiet \ 61 --outfile mythtv-HOWTO.pdf mythtv-HOWTO-singlehtml.html 62 QMAKE_EXTRA_UNIX_TARGETS += pdf 63 USER_INSTALLS += mythtv-HOWTO.pdf 64 using_user_docbuild { 65 CLEAN_FILES += mythtv-HOWTO.pdf 66 } 67 68 devdocs.target = dev-docs 69 devdocs.commands = doxygen doxygen-create-developer-docs.cfg 70 QMAKE_EXTRA_UNIX_TARGETS += devdocs 71 using_dev_docbuild { 72 DEV_INSTALLS += dev-docs 73 } 74 CLEAN_FILES += doxygen-warnings.txt 75 CLEAN_COMMANDS += ; rm -Rf dev-docs 76 77 # Ask qmake to clean these files 78 # The commands MUST be last 79 # 80 QMAKE_CLEAN += $${CLEAN_FILES} $${CLEAN_COMMANDS} 81 82 # Control what is built with a plain "make" 83 # 84 using_user_docbuild { 85 PRE_TARGETDEPS += index.html 86 PRE_TARGETDEPS += mythtv-HOWTO-singlehtml.html 87 PRE_TARGETDEPS += mythtv-HOWTO.txt 88 PRE_TARGETDEPS += mythtv-HOWTO.pdf 89 } 90 using_dev_docbuild { 91 PRE_TARGETDEPS += dev-docs 92 } 93 94 # Get on with it... 95 # Install the file bundle, if not done as a separate group 96 # qmake tries to build the docs when installing them. 97 # This is a problem with doxygen :) 98 # 99 doc_installer.target = doc_installer 100 doc_installer.path = $${INSTALLDIR} 101 doc_installer.files = $${USER_INSTALLS} $${DEV_INSTALLS} 102 INSTALLS += doc_installer 103 104 # Ensure that the makefile is remade after any target is built. 105 # This is needed as qmake expands the file wildcards when 106 # it writes out the Makefile. If the install files/dirs do 107 # not exist when "qmake docs.pro" is run it wont get 108 # included in the install list 109 # 110 POST_TARGETDEPS += qmake -
docs/Makefile
1 # To build this stuff, you need the linuxdoc tools and htmldoc. On Debian,2 # this means: linuxdoc-tools linuxdoc-tools-text htmldoc3 #4 # - mdz5 6 TARGETS = mythtv-HOWTO.txt mythtv-HOWTO.html mythtv-HOWTO-singlehtml.html mythtv-HOWTO.pdf index.html7 LINUXDOC_HTML_SPLIT := 18 9 all: $(TARGETS)10 clean:11 rm -f $(TARGETS) $(patsubst %.html,%-[0-9]*.html,$(filter %.html,$(TARGETS)))12 rm -Rf doxygen-dev-docs doxygen-warnings.txt13 14 distclean: clean15 16 validate: mythtv-HOWTO.sgml17 linuxdoc -B check $<18 19 %.txt: %.sgml20 linuxdoc -B txt $<21 22 # Generate PDF via LaTeX using linuxdoc23 #%.pdf: %.sgml24 # linuxdoc -B latex -o pdf $<25 26 # Generate PDF via HTML using htmldoc27 %.pdf: %-singlehtml.html28 # htmldoc exits unsuccessfully for no good reason -mdz29 htmldoc --book --quiet --outfile $@ $< || true30 31 %.html: %.sgml32 linuxdoc -B html --split=$(LINUXDOC_HTML_SPLIT) --toc=2 $<33 34 %-singlehtml.html: LINUXDOC_HTML_SPLIT=035 %-singlehtml.sgml: %.sgml36 cp $< $@37 38 index.html: mythtv-HOWTO.html39 cp $< $@40 41 devdocs:42 doxygen doxygen-create-developer-docs.cfg -
docs/doxygen-create-developer-docs.cfg
30 30 # If a relative path is entered, it will be relative to the location 31 31 # where doxygen was started. If left blank the current directory will be used. 32 32 33 OUTPUT_DIRECTORY = d oxygen-dev-docs33 OUTPUT_DIRECTORY = dev-docs 34 34 35 35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 36 36 # 2 levels of 10 sub-directories under the output directory of each output … … 567 567 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 568 568 # put in front of it. If left blank `html' will be used as the default path. 569 569 570 HTML_OUTPUT = html570 HTML_OUTPUT = . 571 571 572 572 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 573 573 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank -
docs/dummy.c
1 int main (void) 2 { 3 return 0; 4 } 5 -
mythtv.pro
12 12 include ( settings.pro ) 13 13 14 14 # Directories 15 SUBDIRS += libs filters programs themes i18n 15 SUBDIRS += libs filters programs themes i18n docs 16 16 17 17 using_bindings_* { 18 18 SUBDIRS += bindings