Opened 7 years ago

Last modified 4 years ago

#2779 new task

distclean and removal of docs from release tarball

Reported by: jreed Owned by:
Priority: medium Milestone: Outstanding Tasks
Component: documentation Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: Core Feature Depending on Ticket:
Estimated Difficulty: 4 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description

We ship the generated docs (guide, messages manual, manpages) in the tarball because we don't want to require more build dependencies (such as xsltproc, docbook stylesheets, html-to-text renderer, etc).

Currently DISTCLEANFILES is used for the generated docs. A "distclean" causes them to be lost so then a new make will (by default) will generate dummy docs.

My initial suggestion is to use MAINTAINERCLEANFILES so they are only removed on "make maintainer-clean".

But later need to discuss better idea for generating these. Some ideas:

  • include the generated files back in the GIT repo; and require they are built/committed using a consistent setup.
  • require many new dependencies and don't build dummy docs.
  • use some more common format, like use some ROFF instead of docbook for guide and messages manual since the toolchain for this is generally already installed on all systems. Or some other simple plain-text markup language and provide simple python-tool in the repo to generate docs using it.

Subtickets

Change History (4)

comment:1 Changed 7 years ago by shane

  • Milestone New Tasks deleted
  • Type changed from defect to task

Adding to topics for next team call.

comment:2 Changed 5 years ago by tomek

  • Milestone set to Remaining BIND10 tickets

comment:3 Changed 4 years ago by tomek

  • Milestone changed from Remaining BIND10 tickets to DHCP Outstanding Tasks

As part of bug scrubbing during Kea 1.0, we decided to move a number of tickets to DHCP Outstanding.

comment:4 Changed 4 years ago by tomek

  • Milestone changed from DHCP Outstanding Tasks to Outstanding Tasks

Milestone renamed

Note: See TracTickets for help on using tickets.