From 1e0cc178c73bfdaaaaacf800c895e89d53552a99 Mon Sep 17 00:00:00 2001
From: Todd Lipcon <todd@apache.org>
Date: Sat, 14 May 2011 04:33:08 +0000
Subject: [PATCH] HADOOP-7192. Update fs -stat docs to reflect the format
 features. Contributed by Harsh J Chouraria.

git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@1102951 13f79535-47bb-0310-9956-ffa450edef68
---
 CHANGES.txt                                   |  3 +++
 .../content/xdocs/file_system_shell.xml       | 23 +++++++++++++++----
 2 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/CHANGES.txt b/CHANGES.txt
index b5009aef07..e741002960 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -456,6 +456,9 @@ Release 0.22.0 - Unreleased
     HADOOP-7189. Add ability to enable 'debug' property in JAAS configuration.
     (Ted Yu via todd)
 
+    HADOOP-7192. Update fs -stat docs to reflect the format features. (Harsh
+    J Chouraria via todd)
+
   OPTIMIZATIONS
 
     HADOOP-6884. Add LOG.isDebugEnabled() guard for each LOG.debug(..).
diff --git a/src/docs/src/documentation/content/xdocs/file_system_shell.xml b/src/docs/src/documentation/content/xdocs/file_system_shell.xml
index 54429b0eb6..eaf5e3cc5e 100644
--- a/src/docs/src/documentation/content/xdocs/file_system_shell.xml
+++ b/src/docs/src/documentation/content/xdocs/file_system_shell.xml
@@ -482,16 +482,29 @@
 		<section>
 			<title> stat </title>
 			<p>
-				<code>Usage: hdfs dfs -stat URI [URI &#x2026;]</code>
+				<code>Usage: hdfs dfs -stat [format] URI [URI &#x2026;]</code>
 			</p>
-			<p>
-	   Returns the stat information on the path.
-	   </p>
+			<p>Print statistics about the file/directory matching the given URI pattern in the specified format.</p>
+			<p>Format accepts:</p>
+			  <ul>
+			    <li>filesize in blocks (%b)</li>
+			    <li>filename (%n)</li>
+		      <li>block size (%o)</li>
+		      <li>replication (%r)</li>
+		      <li>modification date, formatted as Y-M-D H:M:S (%y)</li>
+		      <li>modification date, in epoch seconds (%Y)</li>
+        </ul>
 			<p>Example:</p>
 			<ul>
+        <li>
+          <code> hdfs dfs -stat path </code>
+        </li>
 				<li>
-					<code> hdfs dfs -stat path </code>
+					<code> hdfs dfs -stat %y path </code>
 				</li>
+        <li>
+          <code> hdfs dfs -stat '%b %r' path </code>
+        </li>
 			</ul>
 			<p>Exit Code:<br/>
 	   <code> Returns 0 on success and -1 on error.</code></p>