Browse Source

Update docs/abilities of gearman_client_job_status()

Brian Aker 13 years ago
parent
commit
69ac01fe7a

+ 2 - 2
docs/conf.py.in

@@ -259,11 +259,11 @@ man_pages = [
   ('libgearman/gearman_client_run_tasks', 'gearman_client_run_tasks', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('libgearman/gearman_client_set_log_fn', 'gearman_client_set_log_fn', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('libgearman/gearman_client_set_log_fn', 'gearman_worker_set_log_fn', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
-  ('libgearman/gearman_client_st', 'gearman_client_clear_fn', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
+  ('libgearman/gearman_actions_t', 'gearman_client_clear_fn', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('libgearman/gearman_client_st', 'gearman_client_context', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('libgearman/gearman_client_st', 'gearman_client_do_job_handle', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('libgearman/gearman_client_st', 'gearman_client_do_status', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
-  ('libgearman/gearman_client_st', 'gearman_client_job_status', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
+  ('libgearman/gearman_client_job_status', 'gearman_client_job_status', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('libgearman/gearman_client_st', 'gearman_client_set_task_context_free_fn', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('libgearman/gearman_client_st', 'gearman_client_set_timeout', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('libgearman/gearman_client_st', 'gearman_client_set_workload_fn', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),

+ 2 - 0
docs/index.rst

@@ -66,6 +66,8 @@ Client Functions
    libgearman/gearman_client_error
    libgearman/gearman_client_set_log_fn
 
+   libgearman/gearman_client_job_status
+
 **************
 Creating Tasks
 **************

+ 2 - 0
docs/libgearman/error_descriptions.rst

@@ -55,3 +55,5 @@ List of client/worker errors
    errors/GEARMAN_TIMEOUT
    errors/GEARMAN_ARGUMENT_TOO_LARGE
    errors/GEARMAN_INVALID_ARGUMENT
+   errors/GEARMAN_IN_PROGRESS
+   errors/GEARMAN_MAX_RETURN

+ 6 - 0
docs/libgearman/errors/GEARMAN_IN_PROGRESS.rst

@@ -0,0 +1,6 @@
+===================
+GEARMAN_IN_PROGRESS
+===================
+
+Please see :c:type:`GEARMAN_IN_PROGRESS`
+

+ 7 - 0
docs/libgearman/errors/GEARMAN_MAX_RETURN.rst

@@ -0,0 +1,7 @@
+
+==================
+GEARMAN_MAX_RETURN
+==================
+
+Please see :c:type:`GEARMAN_MAX_RETURN`
+

+ 1 - 1
docs/libgearman/errors/GEARMAN_SUCCESS.rst

@@ -2,4 +2,4 @@
 GEARMAN_SUCCESS
 ===============
 
-Please see c:type:`GEARMAN_SUCCESS`
+Please see :c:type:`GEARMAN_SUCCESS`

+ 1 - 1
docs/libgearman/errors/GEARMAN_TIMEOUT.rst

@@ -2,4 +2,4 @@
 GEARMAN_TIMEOUT
 ===============
 
-Please see c:type:`GEARMAN_TIMEOUT`
+Please see :c:type:`GEARMAN_TIMEOUT`

+ 1 - 1
docs/libgearman/errors/GEARMAN_TOO_MANY_ARGS.rst

@@ -2,4 +2,4 @@
 GEARMAN_TOO_MANY_ARGS
 =====================
 
-Please see c:type:`GEARMAN_TOO_MANY_ARGS`
+Please see :c:type:`GEARMAN_TOO_MANY_ARGS`

+ 1 - 1
docs/libgearman/errors/GEARMAN_UNEXPECTED_PACKET.rst

@@ -2,4 +2,4 @@
 GEARMAN_UNEXPECTED_PACKET
 =========================
 
-Please see c:type:`GEARMAN_UNEXPECTED_PACKET`
+Please see :c:type:`GEARMAN_UNEXPECTED_PACKET`

+ 1 - 1
docs/libgearman/errors/GEARMAN_UNKNOWN_OPTION.rst

@@ -2,4 +2,4 @@
 GEARMAN_UNKNOWN_OPTION
 ======================
 
-Please see c:type:`GEARMAN_UNKNOWN_OPTION`
+Please see :c:type:`GEARMAN_UNKNOWN_OPTION`

Some files were not shown because too many files changed in this diff