BIND 10 #1687: remove generated docs, manual pages from the git repo

BIND 10 Development do-not-reply at isc.org
Fri Aug 3 02:02:01 UTC 2012


#1687: remove generated docs, manual pages from the git repo
-------------------------------------+-------------------------------------
                   Reporter:  jreed  |                 Owner:  UnAssigned
                       Type:  task   |                Status:  reviewing
                   Priority:         |             Milestone:  Non-
  medium                             |  Development-2012Q3
                  Component:  build  |            Resolution:
  system                             |             Sensitive:  0
                   Keywords:         |           Sub-Project:  Core
            Defect Severity:  N/A    |  Estimated Difficulty:  0
Feature Depending on Ticket:         |           Total Hours:  0
        Add Hours to Ticket:  0      |
                  Internal?:  0      |
-------------------------------------+-------------------------------------
Changes (by jreed):

 * owner:  jreed => UnAssigned
 * status:  accepted => reviewing


Comment:

 This branch is ready for review.  The main changes include:

 - all generated docs removed from git repo; also the bind10-messages.xml
 is removed from the repo.

 - removed --enable-man configure option and replaced it with --enable-
 generate-docs

 - by default it will create dummy doc files and they will be installed

 - if --enable-generate-docs is used with configure then it will check to
 make sure some of xsltproc and stylesheets are there and the docs will be
 generated.

 - currently if the dummy docs exist, they will not be replaced
 automatically. There are warnings about this.

 - the dist tarball should contain the generated docs.

 This idea was based on configure/makefile ideas from the pango project.

 Note that the default install from git checkout will cause all dummy docs
 to be installed.

 Some points to consider are (maybe for new tickets):

 - to have it auto-detect working doxygen with correct stylesheets and
 enable the documentation generation if they are available.

 - if enable-generate-docs is used, then remove the dummy docs (if they are
 fake).

 - make sure that dist or distcheck build enables this and makes sure dummy
 files aren't placed in dist tarball.

 - Note that the html generation is done using elinks. It was already like
 that before. But that should be checked in configure too. I will handle
 that separately in maybe a different ticket.

-- 
Ticket URL: <http://bind10.isc.org/ticket/1687#comment:6>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development


More information about the bind10-tickets mailing list