From 3cf8e67731ab3a4ba84345c89f67b1a99b196735 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Tue, 2 Apr 2013 10:09:07 +1000 Subject: [PATCH] doc: explain the publican build process This makefile is a bit hard to read due to some publican requirements and the need to generate some files through XSLT. Explain the lot, so that those looking at this roughly know what will hit them. Signed-off-by: Peter Hutterer --- doc/Wayland/Makefile.am | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/Wayland/Makefile.am b/doc/Wayland/Makefile.am index 2e4075f..f8f03da 100644 --- a/doc/Wayland/Makefile.am +++ b/doc/Wayland/Makefile.am @@ -1,3 +1,20 @@ +# Documentation is built with publican +# https://fedorahosted.org/publican/ +# Publican takes docbook-style input files and compiles them to various +# output formats. +# +# How this build works: +# * the main target is Wayland, documentation ends up in $(builddir)/Wayland/ +# * hand-written chapters are located in en_US +# Publican does not take a source path, so to support out-of-tree builds +# these are copied to $(builddir)/en-US which is the actual directory +# Publican uses. +# * ProtocolSpec.xml is generated from $(top_srcdir)/protocol/wayland.xml, +# changed into docbook via XSLT and saved in $(builddir)/en-US/ +# * ProtocolInterfaces.xml, same as above, uses a different XSLT +# * WaylandClientAPI.xml is generated from the doxygen output and saved in +# $(builddir)/en-US +# * run Publican on en-US publican_sources = \ $(srcdir)/en_US/Wayland.ent \ $(srcdir)/en_US/Wayland.xml \ -- 2.7.4