MySQL Bugs: #65019: MCM help should list mcm commands, not CLI help

Bug #65019	MCM help should list mcm commands, not CLI help
Submitted:	18 Apr 2012 9:01	Modified:	21 Jun 2014 7:54
Reporter:	Mario Beck	Email Updates:
Status:	Verified	Impact on me:	None
Category:	MySQL Cluster Manager: CLI	Severity:	S4 (Feature request)
Version:	1.1.5, 1.3.1	OS:	Any
Assigned to:		CPU Architecture:	Any
Tags:	mcm help

Description:
When starting the mcm client, it reports:
"Type 'help;' for help." 
But this does not give you help for mcm.
It is the usual mysql CLI help which does not help you at all with mcm.
There is no hint to run "list commands".

How to repeat:
Start the mcm CLI. Watch the output.

Suggested fix:
EIther modify the initial printout to
"Enter 'list commands;' to get help."
Or intercept the "help" command to run "list commands" instead.

Hi Mario,

Thank you for the report.

MCM client is a software application used to access an MCM agent and the client is actually nothing more than the mysql command-line client, started with options that are necessary for it to connect to an MCM agent. 

Please note that this is a know behavior and online help is available in the MySQL Cluster Manager client for MySQL Cluster Manager client commands. 

Workaround:

As you noted in report,  for a list of all commands with brief descriptions, use the "list commands" command.

To obtain more detailed help specific to a given command, invoke the command using the --help option

//snippet

[ushastry@cluster-repo mcm]$ cluster/bin/mysql -h127.0.0.1 -P1862 -uadmin -psuper --prompt='mcm> '
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 1
Server version: 1.2.2 MySQL Cluster Manager

Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mcm> list commands;
+---------------------------------------------------------------------+
| Help                                                                |
+---------------------------------------------------------------------+
| COMMANDS                                                            |
|                                                                     |
| abort backup         Abort an ongoing cluster backup.               |
| add hosts            Add hosts to site.                             |
| add package          Add a package alias.                           |
| add process          Add cluster process.                           |
| backup cluster       Backup a cluster.                              |
| change process       Change process type.                           |
| create cluster       Create a cluster.                              |
| create site          Create a site.                                 |
| delete cluster       Delete a cluster.                              |
| delete package       Delete a package.                              |
| delete site          Delete a site.                                 |
| get                  Get configuration variables.                   |
| list backups         List backup images.                            |
| list clusters        List all clusters.                             |
| list commands        List the help text.                            |
| list hosts           List hosts in site.                            |
| list nextnodeids     List next nodeids to be allocated.             |
| list packages        List all packages.                             |
| list processes       List processes.                                |
| list sites           List all sites.                                |
| reset                Reset configuration variables.                 |
| restart cluster      Restart a cluster.                             |
| restore cluster      Restore a cluster.                             |
| set                  Set configuration variables.                   |
| show status          Show cluster, process or operation status.     |
| start cluster        Start a cluster.                               |
| start process        Start a cluster process.                       |
| stop agents          Stop agents in site.                           |
| stop cluster         Stop a cluster.                                |
| stop process         Stop a cluster process.                        |
| upgrade cluster      Upgrade a cluster.                             |
| version              Print version information.                     |
|                                                                     |
| GLOBAL OPTIONS                                                      |
| Options that can be used with all commands                          |
|                                                                     |
|       --help|-?            Print detailed help.                     |
|                                                                     |
| Use '<COMMAND> --help' to see verbose help for individual commands. |
+---------------------------------------------------------------------+
41 rows in set (0.00 sec)

mcm>

snippet//

This is documented in - http://dev.mysql.com/doc/mysql-cluster-manager/1.1/en/mcm-information-commands.html

If I connect to a mysqld then at the end of the 'help;' command this is reported:
For server side help, type 'help contents'

But nothing is reported here if I connect to mcmd.

Maybe the mcmd has to implement a part of the server side help feature?

From client/mysql.cc:
  if (connected && mysql_get_server_version(&mysql) >= 40100)
    put_info("\nFor server side help, type 'help contents'\n", INFO_INFO);
  return 0;

So the client only checks the version, not if server side help is available and which command should be used.

Thank you for the feature request!

Thanks,
Umesh