MySQL Bugs: #38678: Error in the ndb

Bug #38678	Error in the ndb_mgm API documentation
Submitted:	8 Aug 2008 19:28	Modified:	12 Aug 2008 12:44
Reporter:	Andrew Hutchings	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Server: Documentation	Severity:	S3 (Non-critical)
Version:	5.1+	OS:	Any
Assigned to:	Jon Stephens	CPU Architecture:	Any

View
Add Comment
Files
Developer
Edit Submission
View Progress Log
Contributions

Description:
In the manual for ndb_mgm_check_connection() it states:

Return Value. A nonzero value indicates that the management server responded and that the connection to it did not time out.

But according to the code a -1 means management node didn't respond and 0 means all clear.

How to repeat:
Compare manual to mgmapi.cpp

Suggested fix:
Change manual to say:

Return Value. A zero value indicates that the management server responded and that the connection to it did not time out.

Thank you for your bug report. This issue has been addressed in the documentation. The updated documentation will appear on our website shortly, and will be included in the next release of the relevant products.