MySQL Bugs: #38713: --relay-log* server option forms inconsistent in docs

Bug #38713	--relay-log* server option forms inconsistent in docs
Submitted:	11 Aug 2008 9:48	Modified:	17 Sep 2008 8:49
Reporter:	Jon Stephens	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Server: Documentation	Severity:	S3 (Non-critical)
Version:	all	OS:	Any
Assigned to:	Jon Stephens	CPU Architecture:	Any

Description:
The server options affecting the relay log are not shown in a consistent fashion with regard to underscores and dashes.

For example, we have --relay-log and --relay-log-index but --max_relay_log_size and --relay_log_purge

How to repeat:
grep "relay" mysqldoc/trunk/dynamic-docs/command-optvars/mysqld.xml

Suggested fix:
Canonical form for server options should use dashes (e.g. --relay-log).

foreach($relay_log_server_options_shown_using_underscores as $option)
{
  if(eval '`mysqld --' . str_replace($option, '_', '-') . '`')
  {
    str_replace($option, '_', '-');
    add_note('This option can also be invoked using underscores rather than dashes 
              in the option name; however, the form using dashes is preferred.');
  }
  else
    file_bug('$option should support dashes in name when invoked as server option');
}

Rather than do this piecemeal, it would be much better to regularise all server option documentation at one time, so I've closed this bug and created WL#4544 to take its place.