[PATCH] tevent docu fixes

Volker Lendecke vl at samba.org
Mon Sep 12 13:54:53 UTC 2016


Hi!

Review appreciated!

Thanks, Volker

P.S: When they go through, how do we upload them to tevent.samba.org??
-------------- next part --------------
>From 94a96996543e65a25086544693a3cb35d74c4961 Mon Sep 17 00:00:00 2001
From: Volker Lendecke <vl at samba.org>
Date: Sun, 11 Sep 2016 09:28:35 +0200
Subject: [PATCH 1/2] tevent_tutorial: Fix typos

Signed-off-by: Volker Lendecke <vl at samba.org>
---
 lib/tevent/doc/tevent_context.dox | 2 +-
 lib/tevent/doc/tevent_queue.dox   | 5 +++--
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/lib/tevent/doc/tevent_context.dox b/lib/tevent/doc/tevent_context.dox
index 1036d3c..39eb85e 100644
--- a/lib/tevent/doc/tevent_context.dox
+++ b/lib/tevent/doc/tevent_context.dox
@@ -67,7 +67,7 @@ event again. There are 2 types of loop available for use in tevent library:
 <li>int tevent_loop_once()</li>
 </ul>
 
-Both of functions accept just one parametr (tevent context) and the only
+Both of functions accept just one parameter (tevent context) and the only
 difference lies in the fact that the first loop can theoretically last for ever
 but the second one will wait just for a single one event to catch and then the
 loop breaks and the program continue.
diff --git a/lib/tevent/doc/tevent_queue.dox b/lib/tevent/doc/tevent_queue.dox
index fef98c8..9c247e5 100644
--- a/lib/tevent/doc/tevent_queue.dox
+++ b/lib/tevent/doc/tevent_queue.dox
@@ -11,7 +11,8 @@ beginning of the queue as fast as possible. In tevent library it is
 similar, but the queue is not automatically set for any event. The queue has to
 be created on purpose, and events which should follow the order of the FIFO
 queue have to be explicitly pinpointed. Creating such a queue is crucial in
-situations when sequential processing is absolutely essential for the succesful
+situations when sequential processing is absolutely essential for the
+successful
 completion of a task, e.g. for a large quantity of data that are about to be
 written from a buffer into a socket. The tevent library has its own queue
 structure that is ready to use after it has been initialized and started up
@@ -20,7 +21,7 @@ once.
 @subsection cr_queue Creation of Queues
 
 The first and most important step is the creation of the tevent queue
-(represented by struct tevent queue), which will then be in running mode.
+(represented by struct tevent_queue), which will then be in running mode.
 
 @code
 struct tevent_queue* tevent_queue_create (TALLOC_CTX *mem_ctx, const char *name)
-- 
2.1.4


>From 3a449d696db0d6bdc01448401847e12ef1057d75 Mon Sep 17 00:00:00 2001
From: Volker Lendecke <vl at samba.org>
Date: Sun, 11 Sep 2016 09:28:35 +0200
Subject: [PATCH 2/2] tevent_tutorial: Fix tevent_thread referencing

Signed-off-by: Volker Lendecke <vl at samba.org>
---
 lib/tevent/doc/tevent_thread.dox | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/tevent/doc/tevent_thread.dox b/lib/tevent/doc/tevent_thread.dox
index 7b45820..875dae8 100644
--- a/lib/tevent/doc/tevent_thread.dox
+++ b/lib/tevent/doc/tevent_thread.dox
@@ -1,7 +1,7 @@
 /**
- at page tevent_context Chapter 6: Tevent with threads
+ at page tevent_thread Chapter 6: Tevent with threads
 
- at section context Tevent with threads
+ at section threads Tevent with threads
 
 In order to use tevent with threads, you must first understand
 how to use the talloc library in threaded programs. For more
-- 
2.1.4



More information about the samba-technical mailing list