[Xfce4-commits] r26490 - in libxfce4util/trunk: . docs docs/tmpl

[Brian Tarricone]

Author: kelnos
Date: 2007-12-17 18:23:16 +0000 (Mon, 17 Dec 2007)
New Revision: 26490

Added:
   libxfce4util/trunk/docs/tmpl/xfce-posix-signal-handler.sgml
Modified:
   libxfce4util/trunk/ChangeLog
   libxfce4util/trunk/docs/libxfce4util-docs.sgml
   libxfce4util/trunk/docs/libxfce4util-sections.txt
   libxfce4util/trunk/docs/tmpl/xfce-miscutils.sgml
Log:
2007-12-17  Brian Tarricone <bjt23 at cornell.edu>

    * Fix docs/ stuff to include new signal handling functionality.


Modified: libxfce4util/trunk/ChangeLog
===================================================================
--- libxfce4util/trunk/ChangeLog	2007-12-17 13:21:53 UTC (rev 26489)
+++ libxfce4util/trunk/ChangeLog	2007-12-17 18:23:16 UTC (rev 26490)
@@ -1,3 +1,7 @@
+2007-12-17  Brian Tarricone <bjt23 at cornell.edu>
+
+    * Fix docs/ stuff to include new signal handling functionality.
+
 2007-12-15  Brian Tarricone <bjt23 at cornell.edu>
 
     * libxfce4util/xfce-posix-signal-handler.{c,h}: new util functions

Modified: libxfce4util/trunk/docs/libxfce4util-docs.sgml
===================================================================
--- libxfce4util/trunk/docs/libxfce4util-docs.sgml	2007-12-17 13:21:53 UTC (rev 26489)
+++ libxfce4util/trunk/docs/libxfce4util-docs.sgml	2007-12-17 18:23:16 UTC (rev 26490)
@@ -12,6 +12,7 @@
 <!ENTITY libxfce4util-Unicode-Functions SYSTEM "xml/xfce-utf8.xml">
 <!ENTITY libxfce4util-Desktop-Entries SYSTEM "xml/xfce-desktopentry.xml">
 <!ENTITY libxfce4util-Generics SYSTEM "xml/xfce-generics.xml">
+<!ENTITY libxfce4util-Signal-Handling SYSTEM "xml/xfce-posix-signal-handler.xml">
 <!ENTITY version SYSTEM "version.xml">
 ]>
 
@@ -41,6 +42,7 @@
 		<title>Xfce Core Application support</title>
 		&libxfce4util-Desktop-Entries;
 		&libxfce4util-Kiosk;
+		&libxfce4util-Signal-Handling;
 	</chapter>
 
 	<chapter id="libxfce4util-utilities">

Modified: libxfce4util/trunk/docs/libxfce4util-sections.txt
===================================================================
--- libxfce4util/trunk/docs/libxfce4util-sections.txt	2007-12-17 13:21:53 UTC (rev 26489)
+++ libxfce4util/trunk/docs/libxfce4util-sections.txt	2007-12-17 18:23:16 UTC (rev 26490)
@@ -165,4 +165,12 @@
 xfce_desktop_entry_get_type
 </SECTION>
 
-
+<SECTION>
+<TITLE>POSIX Signal Handling</TITLE>
+<FILE>xfce-posix-signal-handler</FILE>
+XfcePosixSignalHandler
+xfce_posix_signal_handler_init
+xfce_posix_signal_handler_restore_handler
+xfce_posix_signal_handler_set_handler
+xfce_posix_signal_handler_shutdown
+</SECTION>

Modified: libxfce4util/trunk/docs/tmpl/xfce-miscutils.sgml
===================================================================
--- libxfce4util/trunk/docs/tmpl/xfce-miscutils.sgml	2007-12-17 13:21:53 UTC (rev 26489)
+++ libxfce4util/trunk/docs/tmpl/xfce-miscutils.sgml	2007-12-17 18:23:16 UTC (rev 26490)
@@ -37,8 +37,6 @@
           home directory. The caller is responsible for freeing the
 	  returned string using g_free().
 <!-- # Unused Parameters # -->
- at ...: 
- at ...: 
 @first_element...: NULL terminated list of path components.
 
 
@@ -73,8 +71,6 @@
           directory. The caller is responsible for freeing the returned
 	  string using g_free().
 <!-- # Unused Parameters # -->
- at ...: 
- at ...: 
 @first_element...: NULL terminated list of path components.
 
 

Added: libxfce4util/trunk/docs/tmpl/xfce-posix-signal-handler.sgml
===================================================================
--- libxfce4util/trunk/docs/tmpl/xfce-posix-signal-handler.sgml	                        (rev 0)
+++ libxfce4util/trunk/docs/tmpl/xfce-posix-signal-handler.sgml	2007-12-17 18:23:16 UTC (rev 26490)
@@ -0,0 +1,69 @@
+<!-- ##### SECTION Title ##### -->
+POSIX Signal Handling
+
+<!-- ##### SECTION Short_Description ##### -->
+a callback system for handling POSIX signals safely
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+Due to reentrancy issues, there is a restricted set of functions/syscalls
+that are allowed to be performed inside a POSIX signal handler.  In
+general, it's safer to defer any signal-related processing until after the
+signal handler has run.  The functionality in this module automatically
+handles this, and allows you to set a handler function (with optional user
+data) for any signal.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### USER_FUNCTION XfcePosixSignalHandler ##### -->
+<para>
+A function signature to use for POSIX signal handler functions.
+</para>
+
+ at signal: The signal that was caught.
+ at user_data: The @user_data parameter passed when the handler was registered.
+
+
+<!-- ##### FUNCTION xfce_posix_signal_handler_init ##### -->
+<para>
+
+</para>
+
+ at error: 
+ at Returns: 
+
+
+<!-- ##### FUNCTION xfce_posix_signal_handler_restore_handler ##### -->
+<para>
+
+</para>
+
+ at signal: 
+
+
+<!-- ##### FUNCTION xfce_posix_signal_handler_set_handler ##### -->
+<para>
+
+</para>
+
+ at signal: 
+ at handler: 
+ at user_data: 
+ at error: 
+ at Returns: 
+
+
+<!-- ##### FUNCTION xfce_posix_signal_handler_shutdown ##### -->
+<para>
+
+</para>
+
+
+