Bug 222826

Summary:	handling of dependencies in doc build
Product:	Documentation	Reporter:	Wolfram Schneider <wosch>
Component:	Books & Articles	Assignee:	Wolfram Schneider <wosch>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any

Description Wolfram Schneider freebsd_committer

2017-10-06 13:17:12 UTC

We need a better way of handling dependencies in the doc build. It should be run automatically.


the proposed solution:

By default, the makefiles will check for dependencies of *.xml include files. If you do not like that or the build fails then you can disable this with  

DOCBOOK_DEPS_DISABLE=YES

in the ./Makefile

If you want add dependencies explicitly, you can do this with

DOCBOOK_DEPS= ./some-file

and any change of "some-file" will force a rebuild of the document.

There are definitions of include files which does not exists (e.g. uses.xml, versions.xml) In that case we print a warning and ignore it. This affects mostly translated documents.

Comment 1 commit-hook freebsd_committer

2017-10-06 14:09:17 UTC

A commit references this bug:

Author: wosch
Date: Fri Oct  6 14:08:46 UTC 2017
New revision: 51066
URL: https://svnweb.freebsd.org/changeset/doc/51066

Log:
  <doc.docbook-dep.mk> handles implicit dependencies of DocBook documentation

  This feature can be disabled with DOCBOOK_DEPS_DISABLE=YES

  Missing dependencies will be reported as a warning, and should
  be fixed by the document authors.

  PR: 222826

Changes:
  head/de_DE.ISO8859-1/books/fdp-primer/Makefile
  head/en_US.ISO8859-1/articles/freebsd-releng/Makefile
  head/share/mk/doc.docbook-dep.mk
  head/share/mk/doc.project.mk
  head/zh_TW.UTF-8/books/fdp-primer/Makefile
  head/zh_TW.UTF-8/books/handbook/Makefile