Tassapol Athiapinya created YARN-1080:
-----------------------------------------
Summary: Standardize help message for required parameter of $ yarn logs
Key: YARN-1080
URL: https://issues.apache.org/jira/browse/YARN-1080
Project: Hadoop YARN
Issue Type: Improvement
Components: client
Reporter: Tassapol Athiapinya
Fix For: 2.1.0-beta
YARN CLI has a command "logs" ($ yarn logs). The command always requires a parameter of "-applicationId <arg>". However, help message of the command does not make it clear. It lists -applicationId as optional parameter. If I don't set it, YARN CLI will complain this is missing. It is better to use standard required notation used in other Linux command for help message. Any user familiar to the command can understand that this parameter is needed more easily.
{code:title=current help message}
-bash-4.1$ yarn logs
usage: general options are:
-applicationId <arg> ApplicationId (required)
-appOwner <arg> AppOwner (assumed to be current user if not
specified)
-containerId <arg> ContainerId (must be specified if node address is
specified)
-nodeAddress <arg> NodeAddress in the format nodename:port (must be
specified if container id is specified)
{code}
{code:title=proposed help message}
-bash-4.1$ yarn logs
usage: yarn logs -applicationId <application ID> [OPTIONS]
general options are:
-appOwner <arg> AppOwner (assumed to be current user if not
specified)
-containerId <arg> ContainerId (must be specified if node address is
specified)
-nodeAddress <arg> NodeAddress in the format nodename:port (must be
specified if container id is specified)
{code}
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira