From b8fa57ccd02b242a12e313ebf8f20a9c17f68a89 Mon Sep 17 00:00:00 2001 From: Gareth Rees Date: Fri, 24 Oct 2014 09:10:18 +0100 Subject: [PATCH] Remove otiose "this document describes the". Add "anyone porting the MPS to a new platform" to the readership of design documents that they might need to consult. Copied from Perforce Change: 187377 ServerID: perforce.ravenbrook.com --- mps/design/arenavm.txt | 7 +++---- mps/design/buffer.txt | 4 ++-- mps/design/config.txt | 3 +++ mps/design/freelist.txt | 3 +-- mps/design/lock.txt | 6 +++--- mps/design/nailboard.txt | 3 +-- mps/design/poolams.txt | 9 ++++----- mps/design/prmc.txt | 3 ++- mps/design/prot.txt | 6 +++--- mps/design/seg.txt | 2 +- mps/design/sp.txt | 6 +++--- mps/design/ss.txt | 7 ++++--- mps/design/testthr.txt | 4 ++-- mps/design/thread-manager.txt | 3 ++- mps/design/vm.txt | 6 +++--- 15 files changed, 37 insertions(+), 35 deletions(-) diff --git a/mps/design/arenavm.txt b/mps/design/arenavm.txt index 08ff89e0f94..d746f18d883 100644 --- a/mps/design/arenavm.txt +++ b/mps/design/arenavm.txt @@ -17,10 +17,9 @@ Virtual Memory Arena Introduction ------------ -_`.intro`: This document describes the detailed design of the Virtual -Memory Arena Class of the Memory Pool System. The VM Arena Class is -just one class available in the MPS. The generic arena part is -described in design.mps.arena_. +_`.intro`: This is the design of the Virtual Memory Arena Class of the +Memory Pool System. The VM Arena Class is just one class available in +the MPS. The generic arena part is described in design.mps.arena_. .. _design.mps.arena: arena diff --git a/mps/design/buffer.txt b/mps/design/buffer.txt index e47c12d0b37..ae55fa34204 100644 --- a/mps/design/buffer.txt +++ b/mps/design/buffer.txt @@ -15,8 +15,8 @@ Allocation buffers and allocation points Introduction ------------ -_`.scope`: This document describes the design of allocation buffers -and allocation points. +_`.scope`: This is the design of allocation buffers and allocation +points. _`.purpose`: The purpose of this document is to record design decisions made concerning allocation buffers and allocation points and diff --git a/mps/design/config.txt b/mps/design/config.txt index 66bf5f0f3b0..eff74388489 100644 --- a/mps/design/config.txt +++ b/mps/design/config.txt @@ -20,6 +20,9 @@ _`.intro`: This document describes how the `Memory Pool System that it can target different architectures, operating systems, build environments, varieties, and products. +_`.readership`: Any MPS developer; anyone porting the MPS to a new +platform. + Requirements diff --git a/mps/design/freelist.txt b/mps/design/freelist.txt index 38de91d03df..c89181505c1 100644 --- a/mps/design/freelist.txt +++ b/mps/design/freelist.txt @@ -15,8 +15,7 @@ Free list allocator Introduction ------------ -_`.intro`: This document describes the free list allocator for the -Memory Pool System. +_`.intro`: This is the design of the free list allocator. _`.readership`: Any MPS developer. diff --git a/mps/design/lock.txt b/mps/design/lock.txt index f28e4c5e10d..2c744cedb64 100644 --- a/mps/design/lock.txt +++ b/mps/design/lock.txt @@ -15,10 +15,10 @@ Lock module Introduction ------------ -_`.intro`: This document describes the design of the lock module in -the Memory Pool System. +_`.intro`: This is the design of the lock module. -_`.readership`: Any MPS developer. +_`.readership`: Any MPS developer; anyone porting the MPS to a new +platform. Background diff --git a/mps/design/nailboard.txt b/mps/design/nailboard.txt index d4c0bb047a5..2f88b5b57b7 100644 --- a/mps/design/nailboard.txt +++ b/mps/design/nailboard.txt @@ -15,8 +15,7 @@ Nailboards for ambiguously referenced segments Introduction ------------ -_`.intro`: This document describes the nailboard design for the Memory -Pool System. +_`.intro`: This is the design of the nailboard module. _`.readership`: Any MPS developer. diff --git a/mps/design/poolams.txt b/mps/design/poolams.txt index a93bb85ab1b..ef59e46724a 100644 --- a/mps/design/poolams.txt +++ b/mps/design/poolams.txt @@ -36,11 +36,10 @@ req.mps that captures the commonalities between the products -- pekka Overview -------- -_`.overview`: This document describes the design of the AMS (Automatic -Mark-and-Sweep) pool class. The AMS pool is a proof-of-concept design -for a mark-sweep pool in the MPS. It's not meant to be efficient, but -it could serve as a model for an implementation of a more advanced -pool (such as EPVM). +_`.overview`: This is the design of the AMS (Automatic Mark-and-Sweep) +pool class. The AMS pool is a proof-of-concept design for a mark-sweep +pool in the MPS. It's not meant to be efficient, but it could serve as +a model for an implementation of a more advanced pool (such as EPVM). Requirements diff --git a/mps/design/prmc.txt b/mps/design/prmc.txt index 0b1a966a50a..8d13d831420 100644 --- a/mps/design/prmc.txt +++ b/mps/design/prmc.txt @@ -18,7 +18,8 @@ Introduction _`.intro`: This is the design of the protection mutator context module. -_`.readership`: Any MPS developer. +_`.readership`: Any MPS developer; anyone porting the MPS to a new +platform. _`.overview`: The protection mutator context module decodes the *context* of a mutator thread at the point when it caused a protection diff --git a/mps/design/prot.txt b/mps/design/prot.txt index 76c6f963864..89635435ede 100644 --- a/mps/design/prot.txt +++ b/mps/design/prot.txt @@ -15,10 +15,10 @@ Memory protection Introduction ------------ -_`.intro`: This document describes the design of the memory protection -module. +_`.intro`: This is the design of the memory protection module. -_`.readership`: Any MPS developer. +_`.readership`: Any MPS developer; anyone porting the MPS to a new +platform. _`.overview`: The memory protection module ensures that the mutator sees a consistent view of memory during incremental collection, by diff --git a/mps/design/seg.txt b/mps/design/seg.txt index 6988ac23f5a..db797f233c0 100644 --- a/mps/design/seg.txt +++ b/mps/design/seg.txt @@ -15,7 +15,7 @@ Segment data structure Introduction ------------ -_`.intro`: This document describes the MPS Segment data structure. +_`.intro`: This is the design of the segment data structure. Overview diff --git a/mps/design/sp.txt b/mps/design/sp.txt index 840e9ec8f18..65992e17f73 100644 --- a/mps/design/sp.txt +++ b/mps/design/sp.txt @@ -15,10 +15,10 @@ Stack probe Introduction ------------ -_`.intro`: This document describes the design of the stack probe -module. +_`.intro`: This is the design of the stack probe module. -_`.readership`: Any MPS developer. +_`.readership`: Any MPS developer; anyone porting the MPS to a new +platform. _`.overview`: This module ensures that the stack cannot overflow while the MPS is holding a lock. diff --git a/mps/design/ss.txt b/mps/design/ss.txt index b1ff8d1bea5..a3710368c9f 100644 --- a/mps/design/ss.txt +++ b/mps/design/ss.txt @@ -15,10 +15,11 @@ Stack and register scanning Introduction ------------ -_`.intro`: This document describes the design of the stack and -register scanning module. +_`.intro`: This is the design of the stack and register scanning +module. -_`.readership`: Any MPS developer. +_`.readership`: Any MPS developer; anyone porting the MPS to a new +platform. _`.overview`: This module locates and scans references in the control stack and registers of the *current* thread. diff --git a/mps/design/testthr.txt b/mps/design/testthr.txt index 108cdb37b03..e00ccd8b317 100644 --- a/mps/design/testthr.txt +++ b/mps/design/testthr.txt @@ -15,8 +15,8 @@ Multi-threaded testing Introduction ------------ -_`.intro`: This document describes the design for multi-threaded -testing in the Memory Pool System. +_`.intro`: This is the design of the multi-threaded testing module +in the Memory Pool System. _`.readership`: Any MPS developer. diff --git a/mps/design/thread-manager.txt b/mps/design/thread-manager.txt index 0398c079356..efe6bcee9e9 100644 --- a/mps/design/thread-manager.txt +++ b/mps/design/thread-manager.txt @@ -17,7 +17,8 @@ Introduction _`.intro`: This is the design of the thread manager module. -_`.readership`: Any MPS developer. +_`.readership`: Any MPS developer; anyone porting the MPS to a new +platform. _`.overview`: The thread manager implements two features that allow the MPS to work in a multi-threaded environment: exclusive access to diff --git a/mps/design/vm.txt b/mps/design/vm.txt index 6293326f4af..85c5506043f 100644 --- a/mps/design/vm.txt +++ b/mps/design/vm.txt @@ -15,10 +15,10 @@ Virtual mapping Introduction ------------ -_`.intro`: This document describes the design of the virtual mapping -module. +_`.intro`: This is the design of the virtual mapping module. -_`.readership`: Any MPS developer. +_`.readership`: Any MPS developer; anyone porting the MPS to a new +platform. _`.overview`: The virtual mapping module provides a simple, portable, low-level interface to address space, with functions for reserving,