summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorGaetan Nadon <memsize@videotron.ca>2011-06-05 14:01:20 -0400
committerGaetan Nadon <memsize@videotron.ca>2011-06-11 17:28:02 -0400
commit1c4537d44ca85d9f6c0c102983a1732d734858ee (patch)
treeb43f365ce471b7a3ef78bb6764dad6e2a360ea1f /README
parentf9a896a91c43c8c61b8b452cc81f7bc9f77b91c2 (diff)
Masterdb: read the target dbs from the usual doc directory
This is a coordinated change with the packages building DocBook/XML. The target dbs are now installed alongside the generated documents. Currently they are installed in $prefix/sgml/X11/dbs alongside masterdb which has the potential of installing outside the package prefix and cause distcheck to fail when user does not have write permission in this package. The master db xi:include statement is changed. It uses a fully qualified path but could also have used a relative path although it is difficult to ensure it would work reliably. The generated html/pdf link are still relative. The README elaborates on requirements which previously existed but were not introduced by this patch. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Diffstat (limited to 'README')
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index 07e760b..e057938 100644
--- a/README
+++ b/README
@@ -64,6 +64,13 @@ configure option. For external references to work, it is assumed that
the each package installs the documentation using the relative
doc/${PACKAGE_TARNAME} location.
+It is also a requirement that all packages containing DocBook/XML documentation
+be installed under the same read-only architecture independent installation
+directory as evidenced by the DATAROOTDIR package value. This value should also
+be the same for the xorg-sgml-doctools package. The purpose of this requirement
+is to form a document tree of a known structure such that stylesheets,
+masterdb, target dbs and other files can be reached.
+
The Docbook stylesheet technology will create references with paths relative
to this location. It will navigate up to "doc" using ../ and then navigate
down to the document it refers to.