From 8051845a0ac645f7629ac7d2c35b61db85d128c4 Mon Sep 17 00:00:00 2001 From: adam Date: Tue, 28 Aug 2007 09:57:27 +0100 Subject: [PATCH] doc updates to ships --- ships/BitFifo.ship | 6 +++--- ships/Memory.ship | 2 +- ships/Stack.ship | 4 ++-- src/edu/berkeley/fleet/doc/Doc.java | 1 + 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/ships/BitFifo.ship b/ships/BitFifo.ship index 0349b0c..371abe9 100644 --- a/ships/BitFifo.ship +++ b/ships/BitFifo.ship @@ -28,9 +28,9 @@ more. Bits are enqueued by providing a word at the {\tt in} port and a code word at the {\tt inOp} port (ports are named this way to take -advantage of the switch fabric opcode mechanism). As shown in the -constant diagram, this code word has fields {\tt lsbFirst}, {\tt -msbFirst}, {\tt drop}, and {\tt take}. +advantage of the switch fabric opcode mechanism \cite{am25}). As +shown in the constant diagram, this code word has fields {\tt +lsbFirst}, {\tt msbFirst}, {\tt drop}, and {\tt take}. When a word is consumed from {\tt in}, it is ``oriented'' in either Most Significant Bit First ({\tt msbFirst}) or Least Significant Bit diff --git a/ships/Memory.ship b/ships/Memory.ship index e9b874b..c24f5f8 100644 --- a/ships/Memory.ship +++ b/ships/Memory.ship @@ -14,7 +14,7 @@ data out: out The {\tt Memory} ship represents an interface to a storage space, which can be used to read from it or write to it. This storage space -might be a fast on-chip cache, off chip DRAM, or even a disk drive. +might be a fast on-chip cache, off chip DRAM, or perhaps even a disk drive. There may be multiple {\tt Memory} ships which interface to the same physical storage space. An implementation of Fleet must provide diff --git a/ships/Stack.ship b/ships/Stack.ship index aca2883..1143c5b 100644 --- a/ships/Stack.ship +++ b/ships/Stack.ship @@ -7,11 +7,11 @@ data out: pop == Constants ======================================================== == TeX ============================================================== -A stack ship with capacity for at least 32 elements. +A stack ship with capacity for at least 16 elements. Push operations are executed as soon as an inbound datum is delivered to the {\tt push} port. Completion of a push can be confirmed by -sending a {\tt notify} token from the {\tt push} port. +sending a token from the {\tt push} port after {\tt deliver}ing. Pop operations are executed no earlier than the time at which the {\tt pop} port attempts to {\tt take} data from the ship. diff --git a/src/edu/berkeley/fleet/doc/Doc.java b/src/edu/berkeley/fleet/doc/Doc.java index 58ba206..8d23880 100644 --- a/src/edu/berkeley/fleet/doc/Doc.java +++ b/src/edu/berkeley/fleet/doc/Doc.java @@ -23,6 +23,7 @@ public class Doc { private static void print(PrintWriter pw, ShipDescription sd) throws Exception { pw.println("\\pagebreak"); pw.println("\\section*{The {\\tt "+sd.getName()+"} Ship}"); + pw.println("\\addcontentsline{toc}{subsection}{"+sd.getName()+"}"); String tex = sd.getSection("tex"); /* for(PumpDescription bbd : sd) { -- 1.7.10.4