[Pkg-privacy-commits] [libgsecuredelete] 09/168: Improve documentation.

[Ulrike Uhlig]

This is an automated email from the git hooks/post-receive script.

u-guest pushed a commit to branch master
in repository libgsecuredelete.

commit cc8e6c482fd94ac212faf0f126cc9bbefff85e7e
Author: Colomban Wendling <ban at herbesfolles.org>
Date:   Tue Sep 29 23:06:25 2009 +0200

    Improve documentation.
---
 gsecuredelete/async-operation.vala | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/gsecuredelete/async-operation.vala b/gsecuredelete/async-operation.vala
index e10fb69..c462156 100644
--- a/gsecuredelete/async-operation.vala
+++ b/gsecuredelete/async-operation.vala
@@ -10,7 +10,7 @@ namespace SecureDelete
   
   /** AsyncOperation:
    * 
-   * An asynchronous process spawner, with support for progression and succes
+   * An asynchronous process spawner, with support for progression and success
    * report.
    * This is a base class designed to be subclassed by actual spawners, with
    * less efforts as possible.
@@ -23,7 +23,27 @@ namespace SecureDelete
    * 
    * <warning>
    *   You need a GLib's MainLoop for the watching process to work for the
-   *   asynchronous method.
+   *   asynchronous method as it use a timeout function to watch the child.
+   *   
+   *   Yes, a thread might be a good thing, but have some limitations too:
+   *   <list>
+   *     <listentry>
+   *       Still needs a timeout somewhere not to overload the machine;
+   *       This can perhaps be thrown away by waiting for the process or one
+   *       of its outputs to be "ready" for something.
+   *     </listentry>
+   *     <listentry>
+   *       Needs lot of care both for the implementation and even more for the
+   *       caller in most cases;
+   *     </listentry>
+   *     <listentry>
+   *       Doesn't do magic: you still need to wait for the thread to terminate
+   *       in a certain manner, or let the thread terminate together with the
+   *       application.
+   *     </listentry>
+   *   </list>
+   *   If you find a perfect implementation going away these limitations, please
+   *   tell me and I'll be happy to try to implement it or to review your patch.
    * </warning>
    * 
    * <example>

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/libgsecuredelete.git