Commit graph

41 commits

Author SHA1 Message Date
Simon McVittie
f4c02e7829 Fix maintainer-upload-docs target to work out-of-tree
The STATIC_DOCS, DTDS and all dist_ files except XMLTO_OUTPUT are in the
source tree. The XMLTO_OUTPUT and the man2html output are in the build
tree, and the BONUS_FILES already have $(srcdir) in their names.

Also change the rules that generate the dbus-docs directory so that if
they fail, they leave behind a temporary directory, rather than leaving
behind a dbus-docs directory that causes make to not run those rules
if re-run; and change the rules to scp files to the server, to put a
trailing "/" on paths, ensuring that the tarball won't be uploaded as
"www" if the www directory doesn't already exist.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=41047
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-09-21 11:25:48 +01:00
Chris Mayo
c82a83fb1b Install diagrams in htmldir
diagram.png and diagram.svg are linked from dbus-tutorial.html but recent
changes to doc/Makefile.am mean that if htmldir is set with configure they are
installed such that the relative link from dbus-tutorial.html does not work.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2011-08-15 10:23:04 +01:00
Simon McVittie
693e2fc463 Uninstall the installed docs
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:24:52 +01:00
Simon McVittie
39b6b898c5 Install man2html output to $(htmldir)
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:24:47 +01:00
Simon McVittie
14dab0789e Install diagram.*, system-activation.txt to the $(docdir)
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:24:23 +01:00
Simon McVittie
53af0b903c Install xmlto output to $(htmldir) automatically
Also rename HTML_FILES to XMLTO_OUTPUT, as a more self-describing name:
we have other HTML files which are not the output from xmlto.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:24:15 +01:00
Simon McVittie
37cb1522fe Install dbus.devhelp to $(htmldir), not $(apidir), and remove it in clean
It needs to be in $(htmldir) so that its relative paths will work.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:23:45 +01:00
Simon McVittie
59c6663293 When uploading docs, use rsync -p to set permissions
It turns out that rsync --chmod means "pretend the source files had
already had this chmod operation applied to them", and not "chmod the
destination files" like you'd expect.

As a result, the -p (--perms) option is also needed, so that rsync will
"preserve" the modified permissions. Otherwise, the docs will not be
group-writeable as intended, and only the person who made the previous
upload will be able to upload them next time.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36130
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-04-12 11:26:49 +01:00
Simon McVittie
23d4a2ec5d Implement uninstallation and cleanup for Doxygen docs, fixing distcheck
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-03-10 19:00:23 +00:00
Simon McVittie
f1ba52066c Merge branch 'doxygenate' into dbus-1.4
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Conflicts:
	configure.ac
	doc/Makefile.am
2011-02-25 15:49:19 +00:00
Simon McVittie
d5e4fc13e8 Don't distribute dbus-daemon.1 in the tarball
It's generated by configure.

Also use a more normal way to distribute man pages that are actually
source, and use man1_MANS rather than auto-detecting the section from
the man page, which is best-practice and slightly faster.

Reviewed-by: Colin Walters <walters@verbum.org>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=34292
2011-02-17 16:31:44 +00:00
Simon McVittie
1be098611e Build dbus.devhelp using doxygen_to_devhelp.xsl and install it
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=13495
2011-01-14 12:46:01 +00:00
Simon McVittie
fbe8c192e2 Install the Doxygen documentation to $(htmldir)
Use ./configure --docdir=/foo (or --htmldir=/foo) to control where it
ends up. For instance, Debian could use:

    --docdir=/usr/share/doc/dbus-1-doc --htmldir='${docdir}/html'

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=13495
2011-01-14 12:45:56 +00:00
Simon McVittie
5277d3c232 docs: use $(MKDIR_P), which we already check for in configure.in
mkdir -p isn't 100% portable, whereas $(MKDIR_P) can either be mkdir -p,
install -d or (as a last resort) ./install-sh -d.
2011-01-14 12:45:54 +00:00
Simon McVittie
b72f6e0ca0 Use a stamp file to represent the Doxygen output
This avoids thinking it's up to date if the Doxygen build fails, but writes
partial output to index.html before failing.
2011-01-14 12:45:52 +00:00
Simon McVittie
1edc077257 Add doxygen_to_devhelp.xsl (from Fedora, via Debian)
Originally committed by Matthias Clasen <mclasen@fedoraproject.org>.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=13495
Bug-Debian: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=454142
2011-01-14 12:45:46 +00:00
Will Thompson
783baf9df2 Move uploading docs into build system.
This uploads a doc tarball, and its contents, to the appropriate
location on dbus.freedesktop.org. It also uploads the DTDs to the
appropriate location on specifications.freedesktop.org.

I believe this uploads the same files as the old update-dbus-docs.sh
script did.
2010-10-05 11:46:00 +01:00
Will Thompson
ee17175118 Integrate building HTML-ified manpages with the build system 2010-10-05 11:46:00 +01:00
Will Thompson
46b9961be7 Move manpages to doc/
This will make integrating the building of HTML versions of these
manpages into the build system way easier, at the cost of keeping
manpages in a different directory to the source for the program they
describe. I think this is an acceptable trade-off.
2010-10-05 11:45:59 +01:00
Will Thompson
d0dda86f33 Build Doxygen documentation for make all.
This depends on GNU Make for the wildcard dependency on all the source
files in dbus/. If anyone objects very strongly to this, I'd welcome
suggestions of a more portable way to do this.
2010-10-05 11:45:59 +01:00
Colin Walters
e59db9df47 Move system-activation.txt into non-conditional EXTRA_DIST
It doesn't depend on the XML doc generation.
2010-02-01 16:45:48 -05:00
Colin Walters
2691b302aa [doc] diagram.[svg,png] to EXTRA_DIST
These files are part of the docs and should appear in tarballs.
2010-01-28 17:29:27 -05:00
Havoc Pennington
5882fcb12c 2007-07-27 Havoc Pennington <hp@redhat.com>
* release 1.1.2
2007-07-27 20:59:42 +00:00
John (J5) Palmieri
8d1e7dfeb9 * ChangeLog: clean up my last entry a bit
* doc/introspect.xsl: New stylesheet for converting introspection data
	into browser renderable xhtml. Contributed by Lennart Poettering.

	* doc/introspect.dtd: Fixups in the introspect format from Lennart
	Poettering.

	* doc/dbus-tutorial.xml:
	- Add Colin Walter to the Authors section for authoring the GLib
	section
	- Add descriptions of the new signature and type functionality
	in the Python complex type mapping section
	- Add a sidenote on the new args matching functionality in
	the Python bindings
	- Fixed up some of the examples to use the gobject.MainLoop
	instead of gtk.main

	* python/_dbus.py:
	(Bus::_create_args_dict): New. Converts a hash of arg matches
	to a more useable format
	(Bus::add_signal_receiver): add a **keywords parameter for catching
	arg match parameters
	(Bus::remove_signal_receiver): add a **keywords parameter for catching
	arg match parameters

	* python/matchrules.py:
	(MatchTree::exec_matches): Check for arg matches
	(SignalMatchRule::add_args_match): New method
	(SignalMatchRule::execute): Added args_list parameter as an optimization
	so we don't have to marshal the args more than once
	(SignalMatchRule::match_args_from_list): New method that checks to see
	if the rule's arg matches match an argument list.  Only arguments
	set in the rule are checked.
	(SignalMatchRule::match_args_from_rule): New method that checks to see
	if the rule's arg matches match another rule's.  All args have to match
	in order for this method to return true.  If either rule has more args
	then it is not a match.
	(SignalMatchRule::is_match): Add args match
	(SignalMatchRule::repr): Add args to the final output if they exist
2005-08-18 04:04:57 +00:00
Havoc Pennington
849493eafb 2005-02-04 Havoc Pennington <hp@redhat.com>
* doc/Makefile.am (EXTRA_DIST): add DTDs to makefile

	* doc/introspect.dtd: add introspect.dtd from David A. Wheeler
	(with some minor changes)

	* doc/dbus-specification.xml: add deprecated attribute to
	introspection format
2005-02-05 03:24:54 +00:00
Havoc Pennington
76ee87af5b the new tutorial/FAQ 2005-01-23 00:28:41 +00:00
Colin Walters
3d0f1fb1b6 2004-07-06 Colin Walters <walters@redhat.com>
* doc/Makefile.am, qt/Makefile.am:
	mono/doc/Makefile.am: Allow 'make dist'
	without doc building of various sorts or
	QT support enabled.
2004-07-06 15:15:59 +00:00
Havoc Pennington
4fd4d52dd6 2004-03-19 Havoc Pennington <hp@redhat.com>
* NEWS: 0.21 updates

	* configure.in: 0.21

	* doc/Makefile.am: add all XMLTO usage to DBUS_XML_DOCS_ENABLED

	* python/Makefile.am: change to avoid dist of dbus_bindings.c so
	you don't need pyrex to make dist

	* qt/Makefile.am (libdbus_qt_1_la_SOURCES): add integrator.h to
	sources; run moc
2004-03-19 22:36:31 +00:00
Havoc Pennington
78b69c683e 2003-09-29 Havoc Pennington <hp@pobox.com>
* configure.in: split checks for Doxygen from XML docs, check for
	xmlto

	* doc/Makefile.am: XML-ify all the docs, and add a blank
	dbus-tutorial.xml
2003-09-30 03:34:00 +00:00
Havoc Pennington
093db0df89 enhance debian hacks 2003-09-29 02:33:36 +00:00
Havoc Pennington
92a2943c91 2003-09-28 Havoc Pennington <hp@pobox.com>
* doc/Makefile.am (dbus-specification.html): testing a funky hack
	to work with Debian db2html
2003-09-29 02:23:29 +00:00
Havoc Pennington
b99e916792 2003-09-28 Havoc Pennington <hp@pobox.com>
* configure.in: 0.13

	* doc/Makefile.am (dbus-test-plan.html): accept nonexistence of
	stylesheet-images for benefit of Debian

	Change back to using filesystem-linked sockets for the system
	bus, so only root can create the default system bus address.

	* bus/system.conf.in: change to use
	DBUS_SYSTEM_BUS_DEFAULT_ADDRESS

	* dbus/Makefile.am (INCLUDES): remove DBUS_SYSTEM_BUS_PATH define
	from here.

	* configure.in: define DBUS_SYSTEM_BUS_DEFAULT_ADDRESS
	here, and AC_DEFINE DBUS_SYSTEM_PATH
2003-09-29 01:43:52 +00:00
Miloslav Trmac
fc2743e206 2003-06-29 Miloslav Trmac <mitr@volny.cz>
* doc/Makefile.am:
	* tools/Makefile.am: Don't assume srcdir == builddir.
2003-06-29 15:35:06 +00:00
Havoc Pennington
f548adbae0 2003-05-03 Havoc Pennington <hp@pobox.com>
* bus/Makefile.am, bus/dbus-daemon-1.1.in: man page for the
	daemon; also documents daemon config file, so replaces
	doc/config-file.txt. Corrected some stuff from config-file.txt in
	the process of moving it.
2003-05-03 23:07:19 +00:00
Havoc Pennington
ccc4926813 2003-04-28 Havoc Pennington <hp@redhat.com>
* configure.in: add --enable-docs which by default is auto yes if
        doxygen and db2html found, no otherwise; but can be forced on/off

        * doc/Makefile.am: conditionalize whether to build docs on
        --enable-docs
2003-04-28 23:40:17 +00:00
Havoc Pennington
a7f69a41d5 2003-04-06 Havoc Pennington <hp@pobox.com>
* qt/Makefile.am (dbusinclude_HEADERS): install dbus-qt.h,
	from Colin Walters

	* configure.in: fixes to Qt detection from Colin Walters

	* doc/Makefile.am: Only remove generated docbook dirs if they
	exist, from Colin Walters

	* dbus/dbus-bus.c: change how we set well-known connections to
	NULL, so that it works if a single connection is stored in
	two well-known array slots.

	* test/Makefile.am: remove a lot of stuff that isn't immediately
	useful, it's in CVS history if we want it.

	* test/test-service.c: use dbus-mainloop instead of that
	watch.[hc] crack
2003-04-07 02:01:53 +00:00
Havoc Pennington
29c71168cd 2003-03-31 Havoc Pennington <hp@pobox.com>
* dbus/dbus-transport-unix.c (_dbus_transport_new_for_domain_socket)
	(_dbus_transport_new_for_tcp_socket): these didn't need the "server"
	argument since they are always client side

	* dbus/dbus-server.c (dbus_server_get_address): new function

	* bus/main.c (main): take the configuration file as an argument.

	* test/data/valid-config-files/debug-allow-all.conf: new file to
	use with dispatch.c tests for example

	* bus/test-main.c (main): require test data dir

	* bus/bus.c (bus_context_new): change this to take a
	configuration file name as argument

	* doc/config-file.txt (Elements): add <servicedir>

	* bus/system.conf, bus/session.conf: new files

	* dbus/dbus-bus.c (dbus_bus_get): look for system bus on
	well-known socket if none set

	* configure.in: create system.conf and session.conf
2003-03-31 08:19:50 +00:00
Anders Carlsson
014e1be482 2003-02-17 Anders Carlsson <andersca@codefactory.se>
* doc/.cvsignore:
	* doc/Makefile.am:
	* doc/dbus-test-plan.sgml:
	Add test plan document.

	* test/Makefile.am:
	Fix distcheck.
2003-02-16 23:35:51 +00:00
Havoc Pennington
f703c5ddd3 2003-01-22 Havoc Pennington <hp@pobox.com>
* doc/dbus-specification.sgml: Start to document the protocol.
2003-01-23 05:04:03 +00:00
Anders Carlsson
6b0e7e822f 2002-11-21 Anders Carlsson <andersca@codefactory.se>
* doc/Makefile.am:
	Fix references so we can distcheck.
2002-11-21 18:54:46 +00:00
Havoc Pennington
93cff3d69f initial import of "dbus" skeleton 2002-11-21 16:41:33 +00:00