[mythtv-commits] Ticket #3798: Install user documentation during normal installation

[MythTV]

#3798: Install user documentation during normal installation
--------------------------------------+-------------------------------------
 Reporter:  Roo <roo.watt at gmail.com>  |       Owner:  ijr 
     Type:  enhancement               |      Status:  new 
 Priority:  minor                     |   Milestone:  0.21
Component:  mythtv                    |     Version:  head
 Severity:  medium                    |     Mlocked:  0   
--------------------------------------+-------------------------------------
 Attached is a patch to install the documentation in mythtv/docs during a
 normal install.

 There are two new configure pairs:
  * --enable-user-docbuild, --disable-user-docbuild
  * --enable-dev-docbuild, --disable-dev-docbuild

 '''Install Dir:'''
  * The install dir is $(PREFIX)/share/doc/mythtv

 '''User Docs:'''
  * User documentation is under version control and exists in a fresh
 checkout.
  * User docs will always be installed
  * A make clean will not normally remove the prebuilt user docs
  * If the --enable-user-docbuild is spec'd (and the prereqs are available)
 the user docs will be built during a "make install" and cleaned during a
 "make clean"

 '''Dev Docs:'''
  * The dev docs are built and installed if --enable-dev-docbuild is spec'd
  * Even if --enable-dev-docbuild is not spec'd at configure the dev-docs
 can be built and installed later with a "make devdocs && make
 install_devdocs"

 There are other make targets to be able to install/uninstall/clean the dev
 or user docs without the need to reconfigure the entire myth project.

 Please let me know if any changes need to be made.

 Roo.

 PS: This is not in the form of a qmake docs.pro as qmake sucks for this
 doco type setup, spent some time on the #qt channel but it is buggy when
 using the custom objects.

-- 
Ticket URL: <http://svn.mythtv.org/trac/ticket/3798>
MythTV <http://svn.mythtv.org/trac>
MythTV