Ticket #3798: mythtv_docs_v1.diff
File mythtv_docs_v1.diff, 7.6 KB (added by , 17 years ago) |
---|
-
mythtv/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-docbuild Builds the developer documentation" 67 68 #echo " --libdir=DIR install libs in DIR [PREFIX/lib]" 68 69 #echo " --shlibdir=DIR install shared libs in DIR [PREFIX/lib]" 69 70 #echo " --incdir=DIR install includes in DIR [PREFIX/include/ffmpeg]" … … 775 776 MYTHTV_CONFIG_LIST=' 776 777 backend 777 778 dbox2 779 dev_docbuild 778 780 directfb 779 781 directx 780 782 dvb … … 787 789 lirc 788 790 lmsensors 789 791 opengl_vsync 792 user_docbuild 790 793 v4l 791 794 valgrind 792 795 x11 … … 1022 1025 backend="no" 1023 1026 bindings_perl="yes" 1024 1027 dbox2="yes" 1028 dev_docbuild="no" 1025 1029 directfb="no" 1026 1030 directx="no" 1027 1031 dvb_path="/usr/include" … … 1042 1046 opengl_vsync="no" 1043 1047 proc_opt="no" 1044 1048 symbol_visibility="no" 1049 user_doc_build="no" 1045 1050 v4l="yes" 1046 1051 valgrind="no" 1047 1052 x11="yes" … … 1229 1234 ;; 1230 1235 --disable-ccache) ccache="no" 1231 1236 ;; 1237 --disable-dev-docbuild) dev_docbuild="no" 1238 ;; 1239 --enable-dev-docbuild) dev_docbuild="yes" 1240 doxygen --version > /dev/null 2>&1 1241 if test $? -ne 0 ; then 1242 dev_docbuild="no" 1243 echo "Doxygen unavailable, disabling dev-docs!" 1244 fi 1245 ;; 1246 --disable-user-docbuild) user_docbuild="no" 1247 ;; 1248 --enable-user-docbuild) user_docbuild="yes" 1249 which htmldoc > /dev/null 2>&1 1250 if test $? -ne 0 ; then 1251 user_docbuild="no" 1252 echo "*** htmldoc unavailable, disabling user-docbuild!" 1253 fi 1254 which linuxdoc > /dev/null 2>&1 1255 if test $? -ne 0 ; then 1256 user_docbuild="no" 1257 echo "*** linuxdoc unavailable, disabling user-docbuild!" 1258 fi 1259 ;; 1232 1260 --disable-distcc) distcc="no" 1233 1261 ;; 1234 1262 --enable-mingwce) wince="yes" … … 2969 2997 echo "# Misc Features" 2970 2998 echo "Frontend $frontend" 2971 2999 echo "Backend $backend" 3000 if test x"$user_docbuild" = x"yes"; then 3001 echo "Build user docs $user_docbuild" 3002 fi 3003 if test x"$dev_docbuild" = x"yes"; then 3004 echo "Build dev docs $dev_docbuild" 3005 fi 2972 3006 echo 2973 3007 2974 3008 echo "# Bindings" -
mythtv/docs/Makefile
2 2 # this means: linuxdoc-tools linuxdoc-tools-text htmldoc 3 3 # 4 4 # - mdz 5 include ../config.mak 5 6 6 TARGETS = mythtv-HOWTO.txt mythtv-HOWTO.html mythtv-HOWTO-singlehtml.html mythtv-HOWTO.pdf index.html 7 LINUXDOC_HTML_SPLIT := 1 7 # Doc install dir 8 INSTALLDIR = $(PREFIX)/share/doc/mythtv 8 9 10 # User Docs 11 USER_TARGETS = index.html mythtv-HOWTO.pdf mythtv-HOWTO.txt 12 USER_INSTALL = $(USER_TARGETS) mythtv-HOWTO-[0-9]*.html *.png 13 USER_CLEAN = index.html mythtv-HOWTO.pdf mythtv-HOWTO.txt mythtv-HOWTO*.html 14 15 # Developer Docs 16 DEV_TARGETS = doxygen-dev-docs 17 DEV_INSTALL = doxygen-dev-docs 18 DEV_CLEAN = doxygen-dev-docs doxygen-warnings.txt 19 20 # Don't clean or build user docs 21 # unless configured with --enable-user-docbuild 22 INSTALL += $(USER_INSTALL) 23 ifeq ($(CONFIG_USER_DOCBUILD),yes) 24 TARGETS += $(USER_TARGETS) 25 CLEAN += $(USER_CLEAN) 26 endif 27 28 # Don't clean, build or install dev docs 29 # unless configured with --enable-dev-docbuild 30 ifeq ($(CONFIG_DEV_DOCBUILD),yes) 31 TARGETS += $(DEV_TARGETS) 32 INSTALL += $(DEV_INSTALL) 33 CLEAN += $(DEV_CLEAN) 34 endif 35 36 37 .PHONY: all userdocs devdocs \ 38 install install_userdocs install_devsdocs \ 39 uninstall uninstall_userdocs uninstall_devdocs \ 40 clean clean_userdocs clean_devdocs distclean 41 42 .DEFAULT: 43 @echo Suppressing error caused by missing target: \"$@\" 44 9 45 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 46 47 userdocs: $(USER_TARGETS) 48 49 devdocs: $(DEV_TARGETS) 50 51 install: all 52 mkdir -p $(INSTALLDIR) 53 $(foreach f,$(INSTALL),\ 54 find . -maxdepth 1 -name '$(f)' -exec cp -Rf {} $(INSTALLDIR) \;; ) 55 56 install_userdocs: $(USER_TARGETS) 57 mkdir -p $(INSTALLDIR) 58 $(foreach f,$(USER_INSTALL),\ 59 find . -maxdepth 1 -name '$(f)' -exec cp -Rf {} $(INSTALLDIR) \;; ) 60 61 install_devdocs: $(DEV_TARGETS) 62 mkdir -p $(INSTALLDIR) 63 $(foreach f,$(DEV_INSTALL),\ 64 find . -maxdepth 1 -name '$(f)' -exec cp -Rf {} $(INSTALLDIR) \;; ) 65 66 uninstall: 67 -$(foreach f,$(INSTALL),\ 68 find $(INSTALLDIR) -maxdepth 1 -name '$(f)' -exec rm -Rf {} \;; ) 69 -rmdir $(INSTALLDIR) 70 71 uninstall_userdocs: 72 -$(foreach f,$(USER_INSTALL),\ 73 find $(INSTALLDIR) -maxdepth 1 -name '$(f)' -exec rm -Rf {} \;; ) 74 -rmdir $(INSTALLDIR) 75 76 uninstall_devdocs: 77 -$(foreach f,$(DEV_INSTALL),\ 78 find $(INSTALLDIR) -maxdepth 1 -name '$(f)' -exec rm -Rf {} \;; ) 79 -rmdir $(INSTALLDIR) 80 14 81 distclean: clean 82 clean: 83 $(foreach f,$(CLEAN),\ 84 find . -maxdepth 1 -name '$(f)' -exec rm -Rf {} \;; ) 15 85 16 validate: mythtv-HOWTO.sgml 17 linuxdoc -B check $< 86 clean_userdocs: 87 $(foreach f,$(USER_CLEAN),\ 88 find . -maxdepth 1 -name '$(f)' -exec rm -Rf {} \;; ) 18 89 19 %.txt: %.sgml 20 linuxdoc -B txt $< 90 clean_devdocs: 91 $(foreach f,$(DEV_CLEAN),\ 92 find . -maxdepth 1 -name '$(f)' -exec rm -Rf {} \;; ) 21 93 22 # Generate PDF via LaTeX using linuxdoc23 # %.pdf: %.sgml24 # linuxdoc -B latex -o pdf $<94 # 95 ################################################################################ 96 # 25 97 26 # Generate PDF via HTML using htmldoc 27 %.pdf: %-singlehtml.html 28 # htmldoc exits unsuccessfully for no good reason -mdz 29 htmldoc --book --quiet --outfile $@ $< || true 98 doxygen-dev-docs: 99 doxygen doxygen-create-developer-docs.cfg 30 100 31 %.html: %.sgml32 linuxdoc -B html --split=$(LINUXDOC_HTML_SPLIT) --toc=2$<101 validate: mythtv-HOWTO.sgml 102 linuxdoc -B check $< 33 103 34 %-singlehtml.html: LINUXDOC_HTML_SPLIT=0 35 %-singlehtml.sgml: %.sgml 36 cp $< $@ 104 mythtv-HOWTO.txt: mythtv-HOWTO.sgml 105 linuxdoc -B txt $< 37 106 38 index.html: mythtv-HOWTO.html39 cp $< $@ 107 mythtv-HOWTO.pdf: mythtv-HOWTO-singlehtml.html 108 -htmldoc --book --quiet --outfile $@ $< 40 109 41 devdocs: 42 doxygen doxygen-create-developer-docs.cfg 110 index.html: mythtv-HOWTO.sgml 111 linuxdoc -B html --split=1 --toc=2 $< 112 mv $(patsubst %.sgml, %.html, $<) $@ 113 114 mythtv-HOWTO-singlehtml.html: mythtv-HOWTO.sgml 115 linuxdoc -B html --split=0 --toc=2 $< 116 mv $(patsubst %.sgml, %.html, $<) $@ -
mythtv/docs/doxygen-create-developer-docs.cfg
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 -
mythtv/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