diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 19 | ||||
| -rw-r--r-- | doc/TODO | 2 | ||||
| -rw-r--r-- | doc/busconfig.dtd | 52 | ||||
| -rw-r--r-- | doc/dbus-specification.sgml | 34 |
4 files changed, 93 insertions, 14 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 891c0209..5bd9fb1e 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -10,16 +10,23 @@ if DBUS_DOCS_ENABLED all-local: dbus-specification.html dbus-test-plan.html endif +## Debian db2html outputs to stdout, so we collect stdout and use +## it if we didn't get the proper output + dbus-specification.html: dbus-specification.sgml - $(DB2HTML) -o . --nochunks $< && \ - rm -r $(srcdir)/dbus-specification/stylesheet-images && \ - (if test -d $(srcdir)/dbus-specification ; then \ + rm -f $@ && \ + $(DB2HTML) -o . --nochunks $< > $@.stdout && \ + (test -e $@ && rm -f $@.stdout || mv $@.stdout $@) && \ + rm -rf $(srcdir)/dbus-specification/stylesheet-images && \ + (if test -d $(srcdir)/dbus-specification ; then \ rmdir $(srcdir)/dbus-specification ; fi) dbus-test-plan.html: dbus-test-plan.sgml - $(DB2HTML) -o . --nochunks $< && \ - rm -r $(srcdir)/dbus-test-plan/stylesheet-images && \ - (if test -d $(srcdir)/dbus-test-plan ; then \ + rm -f $@ && \ + $(DB2HTML) -o . --nochunks $< > $@.stdout && \ + (test -e $@ && rm -f $@.stdout || mv $@.stdout $@) && \ + rm -rf $(srcdir)/dbus-test-plan/stylesheet-images && \ + (if test -d $(srcdir)/dbus-test-plan ; then \ rmdir $(srcdir)/dbus-test-plan ; fi) maintainer-clean-local: @@ -45,8 +45,6 @@ after the message bus has processed your message but before the service has replied, it would be nice if the message bus sent you an error reply. - - write a DTD for the dbus-daemon-1 configuration file - - build and install the Doxygen manual in Makefile when --enable-docs - if you send the same message to multiple connections, the serial number diff --git a/doc/busconfig.dtd b/doc/busconfig.dtd new file mode 100644 index 00000000..97c0b82e --- /dev/null +++ b/doc/busconfig.dtd @@ -0,0 +1,52 @@ +<!ELEMENT busconfig (user | + type | + fork | + listen | + pidfile | + includedir | + servicedir | + auth | + include | + policy | + limit)*> + +<!ELEMENT user (#PCDATA)> +<!ELEMENT listen (#PCDATA)> +<!ELEMENT includedir (#PCDATA)> +<!ELEMENT servicedir (#PCDATA)> +<!ELEMENT auth (#PCDATA)> +<!ELEMENT type (#PCDATA)> +<!ELEMENT pidfile (#PCDATA)> +<!ELEMENT fork EMPTY> + +<!ELEMENT include (#PCDATA)> +<!ATTLIST include + ignore_missing (yes|no) "yes"> + +<!ELEMENT policy (allow|deny)*> +<!ATTLIST policy + context (default|mandatory) #IMPLIED + user CDATA #IMPLIED + group CDATA #IMPLIED> + +<!ELEMENT allow EMPTY> +<!ATTLIST allow + user CDATA #IMPLIED + send CDATA #IMPLIED + receive CDATA #IMPLIED + own CDATA #IMPLIED + send_to CDATA #IMPLIED + receive_from CDATA #IMPLIED> + +<!ELEMENT deny EMPTY> +<!ATTLIST deny + user CDATA #IMPLIED + send CDATA #IMPLIED + receive CDATA #IMPLIED + own CDATA #IMPLIED + send_to CDATA #IMPLIED + receive_from CDATA #IMPLIED> + +<!ELEMENT limit (#PCDATA)> +<!ATTLIST limit name CDATA #REQUIRED> + diff --git a/doc/dbus-specification.sgml b/doc/dbus-specification.sgml index c772b3e5..696c3f45 100644 --- a/doc/dbus-specification.sgml +++ b/doc/dbus-specification.sgml @@ -1972,22 +1972,44 @@ <row> <entry>0</entry> <entry>UINT32</entry> - <entry>Result code; DBUS_ACTIVATION_REPLY_ACTIVATED if - the service was activated successfully or - DBUS_ACTIVATION_REPLY_ALREADY_ACTIVE if the service is - already active.</entry> + <entry>Return value</entry> </row> </tbody> </tgroup> </informaltable> - </para> - <para> Tries to launch the executable associated with a service. For more information, see <xref linkend="message-bus-activation">. [FIXME need semantics in much more detail here; for example, if I activate a service then send it a message, is the message queued for the new service or is there a race] </para> + <para> + The return value can be one of the following values: + <informaltable> + <tgroup cols=3> + <thead> + <row> + <entry>Identifier</entry> + <entry>Value</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>DBUS_ACTIVATION_REPLY_ACTIVATED</entry> + <entry>0x0</entry> + <entry>The service was activated successfully.</entry> + </row> + <row> + <entry>DBUS_ACTIVATION_REPLY_ALREADY_ACTIVE</entry> + <entry>0x1</entry> + <entry>The service is already active.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </sect3> <sect3 id="bus-messages-out-of-memory"> |