HADOOP-12242. Add in-page TOC to filesystem specification pages. (iwasakims)

hadoop-common-project/hadoop-common/src/site/markdown/filesystem/extending.md

@@ -14,6 +14,8 @@
 
 # Extending the File System specification and its tests
 
+<!-- MACRO{toc|fromDepth=1|toDepth=2} -->
+
 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

hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md

@@ -19,9 +19,7 @@
 
 # class `org.apache.hadoop.fs.FileSystem`
 
-* [Invariants](#Invariants)
+<!-- MACRO{toc|fromDepth=1|toDepth=2} -->
-* [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.

hadoop-common-project/hadoop-common/src/site/markdown/filesystem/fsdatainputstream.md

@@ -16,8 +16,11 @@
 <!--  CLASS: FSDataInputStream -->
 <!--  ============================================================= -->
 
+# class `org.apache.hadoop.fs.FSDataInputStream`
 
-# Class `FSDataInputStream extends DataInputStream`
+<!-- MACRO{toc|fromDepth=1|toDepth=2} -->
+
+## 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

hadoop-common-project/hadoop-common/src/site/markdown/filesystem/introduction.md

@@ -14,6 +14,8 @@
 
 # Introduction
 
+<!-- MACRO{toc|fromDepth=1|toDepth=2} -->
+
 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.

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)
+<!-- MACRO{toc|fromDepth=1|toDepth=3} -->
-    * [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
 

hadoop-common-project/hadoop-common/src/site/markdown/filesystem/notation.md

@@ -15,6 +15,8 @@
 
 # Notation
 
+<!-- MACRO{toc|fromDepth=1|toDepth=3} -->
+
 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.

hadoop-common-project/hadoop-common/src/site/markdown/filesystem/testing.md

@@ -14,6 +14,8 @@
 
 # Testing the Filesystem Contract
 
+<!-- MACRO{toc|fromDepth=1|toDepth=3} -->
+
 ## Running the tests
 
 A normal Hadoop test run will test those FileSystems that can be tested locally