1 # this snippet is to be included by both our docbook manuals
2 # and gtk-doc API references
4 # it adds an upload target to each of these dir's Makefiles
6 # each Makefile.am should define the following variables:
7 # - DOC: the base name of the documentation
8 # (faq, manual, pwg, gstreamer, gstreamer-libs)
9 # - FORMATS: the formats in which DOC is output
12 # if you want to use it, make sure your $HOME/.ssh/config file contains the
13 # correct User entry for the Host entry for the DOC_SERVER
15 # these variables define the location of the online docs
16 DOC_SERVER = gstreamer.freedesktop.org
17 DOC_BASE = /srv/gstreamer.freedesktop.org/www/data/doc
18 DOC_URL = $(DOC_SERVER):$(DOC_BASE)
21 @if echo $(FORMATS) | grep html > /dev/null; then \
22 echo "Preparing docs for upload (rebasing cross-references) ..." ; \
23 if test x$(builddir) != x$(srcdir); then \
24 echo "make upload can only be used if srcdir == builddir"; \
27 # gtkdoc-rebase sometimes gets confused, so reset everything to \
28 # local links before rebasing to online links \
29 gtkdoc-rebase --html-dir=$(builddir)/html 2>/dev/null 2>/dev/null ; \
30 rebase=`gtkdoc-rebase --verbose --online --html-dir=$(builddir)/html` ; \
31 echo "$$rebase" | grep -e "On-*line"; \
32 for req in glib gobject gstreamer gstreamer-libs gst-plugins-base-libs; do \
33 if ! ( echo "$$rebase" | grep -i -e "On-*line.*/$$req/" ); then \
34 echo "===============================================================================" ; \
35 echo " Could not determine online location for $$req docs. Cross-referencing will be " ; \
36 echo " broken, so not uploading. Make sure the library's gtk-doc documentation is " ; \
37 echo " installed somewhere in /usr/share/gtk-doc. " ; \
38 echo "===============================================================================" ; \
42 export SRC="$$SRC html"; \
44 if echo $(FORMATS) | grep ps > /dev/null; then export SRC="$$SRC $(DOC).ps"; fi; \
45 if echo $(FORMATS) | grep pdf > /dev/null; then export SRC="$$SRC $(DOC).pdf"; fi; \
47 # upload releases to both 0.10.X/ and head/ subdirectories \
48 if test "x$(PACKAGE_VERSION_NANO)" = x0; then \
49 export DIR=$(DOC_BASE)/gstreamer/$(VERSION)/$(DOC); \
50 echo Uploading $$SRC to $(DOC_SERVER):$$DIR; \
51 ssh $(DOC_SERVER) mkdir -p $$DIR; \
52 rsync -rv -e ssh --delete $$SRC $(DOC_SERVER):$$DIR; \
53 ssh $(DOC_SERVER) chmod -R g+w $$DIR; \
56 export DIR=$(DOC_BASE)/gstreamer/head/$(DOC); \
57 echo Uploading $$SRC to $(DOC_SERVER):$$DIR; \
58 ssh $(DOC_SERVER) mkdir -p $$DIR; \
59 rsync -rv -e ssh --delete $$SRC $(DOC_SERVER):$$DIR; \
60 ssh $(DOC_SERVER) chmod -R g+w $$DIR; \
62 if echo $(FORMATS) | grep html > /dev/null; then \
63 echo "Un-preparing docs for upload (rebasing cross-references) ..." ; \
64 gtkdoc-rebase --html-dir=$(builddir)/html ; \