← Back to branch summary

~brianaker/gearmand/warning-usage

« back to all changes in this revision

Viewing changes to docs/libgearman/gearman_client_add_task_status.rst

  • Committer: Brian Aker
  • Date: 2012-05-04 03:46:04 UTC
  • Revision ID: brian@tangent.org-20120504034604-5t22ae4v2o45zjkq
Update for libtest, documentation, and fix for root bzr dir.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libgearman/gearman_client_add_task_status.rst
16
16
DESCRIPTION
17
17
-----------
18
18
 
19
 
:c:func:`gearman_client_add_task_status()` creates a :c:type:`gearman_task_st` that can be used to monitor a previously created task.
 
19
:c:func:`gearman_client_add_task_status` creates a :c:type:`gearman_task_st` that can be used to monitor a previously created task.
20
20
 
21
21
.. warning::
22
 
        You may wish to avoid using :c:func:`gearman_client_add_task()` with a
 
22
        You may wish to avoid using :c:func:`gearman_client_add_task` with a
23
23
        stack based allocated :c:type:`gearman_task_st`. The most common issues related to ABI safety involve
24
 
        stack allocated structures. If you use a stack based :c:type:`gearman_task_st` you must free it with :c:func:`gearman_task_free()`.
 
24
        stack allocated structures. If you use a stack based :c:type:`gearman_task_st` you must free it with :c:func:`gearman_task_free`.
25
25
 
26
26
------------
27
27
RETURN VALUE