Merge in docs.

docs/conf.py

@@ -218,7 +218,8 @@ man_pages = [
   ('gearman_client', 'gearman_client_clone', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_client', 'gearman_client_create', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_client', 'gearman_client_free', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
-  ('gearman_client_execute', 'gearman_client_execute', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
+  ('gearadmin', 'gearadmin', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 1),
+  ('gearman', 'gearman', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 1),
   ('gearman_client_st', 'gearman_client_add_options', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_client_st', 'gearman_client_add_server', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_client_st', 'gearman_client_add_servers', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
@@ -266,6 +267,8 @@ man_pages = [
   ('gearman_client_st', 'gearman_client_task_free_all', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_client_st', 'gearman_client_timeout', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_client_st', 'gearman_client_wait', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
+  ('gearman_execute', 'gearman_execute', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
+  ('gearman_execute_map_reduce', 'gearman_execute_map_reduce', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_job_st', 'gearman_job_free', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_job_st', 'gearman_job_free_all', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_job_st', 'gearman_job_function_name', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
@@ -280,8 +283,8 @@ man_pages = [
   ('gearman_job_st', 'gearman_job_take_workload', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_job_st', 'gearman_job_workload', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_job_st', 'gearman_job_workload_size', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
-  ('gearman_return_t', 'gearman_return_t', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_parse_servers', 'gearman_parse_servers', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
+  ('gearman_return_t', 'gearman_return_t', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_task_st', 'gearman_task_context', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_task_st', 'gearman_task_data', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_task_st', 'gearman_task_data_size', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
@@ -330,8 +333,6 @@ man_pages = [
   ('gearman_worker_st', 'gearman_worker_unregister_all', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_worker_st', 'gearman_worker_wait', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ('gearman_worker_st', 'gearman_worker_work', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
-  ('gearman', 'gearman', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 1),
-  ('gearadmin', 'gearadmin', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 1),
   ('gearmand', 'gearmand', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 8),
   ('libgearman', 'libgearman', u'Gearmand Documentation', [u'Data Differential http://datadifferential.com/'], 3),
   ]

docs/gearman_client_execute.rst

@@ -1,50 +0,0 @@
-======================
-gearman_client_execute
-======================
-
-.. index:: object: gearman_client_execute
-
--------
-LIBRARY
--------
-
-C Client Library for Gearmand (libgearman, -lgearman)
-
---------
-SYNOPSIS
---------
-
-#include <libgearman/gearman.h>
-
-.. c:function:: gearman_task_st *gearman_client_execute(gearman_client_st *client, const char *function_str, size_t function_length, const char *unique_str, size_t unique_length, gearman_work_t *workload, gearman_argument_t *arguments)
-
-
------------
-DESCRIPTION
------------
-
-gearman_client_execute() can be used to execute tasks against a gearman network.
-
-
-------
-RETURN
-------
-
-
-gearman_client_execute() returns a c:type:`gearman_task_st`.  
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`https://launchpad.net/gearmand <https://launchpad.net/gearmand>`_
-
-
---------
-SEE ALSO
---------
-
-:manpage:`gearmand(8)` :manpage:`libgearman(3)`

docs/gearman_execute.rst

@@ -0,0 +1,50 @@
+=============== 
+gearman_execute
+=============== 
+
+.. index:: object: gearman_execute
+
+-------
+LIBRARY
+-------
+
+C Client Library for Gearmand (libgearman, -lgearman)
+
+--------
+SYNOPSIS
+--------
+
+#include <libgearman/gearman.h>
+
+.. c:function:: gearman_task_st *gearman_execute(gearman_client_st *client, const char *function_str, size_t function_length, const char *unique_str, size_t unique_length, gearman_work_t *workload, gearman_argument_t *arguments)
+
+
+-----------
+DESCRIPTION
+-----------
+
+gearman_execute() can be used to execute tasks against a gearman network.
+
+
+------
+RETURN
+------
+
+
+gearman_execute() returns a c:type:`gearman_task_st`.  
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`https://launchpad.net/gearmand <https://launchpad.net/gearmand>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`gearmand(8)` :manpage:`libgearman(3)`

docs/gearman_client_execute_reduce.rst → docs/gearman_execute_map_reduce.rst

@@ -14,12 +14,7 @@ SYNOPSIS
 
 #include <libgearman/gearman.h>
 
-.. c:function:: gearman_task_st *gearman_client_execute_reduce(gearman_client_st *client,
-                                               const char *mapper_name, const size_t mapper_length,
-                                               const char *reducer_name, const size_t reducer_length,
-                                               const char *unique_str, const size_t unique_length,
-                                               gearman_work_t *workload,
-                                               gearman_argument_t *arguments);
+.. c:function:: gearman_task_st *gearman_execute_map_reduce(gearman_client_st *client, const char *mapper_name, const size_t mapper_length, const char *reducer_name, const size_t reducer_length, const char *unique_str, const size_t unique_length, gearman_work_t *workload, gearman_argument_t *arguments);
 
 .. c::type typedef gearman_worker_error_t (gearman_mapper_fn)(gearman_job_st *job, void *context);
 

docs/include.am

@@ -49,7 +49,6 @@ man_MANS+= \
 	   docs/man/gearman_client_echo.3 \
 	   docs/man/gearman_client_errno.3 \
 	   docs/man/gearman_client_error.3 \
-	   docs/man/gearman_client_execute.3 \
 	   docs/man/gearman_client_free.3 \
 	   docs/man/gearman_client_job_status.3 \
 	   docs/man/gearman_client_options.3 \
@@ -77,6 +76,8 @@ man_MANS+= \
 	   docs/man/gearman_client_timeout.3 \
 	   docs/man/gearman_client_wait.3 \
 	   docs/man/gearman_create.3 \
+	   docs/man/gearman_execute.3 \
+	   docs/man/gearman_execute_map_reduce.3 \
 	   docs/man/gearman_job_free.3 \
 	   docs/man/gearman_job_free_all.3 \
 	   docs/man/gearman_job_function_name.3 \

docs/index.rst

@@ -58,8 +58,8 @@ Client Calls
 
    gearman_client
    do
-   gearman_client_execute 
-   gearman_client_execute_reduce
+   gearman_execute 
+   gearman_execute_map_reduce
 
 ************
 Worker Calls

docs/man/gearman_client_set_namespace.3

@@ -0,0 +1,68 @@
+.TH "GEARMAN_CLIENT_SET_NAMESPACE" "3" "May 24, 2011" "0.20" "Gearmand"
+.SH NAME
+gearman_client_set_namespace \- Gearmand Documentation
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+#include <libgearman/gearman.h>
+.INDENT 0.0
+.TP
+.B void gearman_client_set_namespace(gearman_client_st\fI\ *self\fP, const char\fI\ *namespace_key\fP, size_t\fI\ namespace_key_size\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void gearman_worker_set_namespace(gearman_worker_st\fI\ *self\fP, const char\fI\ *namespace_key\fP, size_t\fI\ namespace_key_size\fP)
+.UNINDENT
+.sp
+Compile and link with \-lgearman
+.SH DESCRIPTION
+.sp
+gearman_client_set_namespace() and gearman_worker_set_namespace() set a "namespace" for a given set of functions. Only clients and workers sharing a \fBnamespace_key\fP can
+see one anothers workloads and functions.
+.sp
+By setting \fBnamespace_key\fP to NULL you can disable the namespace.
+.SH RETURN
+.sp
+None
+.SH HOME
+.sp
+To find out more information please check:
+\fI\%https://launchpad.net/gearmand\fP
+.SH SEE ALSO
+.sp
+\fIgearmand(8)\fP \fIlibgearman(3)\fP
+.SH AUTHOR
+Data Differential http://datadifferential.com/
+.SH COPYRIGHT
+2011, Data Differential, http://datadifferential.com/
+.\" Generated by docutils manpage writer.
+.\" 
+.

docs/man/gearman_execute.3

@@ -0,0 +1,62 @@
+.TH "GEARMAN_EXECUTE" "3" "May 24, 2011" "0.20" "Gearmand"
+.SH NAME
+gearman_execute \- Gearmand Documentation
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH LIBRARY
+.sp
+C Client Library for Gearmand (libgearman, \-lgearman)
+.SH SYNOPSIS
+.sp
+#include <libgearman/gearman.h>
+.INDENT 0.0
+.TP
+.B gearman_task_st *gearman_execute(gearman_client_st\fI\ *client\fP, const char\fI\ *function_str\fP, size_t\fI\ function_length\fP, const char\fI\ *unique_str\fP, size_t\fI\ unique_length\fP, gearman_work_t\fI\ *workload\fP, gearman_argument_t\fI\ *arguments\fP)
+.UNINDENT
+.SH DESCRIPTION
+.sp
+gearman_execute() can be used to execute tasks against a gearman network.
+.SH RETURN
+.sp
+gearman_execute() returns a c:type:\fIgearman_task_st\fP.
+.SH HOME
+.sp
+To find out more information please check:
+\fI\%https://launchpad.net/gearmand\fP
+.SH SEE ALSO
+.sp
+\fIgearmand(8)\fP \fIlibgearman(3)\fP
+.SH AUTHOR
+Data Differential http://datadifferential.com/
+.SH COPYRIGHT
+2011, Data Differential, http://datadifferential.com/
+.\" Generated by docutils manpage writer.
+.\" 
+.

docs/man/gearman_execute_map_reduce.3

@@ -0,0 +1,65 @@
+.TH "GEARMAN_EXECUTE_MAP_REDUCE" "3" "May 24, 2011" "0.20" "Gearmand"
+.SH NAME
+gearman_execute_map_reduce \- Gearmand Documentation
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH LIBRARY
+.sp
+C Client Library for Gearmand (libgearman, \-lgearman)
+.SH SYNOPSIS
+.sp
+#include <libgearman/gearman.h>
+.INDENT 0.0
+.TP
+.B gearman_task_st *gearman_execute_map_reduce(gearman_client_st *client, const char *mapper_name, const size_t mapper_length, const char *reducer_name, const size_t reducer_length, const char *unique_str, const size_t unique_length, gearman_work_t *workload, gearman_argument_t *arguments);
+.UNINDENT
+.SH DESCRIPTION
+.sp
+gearman_client_execute_reduce() takes a given :c:type::\fIgearman_argument_t\fP and executs it against a :c:type::\fIgearman_mapper_fn\fP function. This function is specified via the
+mapper_name argument. The mapper function will then break the work up into units, and send each of them to the function named reducer function. Once all work is completed, the mapper function will aggregate the work and return a result.
+.sp
+If any of the units of work error, the job will be aborted. The resulting value will be stored in the :c:type::\fIgearman_task_st\fP.
+.SH RETURN
+.sp
+gearman_client_execute_reduce() returns a pointer to a gearman_task_st. On error a NULL will be returned. The error can be examined with c:function::\fIgearman_client_error()\fP.
+.SH HOME
+.sp
+To find out more information please check:
+\fI\%https://launchpad.net/gearmand\fP
+.SH SEE ALSO
+.sp
+\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_strerror(3)\fP \fIgearman_client_error\fP
+.SH AUTHOR
+Data Differential http://datadifferential.com/
+.SH COPYRIGHT
+2011, Data Differential, http://datadifferential.com/
+.\" Generated by docutils manpage writer.
+.\" 
+.

docs/man/gearman_worker_set_namespace.3

@@ -0,0 +1,68 @@
+.TH "GEARMAN_WORKER_SET_NAMESPACE" "3" "May 24, 2011" "0.20" "Gearmand"
+.SH NAME
+gearman_worker_set_namespace \- Gearmand Documentation
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.sp
+#include <libgearman/gearman.h>
+.INDENT 0.0
+.TP
+.B void gearman_client_set_namespace(gearman_client_st\fI\ *self\fP, const char\fI\ *namespace_key\fP, size_t\fI\ namespace_key_size\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void gearman_worker_set_namespace(gearman_worker_st\fI\ *self\fP, const char\fI\ *namespace_key\fP, size_t\fI\ namespace_key_size\fP)
+.UNINDENT
+.sp
+Compile and link with \-lgearman
+.SH DESCRIPTION
+.sp
+gearman_client_set_namespace() and gearman_worker_set_namespace() set a "namespace" for a given set of functions. Only clients and workers sharing a \fBnamespace_key\fP can
+see one anothers workloads and functions.
+.sp
+By setting \fBnamespace_key\fP to NULL you can disable the namespace.
+.SH RETURN
+.sp
+None
+.SH HOME
+.sp
+To find out more information please check:
+\fI\%https://launchpad.net/gearmand\fP
+.SH SEE ALSO
+.sp
+\fIgearmand(8)\fP \fIlibgearman(3)\fP
+.SH AUTHOR
+Data Differential http://datadifferential.com/
+.SH COPYRIGHT
+2011, Data Differential, http://datadifferential.com/
+.\" Generated by docutils manpage writer.
+.\" 
+.