Merge pull request #222 from jbech-linaro/user_guide_toc_links

Create TOC links in the User Guide markdown file
2015-01-07 17:29:38 +00:00 · 2015-01-07 17:29:38 +00:00 · 23cf7d0fcc
parent 61c6780474 14a5b346de
commit 23cf7d0fcc
6 changed files with 75 additions and 74 deletions
--- a/docs/cpu-specific-build-macros.md
+++ b/docs/cpu-specific-build-macros.md
@ -4,9 +4,10 @@ ARM CPU Specific Build Macros
 Contents
 --------
-1.  Introduction
+1.  [Introduction](#1--introduction)
-2.  CPU Errata Workarounds
+2.  [CPU Errata Workarounds](#2--cpu-errata-workarounds)
-3.  CPU Specific optimizations
+3.  [CPU Specific optimizations](#3--cpu-specific-optimizations)
 1.  Introduction
 ----------------
--- a/docs/firmware-design.md
+++ b/docs/firmware-design.md
@ -3,17 +3,17 @@ ARM Trusted Firmware Design
 Contents :
-1.  Introduction
+1.  [Introduction](#1--introduction)
-2.  Cold boot
+2.  [Cold boot](#2--cold-boot)
-3.  EL3 runtime services framework
+3.  [EL3 runtime services framework](#3--el3-runtime-services-framework)
-4.  Power State Coordination Interface
+4.  [Power State Coordination Interface](#4--power-state-coordination-interface)
-5.  Secure-EL1 Payloads and Dispatchers
+5.  [Secure-EL1 Payloads and Dispatchers](#5--secure-el1-payloads-and-dispatchers)
-6.  Crash Reporting in BL3-1
+6.  [Crash Reporting in BL3-1](#6--crash-reporting-in-bl3-1)
-7.  CPU specific operations framework
+7.  [CPU specific operations framework](#7--cpu-specific-operations-framework)
-8.  Memory layout of BL images
+8.  [Memory layout of BL images](#8-memory-layout-of-bl-images)
-9.  Firmware Image Package (FIP)
+9.  [Firmware Image Package (FIP)](#9--firmware-image-package-fip)
-10.  Code Structure
+10. [Code Structure](#10--code-structure)
-11.  References
+11. [References](#11--references)
 1.  Introduction
--- a/docs/interrupt-framework-design.md
+++ b/docs/interrupt-framework-design.md
@ -3,34 +3,34 @@ ARM Trusted Firmware Interrupt Management Design guide
 Contents :
-1.  Introduction
+1.  [Introduction](#1-introduction)
-    *    Assumptions
+    *   [Assumptions](#11-assumptions)
-    *    Concepts
+    *   [Concepts](#12-concepts)
-         -    Interrupt Types
+        -   [Interrupt Types](#121-interrupt-types)
-         -    Routing Model
+        -   [Routing Model](#122-routing-model)
-         -    Valid Routing Models
+        -   [Valid Routing Models](#123-valid-routing-models)
-              +    Secure-EL1 Interrupts
+            +   [Secure-EL1 Interrupts](#1231-secure-el1-interrupts)
-              +    Non-secure Interrupts
+            +   [Non-secure Interrupts](#1232-non-secure-interrupts)
-         -    Mapping of Interrupt Type to Signal
+        -   [Mapping of Interrupt Type to Signal](#124-mapping-of-interrupt-type-to-signal)
-2.  Interrupt Management
+2.  [Interrupt Management](#2-interrupt-management)
-    *    Software Components
+    *   [Software Components](#21-software-components)
-    *    Interrupt Registration
+    *   [Interrupt Registration](#22-interrupt-registration)
-         -    EL3 Runtime Firmware
+        -   [EL3 Runtime Firmware](#221-el3-runtime-firmware)
-         -    Secure Payload Dispatcher
+        -   [Secure Payload Dispatcher](#222-secure-payload-dispatcher)
-              +    Test Secure Payload Dispatcher behavior
+            +   [Test Secure Payload Dispatcher behavior](#2221-test-secure-payload-dispatcher-behavior)
-         -    Secure Payload
+        -   [Secure Payload](#223-secure-payload)
-              +    Secure Payload IHF design w.r.t Secure-EL1 interrupts
+            +   [Secure Payload IHF design w.r.t Secure-EL1 interrupts](#2231-secure-payload-ihf-design-wrt-secure-el1-interrupts)
-              +    Secure Payload IHF design w.r.t Non-secure interrupts
+            +   [Secure Payload IHF design w.r.t Non-secure interrupts](#2232-secure-payload-ihf-design-wrt-non-secure-interrupts)
-              +    Test Secure Payload behavior
+            +   [Test Secure Payload behavior](#2233-test-secure-payload-behavior)
-    *    Interrupt Handling
+    *   [Interrupt Handling](#23-interrupt-handling)
-         -    EL3 Runtime Firmware
+        -   [EL3 Runtime Firmware](#231-el3-runtime-firmware)
-         -    Secure Payload Dispatcher
+        -   [Secure Payload Dispatcher](#232-secure-payload-dispatcher)
-              +    Interrupt Entry
+            +   [Interrupt Entry](#2321-interrupt-entry)
-              +    Interrupt Exit
+            +   [Interrupt Exit](#2322-interrupt-exit)
-              +    Test Secure Payload Dispatcher behavior
+            +   [Test Secure Payload Dispatcher behavior](#2323-test-secure-payload-dispatcher-behavior)
-         -    Secure Payload
+        -   [Secure Payload](#233-secure-payload)
-              +    Test Secure Payload behavior
+            +   [Test Secure Payload behavior](#2331-test-secure-payload-behavior)
 1. Introduction
--- a/docs/porting-guide.md
+++ b/docs/porting-guide.md
@ -4,21 +4,21 @@ ARM Trusted Firmware Porting Guide
 Contents
 --------
-1.  Introduction
+1.  [Introduction](#1--introduction)
-2.  Common Modifications
+2.  [Common Modifications](#2--common-modifications)
-    *   Common mandatory modifications
+    *   [Common mandatory modifications](#21-common-mandatory-modifications)
-    *   Handling reset
+    *   [Handling reset](#22-handling-reset)
-    *   Common optional modifications
+    *   [Common optional modifications](#23-common-optional-modifications)
-3.  Boot Loader stage specific modifications
+3.  [Boot Loader stage specific modifications](#3--modifications-specific-to-a-boot-loader-stage)
-    *   Boot Loader stage 1 (BL1)
+    *   [Boot Loader stage 1 (BL1)](#31-boot-loader-stage-1-bl1)
-    *   Boot Loader stage 2 (BL2)
+    *   [Boot Loader stage 2 (BL2)](#32-boot-loader-stage-2-bl2)
-    *   Boot Loader stage 3-1 (BL3-1)
+    *   [Boot Loader stage 3-1 (BL3-1)](#32-boot-loader-stage-3-1-bl3-1)
-    *   PSCI implementation (in BL3-1)
+    *   [PSCI implementation (in BL3-1)](#33-power-state-coordination-interface-in-bl3-1)
-    *   Interrupt Management framework (in BL3-1)
+    *   [Interrupt Management framework (in BL3-1)](#34--interrupt-management-framework-in-bl3-1)
-    *   Crash Reporting mechanism (in BL3-1)
+    *   [Crash Reporting mechanism (in BL3-1)](#35--crash-reporting-mechanism-in-bl3-1)
-4.  Build flags
+4.  [Build flags](#4--build-flags)
-5.  C Library
+5.  [C Library](#5--c-library)
-6.  Storage abstraction layer
+6.  [Storage abstraction layer](#6--storage-abstraction-layer)
 - - - - - - - - - - - - - - - - - -
--- a/docs/rt-svc-writers-guide.md
+++ b/docs/rt-svc-writers-guide.md
@ -4,14 +4,14 @@ EL3 Runtime Service Writers Guide for ARM Trusted Firmware
 Contents
 --------
-1.  Introduction
+1.  [Introduction](#1--introduction)
-2.  Owning Entities, Call Types and Function IDs
+2.  [Owning Entities, Call Types and Function IDs](#2--owning-entities-call-types-and-function-ids)
-3.  Getting started
+3.  [Getting started](#3--getting-started)
-4.  Registering a runtime service
+4.  [Registering a runtime service](#4--registering-a-runtime-service)
-5.  Initializing a runtime service
+5.  [Initializing a runtime service](#5-initializing-a-runtime-service)
-6.  Handling runtime service requests
+6.  [Handling runtime service requests](#6--handling-runtime-service-requests)
-7.  Services that contain multiple sub-services
+7.  [Services that contain multiple sub-services](#7--services-that-contain-multiple-sub-services)
-8.  Secure-EL1 Payload Dispatcher service (SPD)
+8.  [Secure-EL1 Payload Dispatcher service (SPD)](#8--secure-el1-payload-dispatcher-service-spd)
 - - - - - - - - - - - - - - - - - -
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@ -3,15 +3,15 @@ ARM Trusted Firmware User Guide
 Contents :
-1.  Introduction
+1.  [Introduction](#1--introduction)
-2.  Host machine requirements
+2.  [Host machine requirements](#2--host-machine-requirements)
-3.  Tools
+3.  [Tools](#3--tools)
-4.  Building the Trusted Firmware
+4.  [Building the Trusted Firmware](#4--building-the-trusted-firmware)
-5.  Obtaining the normal world software
+5.  [Obtaining the normal world software](#5--obtaining-the-normal-world-software)
-6.  Preparing the images to run on FVP
+6.  [Preparing the images to run on FVP](#6--preparing-the-images-to-run-on-fvp)
-7.  Running the software on FVP
+7.  [Running the software on FVP](#7--running-the-software-on-fvp)
-8.  Preparing the images to run on Juno
+8.  [Preparing the images to run on Juno](#8--preparing-the-images-to-run-on-juno)
-9.  Running the software on Juno
+9.  [Running the software on Juno](#9--running-the-software-on-juno)
 1.  Introduction