From 4b65d10cfe4aac52b64231f89a28ad0d0d0f847f Mon Sep 17 00:00:00 2001 From: Tsz-wo Sze Date: Fri, 25 Nov 2011 13:58:29 +0000 Subject: [PATCH] HDFS-2590. Fix the missing links in the WebHDFS forrest doc. git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@1206178 13f79535-47bb-0310-9956-ffa450edef68 --- hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt | 2 + .../src/documentation/content/xdocs/site.xml | 16 +--- .../documentation/content/xdocs/webhdfs.xml | 91 +++++++++---------- 3 files changed, 50 insertions(+), 59 deletions(-) diff --git a/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt b/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt index 0de15ecc3b..a3dd8173ff 100644 --- a/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt +++ b/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt @@ -185,6 +185,8 @@ Release 0.23.1 - UNRELEASED HDFS-2575. DFSTestUtil may create empty files (todd) HDFS-2588. hdfs jsp pages missing DOCTYPE. (Dave Vronay via mattf) + + HDFS-2590. Fix the missing links in the WebHDFS forrest doc. (szetszwo) Release 0.23.0 - 2011-11-01 diff --git a/hadoop-hdfs-project/hadoop-hdfs/src/main/docs/src/documentation/content/xdocs/site.xml b/hadoop-hdfs-project/hadoop-hdfs/src/main/docs/src/documentation/content/xdocs/site.xml index b874eb3aee..19cc1b592b 100644 --- a/hadoop-hdfs-project/hadoop-hdfs/src/main/docs/src/documentation/content/xdocs/site.xml +++ b/hadoop-hdfs-project/hadoop-hdfs/src/main/docs/src/documentation/content/xdocs/site.xml @@ -43,7 +43,7 @@ See http://forrest.apache.org/docs/linking.html for more info. - + @@ -120,16 +120,10 @@ See http://forrest.apache.org/docs/linking.html for more info. - - - - - - - + @@ -145,13 +139,11 @@ See http://forrest.apache.org/docs/linking.html for more info. - - - - + + diff --git a/hadoop-hdfs-project/hadoop-hdfs/src/main/docs/src/documentation/content/xdocs/webhdfs.xml b/hadoop-hdfs-project/hadoop-hdfs/src/main/docs/src/documentation/content/xdocs/webhdfs.xml index ad5f99e9d6..e0c56eaa22 100644 --- a/hadoop-hdfs-project/hadoop-hdfs/src/main/docs/src/documentation/content/xdocs/webhdfs.xml +++ b/hadoop-hdfs-project/hadoop-hdfs/src/main/docs/src/documentation/content/xdocs/webhdfs.xml @@ -44,74 +44,71 @@

Operations - @@ -148,7 +145,7 @@

When security is off, the authenticated user is the username specified in the user.name query parameter. If the user.name parameter is not set, - the server may either set the authenticated user to a default web user, if there is any, or return error response. + the server may either set the authenticated user to a default web user, if there is any, or return an error response.

When security is on, authentication is performed by either Hadoop delegation token or Kerberos SPNEGO. @@ -237,15 +234,15 @@ Content-Length: 0 -

- Note that the reason of having two-step create/append is +

+ Note that the reason of having two-step create/append is for preventing clients to send out data before the redirect. This issue is addressed by the "Expect: 100-continue" header in HTTP/1.1; see RFC 2616, Section 8.2.3. Unfortunately, there are software library bugs (e.g. Jetty 6 HTTP server and Java 6 HTTP client), which do not correctly implement "Expect: 100-continue". The two-step create/append is a temporary workaround for the software library bugs. -

+

See also: overwrite, @@ -253,7 +250,7 @@ Content-Length: 0 replication, permission, buffersize, - DistributedFileSystem.create + FileSystem.create

@@ -288,7 +285,7 @@ Content-Length: 0

See also: buffersize, - DistributedFileSystem.append + FileSystem.append

@@ -321,7 +318,7 @@ Hello, webhdfs user! offset, length, buffersize, - DistributedFileSystem.open + FileSystem.open

@@ -345,7 +342,7 @@ Transfer-Encoding: chunked

See also: permission, - DistributedFileSystem.mkdirs + FileSystem.mkdirs

@@ -369,7 +366,7 @@ Transfer-Encoding: chunked

See also: destination, - DistributedFileSystem.rename + FileSystem.rename

@@ -394,7 +391,7 @@ Transfer-Encoding: chunked

See also: recursive, - DistributedFileSystem.delete + FileSystem.delete

@@ -431,7 +428,7 @@ Transfer-Encoding: chunked

See also: - DistributedFileSystem.getFileStatus + FileSystem.getFileStatus

@@ -486,7 +483,7 @@ Content-Length: 427

See also: - DistributedFileSystem.listStatus + FileSystem.listStatus

@@ -523,7 +520,7 @@ Transfer-Encoding: chunked

See also: - DistributedFileSystem.getContentSummary + FileSystem.getContentSummary

@@ -559,7 +556,7 @@ Transfer-Encoding: chunked

See also: - DistributedFileSystem.getFileChecksum + FileSystem.getFileChecksum

@@ -582,7 +579,7 @@ Transfer-Encoding: chunked

See also: - DistributedFileSystem.getHomeDirectory + FileSystem.getHomeDirectory

@@ -604,7 +601,7 @@ Content-Length: 0

See also: permission, - DistributedFileSystem.setPermission + FileSystem.setPermission

@@ -627,7 +624,7 @@ Content-Length: 0 See also: owner, group, - DistributedFileSystem.setOwner + FileSystem.setOwner

@@ -652,7 +649,7 @@ Transfer-Encoding: chunked

See also: replication, - DistributedFileSystem.setReplication + FileSystem.setReplication

@@ -675,7 +672,7 @@ Content-Length: 0 See also: modificationtime, accesstime, - DistributedFileSystem.setTimes + FileSystem.setTimes

@@ -708,7 +705,7 @@ Transfer-Encoding: chunked

See also: renewer, - DistributedFileSystem.getDelegationToken + FileSystem.getDelegationToken

@@ -732,7 +729,7 @@ Transfer-Encoding: chunked

See also: token, - DistributedFileSystem.renewDelegationToken + DistributedFileSystem.renewDelegationToken

@@ -753,7 +750,7 @@ Content-Length: 0

See also: token, - DistributedFileSystem.cancelDelegationToken + DistributedFileSystem.cancelDelegationToken

@@ -778,7 +775,7 @@ Content-Length: 0 RumtimeException 500 Internal Server Error

- Below are examples of exception response. + Below are examples of exception responses.

@@ -859,9 +856,9 @@ Transfer-Encoding: chunked
JSON Schemas

-All operations, except for OPEN, +All operations, except for OPEN, either return a zero-length response or a JSON response . -For OPEN, the response is an octet-stream. +For OPEN, the response is an octet-stream. The JSON schemas are shown below. See draft-zyp-json-schema-03 for the syntax definitions of the JSON schemas. @@ -1299,7 +1296,7 @@ var fileStatusProperties = SyntaxSee the note below.

- Note that delegation tokens are encoded as a URL safe string; + Note that delegation tokens are encoded as a URL safe string; see encodeToUrlString() and decodeFromUrlString(String) in org.apache.hadoop.security.token.Token for the details of the encoding.