diff options
author | Brian Tarricone <brian@tarricone.org> | 2007-10-03 12:34:05 +0000 |
---|---|---|
committer | Brian Tarricone <brian@tarricone.org> | 2007-10-03 12:34:05 +0000 |
commit | 6e3eb9e521c7ca454af781ef55b43d1c32088bff (patch) | |
tree | c08de354597683bb084dd7cf5360bc98b6e2176e /docs | |
parent | 0395d8ec37100b934b51378a8783911b4a223963 (diff) | |
download | xfconf-6e3eb9e521c7ca454af781ef55b43d1c32088bff.tar.gz |
* move XfconfBackendError to a more public place and rename it to XfconfError
* allow xfconfd to load multiple backends, the first of which is read/write,
and the others are read-only
* update docs
(Old svn revision: 26762)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/Makefile.am | 9 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-backend.sgml | 7 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-errors.sgml | 41 | ||||
-rw-r--r-- | docs/reference/xfconf-docs.sgml | 5 | ||||
-rw-r--r-- | docs/reference/xfconf-sections.txt | 6 |
5 files changed, 58 insertions, 10 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index e246771..4ef8479 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -21,8 +21,13 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml FIXXREF_OPTIONS= # Used for dependencies -HFILE_GLOB=$(top_srcdir)/xfconf/*.h $(top_srcdir)/xfconfd/*.h -CFILE_GLOB=$(top_srcdir)/xfconf/*.c $(top_srcdir)/xfconfd/*.c +HFILE_GLOB = \ + $(top_srcdir)/xfconf/*.h \ + $(top_srcdir)/xfconfd/*.h +CFILE_GLOB = \ + $(top_srcdir)/xfconf/*.c \ + $(top_srcdir)/xfconfd/*.c \ + $(top_srcdir)/common/xfconf-errors.c # Header files to ignore when scanning IGNORE_HFILES= \ diff --git a/docs/reference/tmpl/xfconf-backend.sgml b/docs/reference/tmpl/xfconf-backend.sgml index dd213a9..1500b80 100644 --- a/docs/reference/tmpl/xfconf-backend.sgml +++ b/docs/reference/tmpl/xfconf-backend.sgml @@ -20,13 +20,6 @@ one could think of to store data. <!-- ##### SECTION Stability_Level ##### --> -<!-- ##### MACRO XFCONF_BACKEND_ERROR ##### --> -<para> - -</para> - - - <!-- ##### STRUCT XfconfBackendInterface ##### --> <para> diff --git a/docs/reference/tmpl/xfconf-errors.sgml b/docs/reference/tmpl/xfconf-errors.sgml new file mode 100644 index 0000000..2ea0a0f --- /dev/null +++ b/docs/reference/tmpl/xfconf-errors.sgml @@ -0,0 +1,41 @@ +<!-- ##### SECTION Title ##### --> +Error Reporting + +<!-- ##### SECTION Short_Description ##### --> +Xfconf library and daemon error descriptions + +<!-- ##### SECTION Long_Description ##### --> +<para> +Both the Xfconf daemon and library provide error information via the +use of #GError<!-- -->s. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO XFCONF_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM XfconfError ##### --> +<para> + +</para> + +@XFCONF_ERROR_UNKNOWN: An unknown error occurred +@XFCONF_ERROR_CHANNEL_NOT_FOUND: The specified channel does not exist +@XFCONF_ERROR_PROPERTY_NOT_FOUND: The specified property does not exist on the channel +@XFCONF_ERROR_READ_FAILURE: There was a failure reading from the configuration store +@XFCONF_ERROR_WRITE_FAILURE: There was a failure writing to the configuration store +@XFCONF_ERROR_PERMISSION_DENIED: The user is not allowed to read or write to the channel or property +@XFCONF_ERROR_INTERNAL_ERROR: An internal error (likely a bug in xfconf) occurred +@XFCONF_ERROR_NO_BACKEND: No backends were found, or those found could not be loaded + diff --git a/docs/reference/xfconf-docs.sgml b/docs/reference/xfconf-docs.sgml index aaea0cc..c9735fd 100644 --- a/docs/reference/xfconf-docs.sgml +++ b/docs/reference/xfconf-docs.sgml @@ -7,6 +7,11 @@ </bookinfo> <chapter> + <title>Xfconf Errors</title> + <xi:include href="xml/xfconf-errors.xml"/> + </chapter> + + <chapter> <title>Xfconf Daemon</title> <xi:include href="xml/xfconf-backend.xml"/> </chapter> diff --git a/docs/reference/xfconf-sections.txt b/docs/reference/xfconf-sections.txt index 8f5680b..228b9b4 100644 --- a/docs/reference/xfconf-sections.txt +++ b/docs/reference/xfconf-sections.txt @@ -29,7 +29,6 @@ XFCONF_CHANNEL_GET_CLASS <SECTION> <FILE>xfconf-backend</FILE> -XFCONF_BACKEND_ERROR XfconfBackendInterface xfconf_backend_initialize xfconf_backend_set @@ -52,3 +51,8 @@ xfconf_init xfconf_shutdown </SECTION> +<SECTION> +<FILE>xfconf-errors</FILE> +XFCONF_ERROR +XfconfError +</SECTION> |