Bug 14099 - tevent_wait_* functions not documented
Summary: tevent_wait_* functions not documented
Alias: None
Product: Samba 4.1 and newer
Classification: Unclassified
Component: File services (show other bugs)
Version: unspecified
Hardware: All All
: P5 minor (vote)
Target Milestone: ---
Assignee: Volker Lendecke
QA Contact: Samba QA Contact
Depends on:
Reported: 2019-08-22 15:51 UTC by Sachin Prabhu
Modified: 2019-08-23 06:15 UTC (History)
1 user (show)

See Also:


Note You need to log in before you can comment on or make changes to this bug.
Description Sachin Prabhu 2019-08-22 15:51:11 UTC
tevent_wait_send() and tevent_wait_recv() are not documented but used quiet frequently for tevent async calls in the samba code.
Comment 1 Volker Lendecke 2019-08-23 06:15:27 UTC
There is exactly one place where those functions are used: For doing deferred closes in the s3 file server. The implementation contains the comment

 * Just wait for getting a tevent_wait_done. tevent_wait_done can deal with a
 * NULL request.

Correct, the file does not contain proper doxygen comments, but such a rarely used smbd-internal helper function does not require full doxygen documentation from my point of view. We don't yet have the formal requirement to document each and every function properly in our README.Coding, so I'm closing this one as WONTFIX.