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/Wayland/Makefile.am

91 lines
4 KiB
Text
Raw Normal View History

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 = \
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
$(srcdir)/en_US/Wayland.ent \
$(srcdir)/en_US/Architecture.xml \
$(srcdir)/en_US/Author_Group.xml \
$(srcdir)/en_US/Book_Info.xml \
$(srcdir)/en_US/Wayland.xml \
doc: rename Procotol to ProtocolSpec and WaylandProtocol to Protocol The former is the actual specification, the latter notes about the protocol. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-29 10:50:12 +10:00
$(srcdir)/en_US/Protocol.xml \
doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
$(srcdir)/en_US/Library.xml \
doc: move documentation from the tex file to docbook And remove the .tex file Minor changes: - where the .tex file had some interface descriptions, the docbook source now links to the actual protocol. The exception here is the shared object cache which is simply a <programlisting> until the protocol spec exists. - "Implementation" section skipped, this seems in need of an update anyway and may be better documented elsewhere (wiki?) Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-29 10:50:10 +10:00
$(srcdir)/en_US/Compositors.xml \
$(srcdir)/en_US/Overview.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
$(srcdir)/en_US/images/icon.svg \
$(srcdir)/en_US/images/wayland-architecture.png \
$(srcdir)/en_US/images/wayland.png \
$(srcdir)/en_US/images/x-architecture.png
Make distcheck work from builddir configured with --disable-documentation
2012-07-24 15:10:12 -04:00
if HAVE_PUBLICAN
noinst_DATA = Wayland $(publican_targets)
pubdir = $(docdir)/Wayland/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
publican_targets = $(publican_sources:$(srcdir)/en_US%=$(builddir)/en-US%) \
doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
en-US/ProtocolSpec.xml en-US/ProtocolInterfaces.xml \
en-US/WaylandClientAPI.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: rename Procotol to ProtocolSpec and WaylandProtocol to Protocol The former is the actual specification, the latter notes about the protocol. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-29 10:50:12 +10:00
en-US/ProtocolSpec.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/protocol-to-docbook.xsl
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)$(MKDIR_P) en-US/images
$(AM_V_GEN)$(XSLTPROC) $(srcdir)/protocol-to-docbook.xsl \
doc: rename Procotol to ProtocolSpec and WaylandProtocol to Protocol The former is the actual specification, the latter notes about the protocol. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-29 10:50:12 +10:00
$(top_srcdir)/protocol/wayland.xml > en-US/ProtocolSpec.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: Auto-generate Protocol/Interfaces section instead Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-08 18:39:58 +03:00
en-US/ProtocolInterfaces.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/protocol-interfaces-to-docbook.xsl
$(AM_V_GEN)$(MKDIR_P) en-US/images
$(AM_V_GEN)$(XSLTPROC) $(srcdir)/protocol-interfaces-to-docbook.xsl \
$(top_srcdir)/protocol/wayland.xml > en-US/ProtocolInterfaces.xml
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
en-US/WaylandClientAPI.xml: $(top_builddir)/doc/doxygen/xml/wayland-client_8h.xml $(srcdir)/doxygen-to-publican.xsl
doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
$(AM_V_GEN)$(MKDIR_P) en-US/images
$(AM_V_GEN)$(XSLTPROC) $(srcdir)/doxygen-to-publican.xsl \
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
$(top_builddir)/doc/doxygen/xml/wayland-client_8h.xml > en-US/WaylandClientAPI.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
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
# Copy the en_US source files into en-US destination
# This is required for out-of-source-tree build as publican does not allow us
# to specify the location of the source code.
doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
$(builddir)/en-US/%: $(srcdir)/en_US/% en-US/ProtocolSpec.xml en-US/ProtocolInterfaces.xml en-US/WaylandClientAPI.xml $(publican_sources)
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 $< $@
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_GEN)chmod a+w $@
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
# Run publican for the builddir on the generated (or copied) source
doc: publican: Automate version generation It seems reasonable to use protocol's version for the documentation as well. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:07 +03:00
# The output formats are generated in the Wayland sub directory. Also, we need
# to use a tmp publican.cfg cause 'publican rename' modifies the original.
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
Wayland: $(publican_targets)
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_GEN)cp -f $(srcdir)/publican.cfg $(builddir)/publican-copy.cfg
doc: publican: Automate version generation It seems reasonable to use protocol's version for the documentation as well. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:07 +03:00
$(AM_V_GEN)$(PUBLICAN) rename --name Wayland \
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
--version "$(WAYLAND_VERSION_MAJOR).$(WAYLAND_VERSION_MINOR)" \
--config $(builddir)/publican-copy.cfg
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)$(PUBLICAN) build --lang en-US --format html,pdf \
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
--config $(builddir)/publican-copy.cfg
docs: Touch ouput dir Wayland to update timestamp Prevents rebuild every time.
2012-03-29 14:11:16 -04:00
@touch Wayland
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: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
CLEANFILES = en-US/ProtocolSpec.xml en-US/ProtocolInterfaces.xml en-US/WaylandClientAPI.xml $(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
$(AM_V_at)rm -fr $(builddir)/publican-copy.cfg
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:
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/Common_Content/css" || $(mkdir_p) "$(DESTDIR)$(pubdir)/html/Common_Content/css"
test -z "$(pubdir)/html/Common_Content/images" || $(mkdir_p) "$(DESTDIR)$(pubdir)/html/Common_Content/images"
test -z "$(pubdir)/html/images" || $(mkdir_p) "$(DESTDIR)$(pubdir)/html/images"
test -z "$(pubdir)/pdf" || $(mkdir_p) "$(DESTDIR)$(pubdir)/pdf"
test -z "$(pubdir)/xml/Common_Content/css" || $(mkdir_p) "$(DESTDIR)$(pubdir)/xml/Common_Content/css"
test -z "$(pubdir)/xml/Common_Content/images" || $(mkdir_p) "$(DESTDIR)$(pubdir)/xml/Common_Content/images"
test -z "$(pubdir)/xml/images" || $(mkdir_p) "$(DESTDIR)$(pubdir)/xml/images"
doc: Don't list directories in list of files to install The find expression was listing the xml_tmp directory, because it matched the -prune rule.
2012-03-16 09:26:05 -04:00
list=`find $(builddir)/Wayland/en-US -type f -not -path '$(builddir)/Wayland/en-US/xml_tmp*'`; \
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
Make distcheck work from builddir configured with --disable-documentation
2012-07-24 15:10:12 -04:00
doc: Add auto-generated Wayland Library chapter For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-11 17:42:09 +03:00
EXTRA_DIST = $(publican_sources) publican.cfg protocol-to-docbook.xsl protocol-interfaces-to-docbook.xsl doxygen-to-publican.xsl
Reference in a new issue Copy permalink