MySQL Bugs: #32273: Client flag CLIENT_IGNORE

Bug #32273	Client flag CLIENT_IGNORE_SIGPIPE undocumented
Submitted:	12 Nov 2007 11:19	Modified:	27 Nov 2007 15:55
Reporter:	Hartmut Holzgraefe	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Server: Documentation	Severity:	S3 (Non-critical)
Version:		OS:	Any
Assigned to:	Paul DuBois	CPU Architecture:	Any

Description:
The CLIENT_IGNORE_SIGPIPE flag that can be used to 
prevent libmysqlclient from installing its own
SIGPIPE signal handler to avoid conflicts with
a signal handler already installed by the application
using mysql is not documented anywhere.

The flag is defined in ./libmysql/client_settings.h

There are other flags not documented, these are all
set implicitly in CLIENT_CAPABILITIES in ./libmysql/client_settings.h
though so there doesn't seem to be any need to document
these options as they are implicitly enabled depending
on the client version used and not meant to be user
settable, so CLIENT_IGNORE_SIGPIPE seems to be the
only flag that is meant to be user settable but not
documented.

CLIENT_IGNORE_SIGPIPE is tested for in the code but it is never set
or reset implicitly in the server code IMHO it is clearly supposed
to be a user settable connection option and should be documented
as such.

How to repeat:
Search documentation for CLIENT_IGNORE_SIGPIPE,
it is not listed on 

http://dev.mysql.com/doc/refman/5.0/en/mysql-real-connect.html

Suggested fix:
document the flag

Thank you for the bug report.

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.