1
0
mirror of https://github.com/samba-team/samba.git synced 2025-01-11 05:18:09 +03:00

tevent: document tevent_req_create state zeroing

Signed-off-by: David Disseldorp <ddiss@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>

Autobuild-User(master): Volker Lendecke <vl@samba.org>
Autobuild-Date(master): Mon Jul  8 20:43:49 CEST 2013 on sn-devel-104
This commit is contained in:
David Disseldorp 2013-07-08 15:11:25 +02:00 committed by Volker Lendecke
parent e322420dc7
commit e6f79b9489

View File

@ -919,9 +919,9 @@ bool _tevent_req_cancel(struct tevent_req *req, const char *location);
* req = tevent_req_create(mem_ctx, &state, struct computation_state);
* @endcode
*
* Tevent_req_create() creates the state variable as a talloc child of
* its result. The state variable should be used as the talloc parent
* for all temporary variables that are allocated during the async
* Tevent_req_create() allocates and zeros the state variable as a talloc
* child of its result. The state variable should be used as the talloc
* parent for all temporary variables that are allocated during the async
* computation. This way, when the user of the async computation frees
* the request, the state as a talloc child will be free'd along with
* all the temporary variables hanging off the state.