doc: update toc format to md-toc

doc/BluetoothLEStack.md

@@ -5,11 +5,13 @@ Bluetooth Low Energy Design Document
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [System call interface](#system-call-interface)
-  * [Device address](#device-address)
-  * [Advertising](#advertising)
-  * [Scanning](#scanning)
-  * [Connection-oriented communication](#connection-oriented-communication)
+  - [Device address](#device-address)
+  - [Advertising](#advertising)
+  - [Scanning](#scanning)
+  - [Connection-oriented communication](#connectionoriented-communication)
 - [Hardware Interface Layer (HIL)](#hardware-interface-layer-hil)
 
 <!-- tocstop -->

doc/Compilation.md

@@ -10,22 +10,24 @@ of how platforms program each onto an actual board.
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Compiling the kernel](#compiling-the-kernel)
-  * [Life of a Tock compilation](#life-of-a-tock-compilation)
-    + [Platform Build Scripts](#platform-build-scripts)
-  * [LLVM Binutils](#llvm-binutils)
-  * [Special `.apps` section](#special-apps-section)
+  - [Life of a Tock compilation](#life-of-a-tock-compilation)
+    - [Platform Build Scripts](#platform-build-scripts)
+  - [LLVM Binutils](#llvm-binutils)
+  - [Special `.apps` section](#special-apps-section)
 - [Compiling a process](#compiling-a-process)
-  * [Executing without Virtual Memory](#executing-without-virtual-memory)
-    + [Position Independent Code](#position-independent-code)
-    + [Fixed Address Loading](#fixed-address-loading)
+  - [Executing without Virtual Memory](#executing-without-virtual-memory)
+    - [Position Independent Code](#position-independent-code)
+    - [Fixed Address Loading](#fixed-address-loading)
       - [Fixed Address TBF Header](#fixed-address-tbf-header)
       - [Loading Fixed Address Processes into Flash](#loading-fixed-address-processes-into-flash)
       - [Booting Fixed Address Processes](#booting-fixed-address-processes)
-  * [Tock Binary Format](#tock-binary-format)
-  * [Tock Application Bundle](#tock-application-bundle)
-    + [TAB Format](#tab-format)
-    + [Metadata](#metadata)
+  - [Tock Binary Format](#tock-binary-format)
+  - [Tock Application Bundle](#tock-application-bundle)
+    - [TAB Format](#tab-format)
+    - [Metadata](#metadata)
 - [Loading the kernel and processes onto a board](#loading-the-kernel-and-processes-onto-a-board)
 
 <!-- tocstop -->

doc/Design.md

@@ -5,19 +5,21 @@ Tock Design
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Architecture](#architecture)
-  * [Capsules](#capsules)
-  * [Processes](#processes)
-    + [Memory Layout](#memory-layout)
-  * [Grants](#grants)
-- [In-Kernel Design Principles](#in-kernel-design-principles)
-  * [Role of HILs](#role-of-hils)
-  * [Split-phase Operation](#split-phase-operation)
-  * [External Dependencies](#external-dependencies)
-  * [Using `unsafe` and Capabilities](#using-unsafe-and-capabilities)
-  * [Ease of Use and Understanding](#ease-of-use-and-understanding)
-  * [Demonstrated Features](#demonstrated-features)
-  * [Merge Aggressively, Archive Unabashedly](#merge-aggressively-archive-unabashedly)
+  - [Capsules](#capsules)
+  - [Processes](#processes)
+    - [Memory Layout](#memory-layout)
+  - [Grants](#grants)
+- [In-Kernel Design Principles](#inkernel-design-principles)
+  - [Role of HILs](#role-of-hils)
+  - [Split-phase Operation](#splitphase-operation)
+  - [External Dependencies](#external-dependencies)
+  - [Using `unsafe` and Capabilities](#using-unsafe-and-capabilities)
+  - [Ease of Use and Understanding](#ease-of-use-and-understanding)
+  - [Demonstrated Features](#demonstrated-features)
+  - [Merge Aggressively, Archive Unabashedly](#merge-aggressively-archive-unabashedly)
 
 <!-- tocstop -->
 

doc/ExternalDependencies.md

@@ -5,20 +5,22 @@ External Dependencies
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [External Dependency Design](#external-dependency-design)
-  * [Rationale](#rationale)
-  * [Dependency Structure of Tock-Internal Crates](#dependency-structure-of-tock-internal-crates)
+  - [Rationale](#rationale)
+  - [Dependency Structure of Tock-Internal Crates](#dependency-structure-of-tockinternal-crates)
 - [External Dependency Selection](#external-dependency-selection)
-  * [General Guidelines for Dependency Selection](#general-guidelines-for-dependency-selection)
-    + [Provide Important Functionality](#provide-important-functionality)
-    + [Project Maturity](#project-maturity)
-    + [Limited Sub-dependencies](#limited-sub-dependencies)
-  * [Board-Specific External Dependencies](#board-specific-external-dependencies)
-  * [Capsule Crate-Specific External Dependencies](#capsule-crate-specific-external-dependencies)
+  - [General Guidelines for Dependency Selection](#general-guidelines-for-dependency-selection)
+    - [Provide Important Functionality](#provide-important-functionality)
+    - [Project Maturity](#project-maturity)
+    - [Limited Sub-dependencies](#limited-subdependencies)
+  - [Board-Specific External Dependencies](#boardspecific-external-dependencies)
+  - [Capsule Crate-Specific External Dependencies](#capsule-cratespecific-external-dependencies)
 - [Including the Dependency](#including-the-dependency)
-  * [Including Capsule Crate-Specific External Dependencies](#including-capsule-crate-specific-external-dependencies)
-  * [Including Board-Specific External Dependencies](#including-board-specific-external-dependencies)
-  * [Documenting the Dependency and its Tree](#documenting-the-dependency-and-its-tree)
+  - [Including Capsule Crate-Specific External Dependencies](#including-capsule-cratespecific-external-dependencies)
+  - [Including Board-Specific External Dependencies](#including-boardspecific-external-dependencies)
+  - [Documenting the Dependency and its Tree](#documenting-the-dependency-and-its-tree)
 - [Design Goals and Alternative Approaches](#design-goals-and-alternative-approaches)
 
 <!-- tocstop -->

doc/Getting_Started.md

@@ -8,21 +8,23 @@ developing Tock.
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Requirements](#requirements)
-  * [Super Quick Setup](#super-quick-setup)
-  * [Installing Requirements](#installing-requirements)
-    + [Rust (nightly)](#rust-nightly)
-    + [Tockloader](#tockloader)
+  - [Super Quick Setup](#super-quick-setup)
+  - [Installing Requirements](#installing-requirements)
+    - [Rust (nightly)](#rust-nightly)
+    - [Tockloader](#tockloader)
 - [Compiling the Kernel](#compiling-the-kernel)
 - [Loading the kernel onto a board](#loading-the-kernel-onto-a-board)
-  * [Installing `JLinkExe`](#installing-jlinkexe)
-  * [Installing `openocd`](#installing-openocd)
-  * [(Linux): Adding a `udev` rule](#linux-adding-a-udev-rule)
+  - [Installing `JLinkExe`](#installing-jlinkexe)
+  - [Installing `openocd`](#installing-openocd)
+  - [(Linux): Adding a `udev` rule](#linux-adding-a-udev-rule)
 - [Installing your first application](#installing-your-first-application)
 - [Compiling applications](#compiling-applications)
 - [Developing TockOS](#developing-tockos)
-  * [Formatting Rust source code](#formatting-rust-source-code)
-  * [Keeping build tools up to date](#keeping-build-tools-up-to-date)
+  - [Formatting Rust source code](#formatting-rust-source-code)
+  - [Keeping build tools up to date](#keeping-build-tools-up-to-date)
 
 <!-- tocstop -->
 

doc/Kernel_Attributes.md

@@ -10,12 +10,14 @@ to learn about the kernel installed on the board.
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Format](#format)
-  * [Header Format](#header-format)
-  * [TLV Format](#tlv-format)
+  - [Header Format](#header-format)
+  - [TLV Format](#tlv-format)
 - [TLVs](#tlvs)
-  * [App Memory (0x0101)](#app-memory-0x0101)
-  * [Kernel Binary (0x0102)](#kernel-binary-0x0102)
+  - [App Memory (0x0101)](#app-memory-0x0101)
+  - [Kernel Binary (0x0102)](#kernel-binary-0x0102)
 - [Kernel Attributes Location](#kernel-attributes-location)
 
 <!-- tocstop -->

doc/Lifetimes.md

@@ -26,6 +26,8 @@ kernel.
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Rust lifetimes](#rust-lifetimes)
 - [Buffer management](#buffer-management)
 - [Circular dependencies](#circular-dependencies)

doc/Maintenance.md

@@ -7,14 +7,16 @@ group](wg/core/README.md) maintains the Tock project.
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Roadmap and Feature Planning](#roadmap-and-feature-planning)
 - [Outreach and Education](#outreach-and-education)
 - [Preparing a Release](#preparing-a-release)
-  * [Release Tasks](#release-tasks)
-    + [Before the release](#before-the-release)
-    + [Tagging a release candidate](#tagging-a-release-candidate)
-    + [Release testing](#release-testing)
-    + [Tagging a release](#tagging-a-release)
+  - [Release Tasks](#release-tasks)
+    - [Before the release](#before-the-release)
+    - [Tagging a release candidate](#tagging-a-release-candidate)
+    - [Release testing](#release-testing)
+    - [Tagging a release](#tagging-a-release)
 
 <!-- tocstop -->
 

doc/Memory_Isolation.md

@@ -10,9 +10,11 @@ memory layout](Memory_Layout.md).
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Process Isolation](#process-isolation)
-  * [Flash](#flash)
-  * [RAM](#ram)
+  - [Flash](#flash)
+  - [RAM](#ram)
 
 <!-- tocstop -->
 

doc/Memory_Layout.md

@@ -8,17 +8,19 @@ kernel, applications, and supporting state.
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Flash](#flash)
-  * [Kernel code](#kernel-code)
-  * [Process code](#process-code)
+  - [Kernel code](#kernel-code)
+  - [Process code](#process-code)
 - [RAM](#ram)
-  * [Kernel RAM](#kernel-ram)
-  * [Process RAM](#process-ram)
+  - [Kernel RAM](#kernel-ram)
+  - [Process RAM](#process-ram)
 - [Hardware Implementations](#hardware-implementations)
-  * [SAM4L](#sam4l)
-    + [Flash](#flash-1)
-    + [RAM](#ram-1)
-    + [Overview](#overview)
+  - [SAM4L](#sam4l)
+    - [Flash](#flash)
+    - [RAM](#ram)
+    - [Overview](#overview)
 
 <!-- tocstop -->
 

doc/Mutable_References.md

@@ -24,19 +24,21 @@ of which is tailored to a specific use common in kernel code.
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Brief Overview of Borrowing in Rust](#brief-overview-of-borrowing-in-rust)
-- [Issues with Borrowing in Event-Driven code](#issues-with-borrowing-in-event-driven-code)
+- [Issues with Borrowing in Event-Driven code](#issues-with-borrowing-in-eventdriven-code)
 - [`Cell`s in Tock](#cells-in-tock)
 - [The `TakeCell` abstraction](#the-takecell-abstraction)
-  * [Example use of `take` and `replace`](#example-use-of-take-and-replace)
-  * [Example use of `map`](#example-use-of-map)
-    + [`map` variants](#map-variants)
+  - [Example use of `take` and `replace`](#example-use-of-take-and-replace)
+  - [Example use of `map`](#example-use-of-map)
+    - [`map` variants](#map-variants)
 - [`MapCell`](#mapcell)
 - [`OptionalCell`](#optionalcell)
-  * [Comparison to `TakeCell`](#comparison-to-takecell)
+  - [Comparison to `TakeCell`](#comparison-to-takecell)
 - [`VolatileCell`](#volatilecell)
 - [Cell Extensions](#cell-extensions)
-  * [`NumericCellExt`](#numericcellext)
+  - [`NumericCellExt`](#numericcellext)
 
 <!-- tocstop -->
 

doc/OutOfTree.md

@@ -10,11 +10,8 @@ _It is a work in progress. Comments and pull requests are appreciated!_
 
 <!-- toc -->
 
-- [Overview](#overview)
-- [Structure](#structure)
-- [Boards](#boards)
-- [Everything Else](#everything-else)
-- [Examples](#examples)
+<!-- Build table of contents with tools/toc.sh -->
+
 
 <!-- tocstop -->
 

doc/Overview.md

@@ -23,6 +23,8 @@ structure is reflected in the software's directory structure.
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Tock Architecture](#tock-architecture)
 - [Tock Directory Structure](#tock-directory-structure)
 

doc/Porting.md

@@ -9,23 +9,21 @@ _It is a work in progress. Comments and pull requests are appreciated!_
 
 <!-- toc -->
 
-- [Overview](#overview)
-- [Is Tock a Good Fit for my Hardware?](#is-tock-a-good-fit-for-my-hardware)
-- [Crate Details](#crate-details)
-  * [`arch` Crate](#arch-crate)
-  * [`chip` Crate](#chip-crate)
-    + [Tips and Tools](#tips-and-tools)
-  * [`board` Crate](#board-crate)
-    + [Component Creation](#component-creation)
-    + [Board Support](#board-support)
+<!-- Build table of contents with tools/toc.sh -->
+
+  - [`arch` Crate](#arch-crate)
+  - [`chip` Crate](#chip-crate)
+    - [Tips and Tools](#tips-and-tools)
+  - [`board` Crate](#board-crate)
+    - [Component Creation](#component-creation)
+    - [Board Support](#board-support)
       - [`panic!`s (aka `io.rs`)](#panics-aka-iors)
       - [Board Cargo.toml, build.rs](#board-cargotoml-buildrs)
       - [Board Makefile](#board-makefile)
-        * [Getting the built kernel onto a board](#getting-the-built-kernel-onto-a-board)
+        - [Getting the built kernel onto a board](#getting-the-built-kernel-onto-a-board)
       - [Board README](#board-readme)
-    + [Loading Apps](#loading-apps)
-    + [Common Pitfalls](#common-pitfalls)
-- [Adding a Platform to Tock Repository](#adding-a-platform-to-tock-repository)
+    - [Loading Apps](#loading-apps)
+    - [Common Pitfalls](#common-pitfalls)
 
 <!-- tocstop -->
 

doc/Porting_v1_Capsules_to_v2.md

@@ -9,16 +9,15 @@ gives code examples.
 
 <!-- toc -->
 
-- [Overview](#overview)
-- [Tock 2.0 System Call API](#tock-20-system-call-api)
-  * [`SyscallDriver`](#syscalldriver)
-- [Porting Capsules and Example Code](#porting-capsules-and-example-code)
-  * [Examples of command and `CommandResult`](#examples-of-command-and-commandresult)
-    + [ReturnCode versus ErrorCode](#returncode-versus-errorcode)
-  * [Examples of `allow_readwrite` and `allow_readonly`](#examples-of-allow_readwrite-and-allow_readonly)
-  * [The new subscription mechanism](#the-new-subscription-mechanism)
-  * [Using `ReadOnlyProcessBuffer` and `ReadWriteProcessBuffer`: `console`](#using-readonlyprocessbuffer-and-readwriteprocessbuffer-console)
-  * [Using `ReadOnlyProcessBuffer` and `ReadWriteProcessBuffer`: `spi_controller`](#using-readonlyprocessbuffer-and-readwriteprocessbuffer-spi_controller)
+<!-- Build table of contents with tools/toc.sh -->
+
+  - [`SyscallDriver`](#syscalldriver)
+  - [Examples of command and `CommandResult`](#examples-of-command-and-commandresult)
+    - [ReturnCode versus ErrorCode](#returncode-versus-errorcode)
+  - [Examples of `allow_readwrite` and `allow_readonly`](#examples-of-allowreadwrite-and-allowreadonly)
+  - [The new subscription mechanism](#the-new-subscription-mechanism)
+  - [Using `ReadOnlyProcessBuffer` and `ReadWriteProcessBuffer`: `console`](#using-readonlyprocessbuffer-and-readwriteprocessbuffer-console)
+  - [Using `ReadOnlyProcessBuffer` and `ReadWriteProcessBuffer`: `spi_controller`](#using-readonlyprocessbuffer-and-readwriteprocessbuffer-spicontroller)
 
 <!-- tocstop -->
 

doc/Process_Console.md

@@ -8,24 +8,12 @@ Process Console
 
 <!-- toc -->
 
-- [Setup](#setup)
-- [Using Process Console](#using-process-console)
-- [Commands](#commands)
-  * [`help`](#help)
-  * [`list`](#list)
-    + [`list` Command Fields](#list-command-fields)
-  * [`status`](#status)
-  * [`start` and `stop`](#start-and-stop)
-  * [`terminate` and `boot`](#terminate-and-boot)
-  * [`fault`](#fault)
-  * [`panic`](#panic)
-  * [`reset`](#reset)
-  * [`kernel`](#kernel)
-  * [`process`](#process)
-  * [`console-start`](#console-start)
-  * [`console-stop`](#console-stop)
-  * [`commands history`](#commands-history)
-  * [`command navigation`](#command-navigation)
+<!-- Build table of contents with tools/toc.sh -->
+
+  - [`help`](#help)
+  - [`list`](#list)
+    - [`list` Command Fields](#list-command-fields)
+  - [`status`](#status)
 
 <!-- tocstop -->
 

doc/Qemu.md

@@ -12,6 +12,8 @@ confusing. The long-term goal is to integrate QEMU as a core part of CI for Tock
 
 <!-- toc -->
 
+<!-- Build table of contents with tools/toc.sh -->
+
 - [Supported Boards](#supported-boards)
 - [Building QEMU](#building-qemu)