You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by zj...@apache.org on 2015/03/13 00:04:57 UTC

[38/49] hadoop git commit: YARN-3295. Fix documentation nits found in markdown conversion. Contributed by Masatake Iwasaki.

YARN-3295. Fix documentation nits found in markdown conversion. Contributed by Masatake Iwasaki.


Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/30c428a8
Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/30c428a8
Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/30c428a8

Branch: refs/heads/YARN-2928
Commit: 30c428a858c179645d6dc82b7027f6b7e871b439
Parents: 5c1036d
Author: Tsuyoshi Ozawa <oz...@apache.org>
Authored: Wed Mar 11 15:02:24 2015 +0900
Committer: Tsuyoshi Ozawa <oz...@apache.org>
Committed: Wed Mar 11 15:02:24 2015 +0900

----------------------------------------------------------------------
 hadoop-yarn-project/CHANGES.txt                 |  3 +++
 .../src/site/markdown/ResourceManagerRestart.md |  6 ++---
 .../src/site/markdown/YarnCommands.md           | 28 ++++++++++----------
 3 files changed, 19 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/hadoop/blob/30c428a8/hadoop-yarn-project/CHANGES.txt
----------------------------------------------------------------------
diff --git a/hadoop-yarn-project/CHANGES.txt b/hadoop-yarn-project/CHANGES.txt
index d882f3e..8930045 100644
--- a/hadoop-yarn-project/CHANGES.txt
+++ b/hadoop-yarn-project/CHANGES.txt
@@ -749,6 +749,9 @@ Release 2.7.0 - UNRELEASED
     YARN-3300. Outstanding_resource_requests table should not be shown in AHS.
     (Xuan Gong via jianhe)
 
+    YARN-3295. Fix documentation nits found in markdown conversion.
+    (Masatake Iwasaki via ozawa)
+
 Release 2.6.0 - 2014-11-18
 
   INCOMPATIBLE CHANGES

http://git-wip-us.apache.org/repos/asf/hadoop/blob/30c428a8/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/ResourceManagerRestart.md
----------------------------------------------------------------------
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/ResourceManagerRestart.md b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/ResourceManagerRestart.md
index e516afb..d23505d 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/ResourceManagerRestart.md
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/ResourceManagerRestart.md
@@ -141,12 +141,10 @@ Notes
 -----
 
 ContainerId string format is changed if RM restarts with work-preserving recovery enabled. It used to be such format:
-
-    Container_{clusterTimestamp}_{appId}_{attemptId}_{containerId}, e.g. Container_1410901177871_0001_01_000005.
+`Container_{clusterTimestamp}_{appId}_{attemptId}_{containerId}`, e.g. `Container_1410901177871_0001_01_000005`.
 
 It is now changed to:
-
-    Container_e{epoch}_{clusterTimestamp}_{appId}_{attemptId}_{containerId}, e.g. Container_e17_1410901177871_0001_01_000005.
+`Container_`**e{epoch}**`_{clusterTimestamp}_{appId}_{attemptId}_{containerId}`, e.g. `Container_`**e17**`_1410901177871_0001_01_000005`.
  
 Here, the additional epoch number is a monotonically increasing integer which starts from 0 and is increased by 1 each time RM restarts. If epoch number is 0, it is omitted and the containerId string format stays the same as before.
 

http://git-wip-us.apache.org/repos/asf/hadoop/blob/30c428a8/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/YarnCommands.md
----------------------------------------------------------------------
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/YarnCommands.md b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/YarnCommands.md
index 28bb678..b4bed64 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/YarnCommands.md
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/YarnCommands.md
@@ -67,11 +67,11 @@ Usage: `yarn application [options] `
 
 | COMMAND\_OPTIONS | Description |
 |:---- |:---- |
-| -appStates States | Works with -list to filter applications based on input comma-separated list of application states. The valid application state can be one of the following:  ALL, NEW, NEW\_SAVING, SUBMITTED, ACCEPTED, RUNNING, FINISHED, FAILED, KILLED |
-| -appTypes Types | Works with -list to filter applications based on input comma-separated list of application types. |
+| -appStates \<States\> | Works with -list to filter applications based on input comma-separated list of application states. The valid application state can be one of the following:  ALL, NEW, NEW\_SAVING, SUBMITTED, ACCEPTED, RUNNING, FINISHED, FAILED, KILLED |
+| -appTypes \<Types\> | Works with -list to filter applications based on input comma-separated list of application types. |
 | -list | Lists applications from the RM. Supports optional use of -appTypes to filter applications based on application type, and -appStates to filter applications based on application state. |
-| -kill ApplicationId | Kills the application. |
-| -status ApplicationId | Prints the status of the application. |
+| -kill \<ApplicationId\> | Kills the application. |
+| -status \<ApplicationId\> | Prints the status of the application. |
 
 Prints application(s) report/kill application
 
@@ -82,8 +82,8 @@ Usage: `yarn applicationattempt [options] `
 | COMMAND\_OPTIONS | Description |
 |:---- |:---- |
 | -help | Help |
-| -list ApplicationId | Lists applications attempts from the RM |
-| -status Application Attempt Id | Prints the status of the application attempt. |
+| -list \<ApplicationId\> | Lists applications attempts for the given application. |
+| -status \<Application Attempt Id\> | Prints the status of the application attempt. |
 
 prints applicationattempt(s) report
 
@@ -100,8 +100,8 @@ Usage: `yarn container [options] `
 | COMMAND\_OPTIONS | Description |
 |:---- |:---- |
 | -help | Help |
-| -list ApplicationId | Lists containers for the application attempt. |
-| -status ContainerId | Prints the status of the container. |
+| -list \<Application Attempt Id\> | Lists containers for the application attempt. |
+| -status \<ContainerId\> | Prints the status of the container. |
 
 prints container(s) report
 
@@ -118,10 +118,10 @@ Usage: `yarn logs -applicationId <application ID> [options] `
 | COMMAND\_OPTIONS | Description |
 |:---- |:---- |
 | -applicationId \<application ID\> | Specifies an application id |
-| -appOwner AppOwner | AppOwner (assumed to be current user if not specified) |
-| -containerId ContainerId | ContainerId (must be specified if node address is specified) |
+| -appOwner \<AppOwner\> | AppOwner (assumed to be current user if not specified) |
+| -containerId \<ContainerId\> | ContainerId (must be specified if node address is specified) |
 | -help | Help |
-| -nodeAddress NodeAddress | NodeAddress in the format nodename:port (must be specified if container id is specified) |
+| -nodeAddress \<NodeAddress\> | NodeAddress in the format nodename:port (must be specified if container id is specified) |
 
 Dump the container logs
 
@@ -133,8 +133,8 @@ Usage: `yarn node [options] `
 |:---- |:---- |
 | -all | Works with -list to list all nodes. |
 | -list | Lists all running nodes. Supports optional use of -states to filter nodes based on node state, and -all to list all nodes. |
-| -states States | Works with -list to filter nodes based on input comma-separated list of node states. |
-| -status NodeId | Prints the status report of the node. |
+| -states \<States\> | Works with -list to filter nodes based on input comma-separated list of node states. |
+| -status \<NodeId\> | Prints the status report of the node. |
 
 Prints node report(s)
 
@@ -145,7 +145,7 @@ Usage: `yarn queue [options] `
 | COMMAND\_OPTIONS | Description |
 |:---- |:---- |
 | -help | Help |
-| -status QueueName | Prints the status of the queue. |
+| -status \<QueueName\> | Prints the status of the queue. |
 
 Prints queue information