mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-26 03:31:05 +00:00
make upload work for both gtk-doc and docbook docs
Original commit message from CVS: make upload work for both gtk-doc and docbook docs
This commit is contained in:
Thomas Vander Stichele
parent
f2582fb3a2
commit
1ad4c7a804
13 changed files with 111 additions and 37 deletions
17
ChangeLog
17
ChangeLog
|
|
@ -1,3 +1,20 @@
|
|||
2004-01-28 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||
|
||||
* docs/HACKING:
|
||||
* docs/Makefile.am:
|
||||
* docs/faq/Makefile.am:
|
||||
* docs/gst/Makefile.am:
|
||||
* docs/gst/tmpl/gstelement.sgml:
|
||||
* docs/gst/tmpl/gstplugin.sgml:
|
||||
* docs/gst/tmpl/gstreamer-unused.sgml:
|
||||
* docs/libs/Makefile.am:
|
||||
* docs/manual/Makefile.am:
|
||||
* docs/manuals.mak:
|
||||
* docs/pwg/Makefile.am:
|
||||
* docs/upload.mak:
|
||||
Separate out upload target and make it similar for
|
||||
both docbook and gtk-doc docs
|
||||
|
||||
2004-01-28 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||
|
||||
* docs/manuals.mak:
|
||||
|
|
|
|||
18
docs/HACKING
18
docs/HACKING
|
|
@ -1,3 +1,21 @@
|
|||
UPDATING ONLINE DOCS
|
||||
--------------------
|
||||
This is pretty simple.
|
||||
Make sure that you
|
||||
a) have a working freedesktop.org account
|
||||
b) $HOME/.ssh/config set up so that it has the right User for the Host
|
||||
(for example, I have:
|
||||
Host freedesktop.org
|
||||
User thomasvs
|
||||
c) verify this works by doing ssh freedesktop.org and being logged in without
|
||||
a password prompt
|
||||
|
||||
Then, after updating any of the docs, run "make upload" from that directory.
|
||||
Or, run "make upload" from this (docs) directory.
|
||||
|
||||
DOCS NOTES
|
||||
----------
|
||||
|
||||
OK, I've grown so tired of having to coax the docs to build every time I
|
||||
get round to it that I've decided to note down some of the things that
|
||||
are important to know.
|
||||
|
|
|
|||
|
|
@ -15,11 +15,11 @@ SUBDIRS = $(SUBDIRS_DOCS) $(SUBDIRS_PLUGINS)
|
|||
DIST_SUBDIRS = gst faq manual pwg libs plugins xsl
|
||||
|
||||
EXTRA_DIST = \
|
||||
slides manuals.mak htmlinstall.mak \
|
||||
slides manuals.mak htmlinstall.mak upload.mak \
|
||||
image-png image-pdf image-eps version.entities.in
|
||||
|
||||
upload:
|
||||
@for a in manual faq pwg; do cd $$a; make upload; cd ..; done
|
||||
@if test "x$(SUBDIRS_DOCS)" != x; then for a in $(SUBDIRS_DOCS); do cd $$a; make upload; cd ..; done; fi
|
||||
|
||||
dist-hook:
|
||||
$(RM) -rf $(distdir)/random/CVS
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
# base name of doc
|
||||
DOC = faq
|
||||
# formats defined for upload.mak
|
||||
FORMATS=html ps pdf
|
||||
|
||||
# main xml file
|
||||
MAIN = $(DOC).xml
|
||||
|
|
@ -18,6 +20,8 @@ FIG_SRC = $(notdir $(wildcard $(srcdir)/*.fig))
|
|||
|
||||
# get the generic docbuilding Makefile stuff
|
||||
include $(srcdir)/../manuals.mak
|
||||
# get the generic upload target
|
||||
include $(srcdir)/../upload.mak
|
||||
|
||||
### this is standard automake stuff
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,12 @@
|
|||
# DOC_MODULE=gstreamer-@GST_MAJORMINOR@
|
||||
DOC_MODULE=gstreamer
|
||||
|
||||
# for upload.mak
|
||||
DOC=gstreamer
|
||||
FORMATS=html
|
||||
html: html-build.stamp
|
||||
sinclude $(srcdir)/../upload.mak
|
||||
|
||||
# generated basefiles
|
||||
#basefiles = \
|
||||
# gstreamer-@GST_MAJORMINOR@.types \
|
||||
|
|
|
|||
|
|
@ -990,6 +990,8 @@ Is triggered whenever an error occured.
|
|||
@:
|
||||
@:
|
||||
@:
|
||||
@:
|
||||
@:
|
||||
|
||||
<!-- ##### SIGNAL GstElement::found-tag ##### -->
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -101,15 +101,6 @@ loaded will use this variable to initialize the plugin.
|
|||
@origin:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_set_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_name ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -119,15 +110,6 @@ loaded will use this variable to initialize the plugin.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_longname ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_filename ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -9634,6 +9634,14 @@ Destroys the pipeline.
|
|||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_longname ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_type_list ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -9725,6 +9733,14 @@ Destroys the pipeline.
|
|||
@plugin:
|
||||
@longname:
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_set_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@name:
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_unload_all ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,12 @@
|
|||
#DOC_MODULE=gstreamer-libs-@GST_MAJORMINOR@
|
||||
DOC_MODULE=gstreamer-libs
|
||||
|
||||
# for upload.mak
|
||||
DOC=gstreamer-libs
|
||||
FORMATS=html
|
||||
html: html-build.stamp
|
||||
sinclude $(srcdir)/../upload.mak
|
||||
|
||||
# generated basefiles
|
||||
#basefiles = \
|
||||
## $(DOC_MODULE).types \
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
# base name of doc
|
||||
DOC = manual
|
||||
# formats defined for upload.mak
|
||||
FORMATS=html ps pdf
|
||||
|
||||
# main xml file
|
||||
MAIN = $(DOC).xml
|
||||
|
|
@ -18,6 +20,8 @@ FIG_SRC = $(notdir $(wildcard $(srcdir)/*.fig))
|
|||
|
||||
# get the generic docbuilding Makefile stuff
|
||||
include $(srcdir)/../manuals.mak
|
||||
# get the generic upload target
|
||||
include $(srcdir)/../upload.mak
|
||||
|
||||
### this is standard automake stuff
|
||||
|
||||
|
|
|
|||
|
|
@ -168,20 +168,3 @@ $(BUILDIMAGESDIR)/%.ps: %.png
|
|||
check-local: $(BUILDDIR)/$(MAIN)
|
||||
@cp -f $(srcdir)/../image-png $(BUILDDIR)/image.entities
|
||||
cd $(BUILDDIR) && xmllint -noout -valid $(MAIN)
|
||||
|
||||
### this is a website upload target
|
||||
### if you want to use it, make sure your ..sh/config file contains the
|
||||
### correct User entry for the Host entry for the DOC_SERVER
|
||||
DOC_SERVER=freedesktop.org
|
||||
DOC_BASE=/home/projects/gstreamer/www/data/doc
|
||||
DOC_URL=$(DOC_SERVER):$(DOC_BASE)
|
||||
|
||||
upload: html ps pdf
|
||||
@if test "x$$GST_PLUGINS_VERSION_NANO" = x0; then \
|
||||
export DOCVERSION=$(VERSION); \
|
||||
else export DOCVERSION=head; \
|
||||
fi; \
|
||||
export DIR=$(DOC_BASE)/gstreamer/$$DOCVERSION/$(DOC); \
|
||||
echo Uploading docs to $(DOC_SERVER):$$DIR; \
|
||||
ssh $(DOC_SERVER) mkdir -p $$DIR; \
|
||||
rsync -arv -e ssh $(DOC).ps $(DOC).pdf html $(DOC_SERVER):$$DIR
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
# base name of doc
|
||||
DOC = pwg
|
||||
# formats defined for upload.mak
|
||||
FORMATS=html ps pdf
|
||||
|
||||
# main xml file
|
||||
MAIN = $(DOC).xml
|
||||
|
|
@ -18,6 +20,8 @@ FIG_SRC = $(notdir $(wildcard $(srcdir)/*.fig))
|
|||
|
||||
# get the generic docbuilding Makefile stuff
|
||||
include $(srcdir)/../manuals.mak
|
||||
# get the generic upload target
|
||||
include $(srcdir)/../upload.mak
|
||||
|
||||
### this is standard automake stuff
|
||||
|
||||
|
|
|
|||
32
docs/upload.mak
Normal file
32
docs/upload.mak
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# this snippet is to be included by both our docbook manuals
|
||||
# and gtk-doc API references
|
||||
|
||||
# it adds an upload target to each of these dir's Makefiles
|
||||
|
||||
# each Makefile.am should define the following variables:
|
||||
# - DOC: the base name of the documentation
|
||||
# (faq, manual, pwg, gstreamer, gstreamer-libs)
|
||||
# - FORMATS: the formats in which DOC is output
|
||||
# (html ps pdf)
|
||||
|
||||
# if you want to use it, make sure your ..sh/config file contains the
|
||||
# correct User entry for the Host entry for the DOC_SERVER
|
||||
|
||||
# these variables define the location of the online docs
|
||||
DOC_SERVER=freedesktop.org
|
||||
DOC_BASE=/home/projects/gstreamer/www/data/doc
|
||||
DOC_URL=$(DOC_SERVER):$(DOC_BASE)
|
||||
|
||||
|
||||
upload: $(FORMATS)
|
||||
@if test "x$$GST_PLUGINS_VERSION_NANO" = x0; then \
|
||||
export DOCVERSION=$(VERSION); \
|
||||
else export DOCVERSION=head; \
|
||||
fi; \
|
||||
export DIR=$(DOC_BASE)/gstreamer/$$DOCVERSION/$(DOC); \
|
||||
echo Uploading docs to $(DOC_SERVER):$$DIR; \
|
||||
ssh $(DOC_SERVER) mkdir -p $$DIR; \
|
||||
if echo $(FORMATS) | grep html > /dev/null; then rsync -arv -e ssh html $(DOC_SERVER):$$DIR; fi; \
|
||||
if echo $(FORMATS) | grep ps > /dev/null; then rsync -arv -e ssh $(DOC).ps $(DOC_SERVER):$$DIR; fi; \
|
||||
if echo $(FORMATS) | grep pdf > /dev/null; then rsync -arv -e ssh $(DOC).pdf $(DOC_SERVER):$$DIR; fi; \
|
||||
echo Done
|
||||
Loading…
Reference in a new issue