mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-03 09:01:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
wayland/doc/publican/Makefile.am

170 lines
6.3 KiB
Text
Raw Normal View History

doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
# Documentation is built with xmlto, but some of the recipes in here are
# leftovers from building with Publican (https://fedorahosted.org/publican/)
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 <peter.hutterer@who-t.net>
2013-04-02 10:09:07 +10:00
#
# How this build works:
# * the main target is Wayland, documentation ends up in $(builddir)/Wayland/
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
# * hand-written chapters and CSS files are located in sources. These are
# copied into $(builddir)/en-US/
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 <peter.hutterer@who-t.net>
2013-04-02 10:09:07 +10:00
# * 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
doc: Make it easier to add a new doxygen page The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2014-12-16 19:23:03 -08:00
# * *API.xml is generated from the doxygen output and saved in
doc: generate server documentation from XML too Same as WaylandClientAPI.xml we now also generate WaylandServerAPI.xml for publication. Most of this hunk is just adding a client/ or server/ into the xml path to keep the two separate. The change in wayland.doxygen now causes a standard doxygen call to not generate anything - what is generated is specified through the options passed by make. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 11:28:58 +10:00
# $(builddir)/en-US
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
# * run xmlto on $(builddir)/en-US, output to $(builddir)/Wayland/en-US
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
doc: Switch from static image files to generated diagrams. Switches diagrams from using static PNG images to instead generate them via simple graphviz DOT markup files. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:04 -08:00
doxydir := $(top_builddir)/doc/doxygen
html_destdir := $(builddir)/Wayland/en-US/html
Hook up autotools for publican automake doesn't seem to provide a sensible method to install a directory of stuff in $(docdir). Do it manually then. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-24 09:42:05 +10:00
publican_sources = \
Rename en_US to sources The reason this directory exists is because we need to copy it into $builddir so we can combine it with generated sources (we can't pass multiple source paths into publican). So instead of having en_US, renamed to en-US stop the confusion and rename the sources to "sources". That gets copied to en-US which will then contain the actual output. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-03 15:02:29 -04:00
$(srcdir)/sources/Wayland.ent \
$(srcdir)/sources/Wayland.xml \
$(srcdir)/sources/Book_Info.xml \
$(srcdir)/sources/Author_Group.xml \
$(srcdir)/sources/Foreword.xml \
$(srcdir)/sources/Preface.xml \
$(srcdir)/sources/Revision_History.xml \
$(srcdir)/sources/Protocol.xml \
doc: start documenting Xwayland This is a rough intro to what Xwayland is and does, with just one implementation detail so far (Window identification). I paid no attention to formatting details, those can be polished in follow-ups. I just want the prose out. I also just quickly whacked up the diagram, would be happy to see someone replace it with a nicer one. I just didn't have time to learn dot for now. v2: - typo fix - rephrase "talking to hardware" as "driving the displays" - mention circular dependency in intro - add section to explain rootless and rootful modes - remove paragraph about Xwayland protocol usage - move TBD part to the end under a new section header v3: - use "advantage" and "disadvantage" instead of "pro" and "con" - slight rewording on rootful mode and rootless mode paragraphs - removed the paragraph about the lack of shell and special Wayland protocol extensions - removed the commented out list of ideas to write v4: - typo fixes pointed out by Yong Cc: Olivier Fourdan <ofourdan@redhat.com> Cc: Jonas Ådahl <jadahl@gmail.com> Cc: Daniel Stone <daniel@fooishbar.org> Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
2016-11-21 12:09:46 +02:00
$(srcdir)/sources/Xwayland.xml \
Rename en_US to sources The reason this directory exists is because we need to copy it into $builddir so we can combine it with generated sources (we can't pass multiple source paths into publican). So instead of having en_US, renamed to en-US stop the confusion and rename the sources to "sources". That gets copied to en-US which will then contain the actual output. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-03 15:02:29 -04:00
$(srcdir)/sources/Compositors.xml \
$(srcdir)/sources/images/icon.svg \
doc: Intro text for doxygen output in it's own file (This patch has been modified to apply atop current master) This makes it considerably easier to edit the text and make it different for each library. To address previous concerns with this patch, I wrote some more complete introductory text. This is based on my understanding of these libraries, which may not be correct, and is pretty rudimentary for libwayland-server! However this intro text demonstrates how to create links to the doxygen-generated text. It looks like you cannot link to methods easily as the link name contains a hash number, but links to objects and classes work. Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com> Tested-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 18:44:08 -08:00
$(srcdir)/sources/images/wayland.png \
doc: start documenting Xwayland This is a rough intro to what Xwayland is and does, with just one implementation detail so far (Window identification). I paid no attention to formatting details, those can be polished in follow-ups. I just want the prose out. I also just quickly whacked up the diagram, would be happy to see someone replace it with a nicer one. I just didn't have time to learn dot for now. v2: - typo fix - rephrase "talking to hardware" as "driving the displays" - mention circular dependency in intro - add section to explain rootless and rootful modes - remove paragraph about Xwayland protocol usage - move TBD part to the end under a new section header v3: - use "advantage" and "disadvantage" instead of "pro" and "con" - slight rewording on rootful mode and rootless mode paragraphs - removed the paragraph about the lack of shell and special Wayland protocol extensions - removed the commented out list of ideas to write v4: - typo fixes pointed out by Yong Cc: Olivier Fourdan <ofourdan@redhat.com> Cc: Jonas Ådahl <jadahl@gmail.com> Cc: Daniel Stone <daniel@fooishbar.org> Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
2016-11-21 12:09:46 +02:00
$(srcdir)/sources/images/xwayland-architecture.png \
doc: Intro text for doxygen output in it's own file (This patch has been modified to apply atop current master) This makes it considerably easier to edit the text and make it different for each library. To address previous concerns with this patch, I wrote some more complete introductory text. This is based on my understanding of these libraries, which may not be correct, and is pretty rudimentary for libwayland-server! However this intro text demonstrates how to create links to the doxygen-generated text. It looks like you cannot link to methods easily as the link name contains a hash number, but links to objects and classes work. Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com> Tested-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 18:44:08 -08:00
$(srcdir)/sources/Client.xml \
$(srcdir)/sources/Server.xml
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
doc: Create hot-linked areas in documents. Added xslt processing to give DocBook output diagram image maps/hot-linked areas consistent with those automatically generated by Doxygen. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:05 -08:00
processed_sources := \
$(srcdir)/sources/Architecture.xml \
$(srcdir)/sources/Introduction.xml
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
css_sources = \
$(srcdir)/sources/css/brand.css \
$(srcdir)/sources/css/common.css \
$(srcdir)/sources/css/default.css \
$(srcdir)/sources/css/epub.css \
$(srcdir)/sources/css/print.css
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
img_sources = \
$(srcdir)/sources/images/icon.svg \
doc: start documenting Xwayland This is a rough intro to what Xwayland is and does, with just one implementation detail so far (Window identification). I paid no attention to formatting details, those can be polished in follow-ups. I just want the prose out. I also just quickly whacked up the diagram, would be happy to see someone replace it with a nicer one. I just didn't have time to learn dot for now. v2: - typo fix - rephrase "talking to hardware" as "driving the displays" - mention circular dependency in intro - add section to explain rootless and rootful modes - remove paragraph about Xwayland protocol usage - move TBD part to the end under a new section header v3: - use "advantage" and "disadvantage" instead of "pro" and "con" - slight rewording on rootful mode and rootless mode paragraphs - removed the paragraph about the lack of shell and special Wayland protocol extensions - removed the commented out list of ideas to write v4: - typo fixes pointed out by Yong Cc: Olivier Fourdan <ofourdan@redhat.com> Cc: Jonas Ådahl <jadahl@gmail.com> Cc: Daniel Stone <daniel@fooishbar.org> Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
2016-11-21 12:09:46 +02:00
$(srcdir)/sources/images/wayland.png \
$(srcdir)/sources/images/xwayland-architecture.png
doc: Switch from static image files to generated diagrams. Switches diagrams from using static PNG images to instead generate them via simple graphviz DOT markup files. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:04 -08:00
doxygen_img_sources := \
$(doxydir)/xml/wayland-architecture.png \
$(doxydir)/xml/x-architecture.png
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
doc: Create hot-linked areas in documents. Added xslt processing to give DocBook output diagram image maps/hot-linked areas consistent with those automatically generated by Doxygen. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:05 -08:00
map_sources := \
$(doxydir)/xml/x-architecture.map \
$(doxydir)/xml/wayland-architecture.map
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
if HAVE_XMLTO
doc: Only generate Wayland documentation if xsltproc was found Instead of failing to generate documentation because xsltproc doesn't exist, don't try to generate at all. Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2012-12-01 17:33:22 +01:00
if HAVE_XSLTPROC
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
noinst_DATA = $(builddir)/Wayland $(publican_targets)
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
XMLTO_PARAM = \
doc: preserve links produced by Doxygen These links are pretty useful for navigation, though sometimes excessive (you can turn them off by putting % before the word in the comment). I had to turn off validation because it failed on missing and duplicate target id's, which this produces.
2014-11-11 18:42:56 -08:00
--skip-validation \
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
--stringparam chunk.section.depth=0 \
--stringparam toc.section.depth=1 \
--stringparam html.stylesheet=css/default.css
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
# Listing various directories that might need to be created.
alldirs := $(builddir)/en-US $(builddir)/en-US/images $(html_destdir) $(html_destdir)/css $(html_destdir)/images
html_css_targets = $(addprefix $(html_destdir)/css/,$(notdir $(css_sources)))
html_img_targets = $(addprefix $(html_destdir)/images/,$(notdir $(img_sources)))
doc: Switch from static image files to generated diagrams. Switches diagrams from using static PNG images to instead generate them via simple graphviz DOT markup files. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:04 -08:00
doxygen_img_targets := $(doxygen_img_sources:$(doxydir)/xml/%=$(html_destdir)/images/%)
doc: Create hot-linked areas in documents. Added xslt processing to give DocBook output diagram image maps/hot-linked areas consistent with those automatically generated by Doxygen. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:05 -08:00
map_targets := $(map_sources:$(doxydir)/xml/%=$(builddir)/en-US/images/%)
processed_targets := $(processed_sources:$(srcdir)/sources/%=$(builddir)/en-US/%)
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
doc: Create hot-linked areas in documents. Added xslt processing to give DocBook output diagram image maps/hot-linked areas consistent with those automatically generated by Doxygen. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:05 -08:00
$(builddir)/Wayland: $(publican_targets) $(html_css_targets) $(html_img_targets) $(processed_targets) $(doxygen_img_targets) | $(builddir)/en-US
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
$(AM_V_GEN)$(XMLTO) $(XMLTO_PARAM) html $(builddir)/en-US/Wayland.xml -o $(html_destdir)
@touch $@
$(html_destdir)/css/%: $(srcdir)/sources/css/% | $(html_destdir)/css
$(AM_V_GEN)cp -f $< $@
$(html_destdir)/images/%: $(srcdir)/sources/images/% | $(html_destdir)/images
$(AM_V_GEN)cp -f $< $@
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
doc: Switch from static image files to generated diagrams. Switches diagrams from using static PNG images to instead generate them via simple graphviz DOT markup files. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:04 -08:00
$(html_destdir)/images/%: $(doxydir)/xml/% | $(html_destdir)/images
$(AM_V_GEN)cp -f $< $@
Make distcheck work from builddir configured with --disable-documentation
2012-07-24 15:10:12 -04:00
pubdir = $(docdir)/Wayland/en-US
fixup doc: Make it easier to add a new doxygen page This supersedes the previous one and fixes a typo where a slash was missing. Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-16 19:52:10 -08:00
publican_targets = $(publican_sources:$(srcdir)/sources/%=$(builddir)/en-US/%) \
doc: Make it easier to add a new doxygen page The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2014-12-16 19:23:03 -08:00
$(builddir)/en-US/ProtocolSpec.xml \
$(builddir)/en-US/ProtocolInterfaces.xml \
$(builddir)/en-US/ClientAPI.xml \
$(builddir)/en-US/ServerAPI.xml
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
# The Protocol.xml is purely generated and required before running publican
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
$(builddir)/en-US/ProtocolSpec.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/protocol-to-docbook.xsl | $(builddir)/en-US
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
$(AM_V_GEN)$(XSLTPROC) $(srcdir)/protocol-to-docbook.xsl \
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
$(top_srcdir)/protocol/wayland.xml > $@
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
doc/publican/Makefile.am: Add a missing order-only prerequisite Otherwise a parallel make invocation could fail due to the directory not existing. Signed-off-by: Rui Matos <tiagomatos@gmail.com> Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-06 17:35:56 +01:00
$(builddir)/en-US/ProtocolInterfaces.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/protocol-interfaces-to-docbook.xsl | $(builddir)/en-US
doc: Auto-generate Protocol/Interfaces section instead Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-08 18:39:58 +03:00
$(AM_V_GEN)$(XSLTPROC) $(srcdir)/protocol-interfaces-to-docbook.xsl \
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
$(top_srcdir)/protocol/wayland.xml > $@
doc: Auto-generate Protocol/Interfaces section instead Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-08 18:39:58 +03:00
doc: clarify how ClientAPI.xml is built I found the comment a bit confusing and it's quite hard to read. re-explain with a simple step-by-step list Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-02 10:09:06 +10:00
# * use doxygen's combine.xslt to merge the xml files into one single file
doc: Make it easier to add a new doxygen page The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2014-12-16 19:23:03 -08:00
# * pipe that through the doxygen-to-publican stylesheet
$(builddir)/en-US/%API.xml: $(doxydir)/xml/%/index.xml $(srcdir)/doxygen-to-publican.xsl | $(builddir)/en-US
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
$(AM_V_GEN)$(XSLTPROC) $(doxydir)/xml/$*/combine.xslt \
doc: Make it easier to add a new doxygen page The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2014-12-16 19:23:03 -08:00
$(doxydir)/xml/$*/index.xml | \
$(XSLTPROC) --stringparam which $* \
$(srcdir)/doxygen-to-publican.xsl - > $@
doc: create a fake make target to de-duplicate the xml merging process The only difference between the server and client xml files is the directories and files being named *server* and *client*, respectively. Add a new make target to get that process done to avoid duplication Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 11:28:59 +10:00
Rename en_US to sources The reason this directory exists is because we need to copy it into $builddir so we can combine it with generated sources (we can't pass multiple source paths into publican). So instead of having en_US, renamed to en-US stop the confusion and rename the sources to "sources". That gets copied to en-US which will then contain the actual output. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-03 15:02:29 -04:00
# Copy the sources source files into en-US destination
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
# This is required for out-of-source-tree build as publican does not allow us
# to specify the location of the source code.
doc: Make it easier to add a new doxygen page The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2014-12-16 19:23:03 -08:00
$(builddir)/en-US/%: $(srcdir)/sources/% $(publican_sources) | $(builddir)/en-US/images
doc: Switch from static image files to generated diagrams. Switches diagrams from using static PNG images to instead generate them via simple graphviz DOT markup files. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:04 -08:00
$(AM_V_GEN)cp -f $< $@
$(AM_V_at)chmod a+w $@
$(builddir)/en-US/images/%: $(doxydir)/xml/% | $(builddir)/en-US/images
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
$(AM_V_GEN)cp -f $< $@
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
$(AM_V_at)chmod a+w $@
doc: Create hot-linked areas in documents. Added xslt processing to give DocBook output diagram image maps/hot-linked areas consistent with those automatically generated by Doxygen. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-01-28 17:24:05 -08:00
# More specific rule to override explicitly listed targets and perform xslt
# modifications on them.
# Note that we can't use $< as all targets must be there
$(processed_targets): $(processed_sources) $(map_targets) $(srcdir)/merge-mapcoords.xsl | $(builddir)/en-US/images
$(AM_V_GEN)$(XSLTPROC) --stringparam basedir $(builddir)/en-US \
$(srcdir)/merge-mapcoords.xsl $(addprefix $(srcdir)/sources/,$(notdir $@)) > $@
doc: General makefile cleanup. This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-12-09 01:34:22 -08:00
# general rule to create one of the listed directories.
$(alldirs):
$(AM_V_GEN)$(MKDIR_P) $@
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
doc: Make it easier to add a new doxygen page The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2014-12-16 19:23:03 -08:00
CLEANFILES = $(publican_targets)
Generate the docbook description for the protocol from wayland.xml Convert the wayland.xml protocol description to a docbook-compatible format and hook it up to the publican sources. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-24 17:31:51 +10:00
Hook up autotools for publican automake doesn't seem to provide a sensible method to install a directory of stuff in $(docdir). Do it manually then. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-24 09:42:05 +10:00
clean-local:
docs: Make distcheck happy publican doesn't seem to be a very well-behaved tool and needs a bit of hacking to work well for both in-tree and out-of-tree builds.
2012-10-15 20:48:12 -04:00
$(AM_V_at)rm -fr $(builddir)/en-US
$(AM_V_at)rm -fr $(builddir)/Wayland
Hook up autotools for publican automake doesn't seem to provide a sensible method to install a directory of stuff in $(docdir). Do it manually then. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-24 09:42:05 +10:00
install-data-local:
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
test -z "$(pubdir)/html/css" || $(mkdir_p) "$(DESTDIR)$(pubdir)/html/css"
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
test -z "$(pubdir)/html/images" || $(mkdir_p) "$(DESTDIR)$(pubdir)/html/images"
doc: replace publican with xmlto Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2014-09-04 17:32:10 +10:00
list=`find $(builddir)/Wayland/en-US -type f`; \
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
for p in $$list; do \
echo " $(INSTALL_DATA) '$$p' '$(DESTDIR)$(docdir)/$$p'"; \
$(INSTALL_DATA) "$$p" "$(DESTDIR)$(docdir)/$$p"; \
done;
Hook up autotools for publican automake doesn't seem to provide a sensible method to install a directory of stuff in $(docdir). Do it manually then. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-24 09:42:05 +10:00
uninstall-local:
publican: support out-of-source tree build When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-03 17:32:58 -05:00
@if test -n $(DESTDIR)$(docdir); then \
if test -d $(DESTDIR)$(docdir); then \
echo " rm -fr $(DESTDIR)$(docdir)/Wayland;"; \
rm -fr $(DESTDIR)$(docdir)/Wayland; \
fi; \
fi;
Hook up autotools for publican automake doesn't seem to provide a sensible method to install a directory of stuff in $(docdir). Do it manually then. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-24 09:42:05 +10:00
endif
doc: Only generate Wayland documentation if xsltproc was found Instead of failing to generate documentation because xsltproc doesn't exist, don't try to generate at all. Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2012-12-01 17:33:22 +01:00
endif
Make distcheck work from builddir configured with --disable-documentation
2012-07-24 15:10:12 -04:00
doc: Fix out-of-tree build and also distcheck Corrects an issue that would cause out-of-tree builds to fail and also a few items that would cause distcheck to fail. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2015-01-30 18:07:24 -08:00
EXTRA_DIST = \
$(publican_sources) $(processed_sources) $(css_sources) $(img_sources) \
protocol-to-docbook.xsl \
protocol-interfaces-to-docbook.xsl \
doxygen-to-publican.xsl \
merge-mapcoords.xsl
Reference in a new issue Copy permalink