Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 1CDEE200B44 for ; Thu, 30 Jun 2016 00:21:39 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 1BB2C160A6E; Wed, 29 Jun 2016 22:21:39 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 45FFB160A57 for ; Thu, 30 Jun 2016 00:21:38 +0200 (CEST) Received: (qmail 88605 invoked by uid 500); 29 Jun 2016 22:21:37 -0000 Mailing-List: contact common-commits-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list common-commits@hadoop.apache.org Received: (qmail 88595 invoked by uid 99); 29 Jun 2016 22:21:37 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 29 Jun 2016 22:21:37 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 2402AE5CE1; Wed, 29 Jun 2016 22:21:37 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: iwasakims@apache.org To: common-commits@hadoop.apache.org Message-Id: <2d1075ad4a134c74bb514dc2c2694f78@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: hadoop git commit: HADOOP-12242. Add in-page TOC to filesystem specification pages. (iwasakims) Date: Wed, 29 Jun 2016 22:21:37 +0000 (UTC) archived-at: Wed, 29 Jun 2016 22:21:39 -0000 Repository: hadoop Updated Branches: refs/heads/trunk e4a254562 -> 5c07c573d HADOOP-12242. Add in-page TOC to filesystem specification pages. (iwasakims) Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/5c07c573 Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/5c07c573 Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/5c07c573 Branch: refs/heads/trunk Commit: 5c07c573db06481c89f1c9ad062e2d2aa19feaa0 Parents: e4a2545 Author: Masatake Iwasaki Authored: Thu Jun 30 07:20:46 2016 +0900 Committer: Masatake Iwasaki Committed: Thu Jun 30 07:21:08 2016 +0900 ---------------------------------------------------------------------- .../src/site/markdown/filesystem/extending.md | 2 ++ .../src/site/markdown/filesystem/filesystem.md | 4 +--- .../src/site/markdown/filesystem/fsdatainputstream.md | 9 ++++++--- .../src/site/markdown/filesystem/introduction.md | 4 +++- .../src/site/markdown/filesystem/model.md | 14 +------------- .../src/site/markdown/filesystem/notation.md | 2 ++ .../src/site/markdown/filesystem/testing.md | 2 ++ 7 files changed, 17 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hadoop/blob/5c07c573/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/extending.md ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/extending.md b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/extending.md index a09fea8..fa3e7b0 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/extending.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/extending.md @@ -14,6 +14,8 @@ # Extending the File System specification and its tests + + The FileSystem specification is incomplete. It doesn't cover all operations or even interfaces and classes in the FileSystem APIs. There may be some minor issues with those that it does cover, such http://git-wip-us.apache.org/repos/asf/hadoop/blob/5c07c573/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md index 442655e..abbcf6d 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md @@ -19,9 +19,7 @@ # class `org.apache.hadoop.fs.FileSystem` -* [Invariants](#Invariants) -* [Predicates and other state access operations](#Predicates_and_other_state_access_operations) -* [State Changing Operations](#State_Changing_Operations) + The abstract `FileSystem` class is the original class to access Hadoop filesystems; non-abstract subclasses exist for all Hadoop-supported filesystems. http://git-wip-us.apache.org/repos/asf/hadoop/blob/5c07c573/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/fsdatainputstream.md ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/fsdatainputstream.md b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/fsdatainputstream.md index e656d6f..adecd57 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/fsdatainputstream.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/fsdatainputstream.md @@ -16,8 +16,11 @@ +# class `org.apache.hadoop.fs.FSDataInputStream` -# Class `FSDataInputStream extends DataInputStream` + + +## Class `FSDataInputStream extends DataInputStream` The core behavior of `FSDataInputStream` is defined by `java.io.DataInputStream`, with extensions that add key assumptions to the system. @@ -303,7 +306,7 @@ on the underlying stream: Note that implementations are not required to be atomic; the intermediate state of the operation (the change in the value of `getPos()`) may be visible. -#### Implementation preconditions +### Implementation preconditions Not all `FSDataInputStream` implementations support these operations. Those that do not implement `Seekable.seek()` do not implement the `PositionedReadable` @@ -322,7 +325,7 @@ of `pos` is unchanged at the end of the operation pos(FSDIS') == pos(FSDIS) -#### Failure states +### Failure states For any operations that fail, the contents of the destination `buffer` are undefined. Implementations may overwrite part http://git-wip-us.apache.org/repos/asf/hadoop/blob/5c07c573/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/introduction.md ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/introduction.md b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/introduction.md index e451fa1..22b39d4 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/introduction.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/introduction.md @@ -14,6 +14,8 @@ # Introduction + + This document defines the required behaviors of a Hadoop-compatible filesystem for implementors and maintainers of the Hadoop filesystem, and for users of the Hadoop FileSystem APIs @@ -57,7 +59,7 @@ By making each aspect of the contract tests configurable, it is possible to declare how a filesystem diverges from parts of the standard contract. This is information which can be conveyed to users of the filesystem. -### Naming +## Naming This document follows RFC 2119 rules regarding the use of MUST, MUST NOT, MAY, and SHALL. MUST NOT is treated as normative. http://git-wip-us.apache.org/repos/asf/hadoop/blob/5c07c573/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/model.md ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/model.md b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/model.md index c458671..e04a640 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/model.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/model.md @@ -14,19 +14,7 @@ # A Model of a Hadoop Filesystem -* [Paths and Path Elements](#Paths_and_Path_Elements) - * [Predicates and Functions](#Predicates_and_Functions) - * [Notes for relative paths](#Notes_for_relative_paths) -* [Defining the Filesystem](#Defining_the_Filesystem) - * [Directory references](#Directory_references) - * [File references](#File_references) - * [Symbolic references](#Symbolic_references) - * [File Length](#File_Length) - * [User home](#User_home) - * [Exclusivity](#Exclusivity) - * [Encryption Zone](#Encryption_Zone) -* [Notes](#Notes) - + ## Paths and Path Elements http://git-wip-us.apache.org/repos/asf/hadoop/blob/5c07c573/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/notation.md ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/notation.md b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/notation.md index 2b5ece8..aa310f8 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/notation.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/notation.md @@ -15,6 +15,8 @@ # Notation + + A formal notation such as [The Z Notation](http://www.open-std.org/jtc1/sc22/open/n3187.pdf) would be the strictest way to define Hadoop FileSystem behavior, and could even be used to prove some axioms. http://git-wip-us.apache.org/repos/asf/hadoop/blob/5c07c573/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/testing.md ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/testing.md b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/testing.md index 99561cd..6619332 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/testing.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/filesystem/testing.md @@ -14,6 +14,8 @@ # Testing the Filesystem Contract + + ## Running the tests A normal Hadoop test run will test those FileSystems that can be tested locally --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscribe@hadoop.apache.org For additional commands, e-mail: common-commits-help@hadoop.apache.org