Bug #90683 ndb_logevent_get_fd() docs doesn't mention the primary usecase of this fuction
Submitted: 30 Apr 2018 6:38 Modified: 18 May 2018 12:36
Reporter: Daniël van Eeden Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Cluster: Documentation Severity:S3 (Non-critical)
Version:ALL OS:Any
Assigned to: Jon Stephens CPU Architecture:Any

[30 Apr 2018 6:38] Daniël van Eeden 
Description:
Page: https://dev.mysql.com/doc/ndbapi/en/mgm-ndb-logevent-get-fd.html

This function returns a file descriptor, but there is a warning that one should not attempt to read from it. To me this sounds like a somewhat useless function.

However storage/ndb/include/mgmapi/mgmapi.h says:
"Retrieve filedescriptor from NdbLogEventHandle.  May be used in e.g. an application select() statement."

So the main usecase is to use it in a select() statement.
I think the documentation should mention that.

How to repeat:
See description

Suggested fix:
Update docs
[30 Apr 2018 7:34] MySQL Verification Team 
Hello Daniël,

Thank you for the report and feedback!

Thanks,
Umesh
[8 May 2018 13:53] Jon Stephens 
Fixed in mysqldoc rev 57285. Closed.
[18 May 2018 12:36] Daniël van Eeden 
Closed