docs: Fix top level headers and other small clean.

* Make sure all files have top level headers. * Fixing a few spelling mistakes. * Fixed some trailing spaces. Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
mithro · Apr 4, 2019 · 9717fa4 · 9717fa4
1 parent 1df4f35
commit 9717fa4
Show file tree

Hide file tree

Showing 23 changed files with 36 additions and 45 deletions.
diff --git a/fuzzers/012-clb-n5ffmux/README.md b/fuzzers/012-clb-n5ffmux/README.md
@@ -4,8 +4,8 @@
 
 The A5FFMUX family of CLB muxes feed the D input of A5FF family of FFs
 
-| N5FFMUX  | N5FFMUX.D       | 
-|--------|-----------------|
-| IN_A   | N5LUT.O5        |
-| IN_B   | NX              |
+| N5FFMUX  | N5FFMUX.D       |
+|----------|-----------------|
+| IN_A     | N5LUT.O5        |
+| IN_B     | NX              |
 
diff --git a/fuzzers/013-clb-ncy0/README.md b/fuzzers/013-clb-ncy0/README.md
@@ -4,7 +4,7 @@
 
 The ACY0 family of CLB muxes feeds the CARRY4.DI0 family
 
-| NCY0  | CARRY4.DIN       | 
+| NCY0   | CARRY4.DIN       |
 |--------|------------------|
 | 0      | NX               |
 | 1      | O5               |

diff --git a/fuzzers/014-clb-ffsrcemux/README.md b/fuzzers/014-clb-ffsrcemux/README.md
@@ -4,7 +4,7 @@
 
 Configures whether clock enable (CE) is used or clock always on
 
-| CEUSEDMUX  | CE               | 
+| CEUSEDMUX  | CE               |
 |------------|------------------|
 | 0          | Always on        |
 | 1          | Controlled       |
@@ -14,7 +14,7 @@ Configures whether clock enable (CE) is used or clock always on
 
 Configures whether FF can be reset or simply uses D value
 
-| SRUSEDMUX  | Resettable?      | 
+| SRUSEDMUX  | Resettable?      |
 |------------|------------------|
 | 0          | No               |
 | 1          | Controlled       |

diff --git a/fuzzers/015-clb-nffmux/README.md b/fuzzers/015-clb-nffmux/README.md
@@ -4,5 +4,5 @@
 
 Configures the AFFMUX family of CLB muxes which feed the D input of the AFF series of FFs.
 
-Availible selections varies by A/B/C/D, see db for details.
+Available selections varies by A/B/C/D, see db for details.
 
diff --git a/fuzzers/016-clb-noutmux/README.md b/fuzzers/016-clb-noutmux/README.md
@@ -4,5 +4,5 @@
 
 Configures the AOUTMUX family of CLB muxes which feed the AMUX family of CLB outputs
 
-Availible selections varies by A/B/C/D, see db for details.
+Available selections varies by A/B/C/D, see db for details.
 
diff --git a/fuzzers/017-clb-precyinit/README.md b/fuzzers/017-clb-precyinit/README.md
@@ -4,7 +4,7 @@
 
 Configures the PRECYINIT mux which provides CARRY4's first carry chain input
 
-| PRECYINIT  | Value                           | 
+| PRECYINIT  | Value                           |
 |------------|---------------------------------|
 | C0         | Logic 0                         |
 | C1         | Logic 1                         |

diff --git a/fuzzers/018-clb-ram/README.md b/fuzzers/018-clb-ram/README.md
@@ -43,7 +43,7 @@ Set to 1 to propagate CLB's BX input to WA8
 
 ## WEMUX.CE
 
-| WEMUX.CE  | CLB RAM write enable | 
+| WEMUX.CE  | CLB RAM write enable |
 |-----------|----------------------|
 | 0         | CLB WE input         |
 | 1         | CLB CE input         |

diff --git a/fuzzers/019-clb-ndi1mux/README.md b/fuzzers/019-clb-ndi1mux/README.md
@@ -4,5 +4,5 @@
 
 Configures the NDI1MUX mux which provides the DI1 input on CLB RAM.
 
-Availible selections varies by A/B/C/D, see db for details.
+Available selections varies by A/B/C/D, see db for details.
 
diff --git a/fuzzers/025-bram-config/README.md b/fuzzers/025-bram-config/README.md
@@ -1,2 +1,4 @@
+# BRAM Configuration
+
 Solves for BRAM configuration bits (18K vs 36K, etc)
 
diff --git a/fuzzers/026-bram-data/README.md b/fuzzers/026-bram-data/README.md
@@ -1,3 +1,5 @@
+# BRAM Data
+
 Solves for BRAM data bits
 
 See workflow comments: https://github.com/SymbiFlow/prjxray/pull/180

diff --git a/fuzzers/032-cmt-pll/README.md b/fuzzers/032-cmt-pll/README.md
@@ -0,0 +1,3 @@
+# Clock Management Tile (CMT) - Phase Lock Loop (PLL) Fuzzer
+
+FIXME: Add description.
diff --git a/fuzzers/033-mon-xadc/README.md b/fuzzers/033-mon-xadc/README.md
@@ -1,3 +1,5 @@
+# XADC Fuzzer
+
 As of this writing, this fuzzer is not in the ROI
 To use it, you must run tilegrid first with these options (artix7):
 

diff --git a/fuzzers/044-clk-bufg-pips/README.md b/fuzzers/044-clk-bufg-pips/README.md
@@ -1,4 +1,3 @@
-BUFG interconnect fuzzer
-========================
+# BUFG interconnect fuzzer
 
 Solves pips located within the BUFG switch box.
diff --git a/fuzzers/045-hclk-cmt-pips/README.md b/fuzzers/045-hclk-cmt-pips/README.md
@@ -1,4 +1,3 @@
-HCLK\_CMT interconnect fuzzer
-=============================
+# HCLK\_CMT interconnect fuzzer
 
 Solves pips located within the HCLK\_CMT switch box.
diff --git a/fuzzers/050-pip-seed/README.md b/fuzzers/050-pip-seed/README.md
@@ -1,6 +1,4 @@
-
-Generic fuzzer for INT PIPs
----------------------------
+# Generic fuzzer for INT PIPs
 
 Run this fuzzer a few times until it stops adding new PIPs to the
 database.

diff --git a/fuzzers/051-pip-imuxlout-bypalts/README.md b/fuzzers/051-pip-imuxlout-bypalts/README.md
@@ -1,6 +1,4 @@
-
-Fuzzer for INT LOGIC\_OUTS -> IMUX PIPs
----------------------------------------
+# Fuzzer for INT LOGIC\_OUTS -> IMUX PIPs
 
 Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop).
 
diff --git a/fuzzers/052-pip-clkin/README.md b/fuzzers/052-pip-clkin/README.md
@@ -1,6 +1,5 @@
+# Fuzzer for INT PIPs driving the CLK wires
 
-Fuzzer for INT PIPs driving the CLK wires
------------------------------------------
-
-Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop).
+Run this fuzzer a few times until it produces an empty todo.txt file (`make
+run` will run this loop).
 
diff --git a/fuzzers/053-pip-ctrlin/README.md b/fuzzers/053-pip-ctrlin/README.md
@@ -1,6 +1,4 @@
-
-Fuzzer for INT PIPs driving the CTRL wires
-------------------------------------------
+# Fuzzer for INT PIPs driving the CTRL wires
 
 Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop).
 
diff --git a/fuzzers/054-pip-fan-alt/README.md b/fuzzers/054-pip-fan-alt/README.md
@@ -1,5 +1,3 @@
-
-Fuzzer for the ALT_FAN.*GFAN PIPs
----------------------------------
+# Fuzzer for the ALT_FAN.*GFAN PIPs
 
 This fuzzer solves the ALT_FAN.GFAN PIPs which had collisions with the GFAN PIPs.
diff --git a/fuzzers/055-pip-gnd/README.md b/fuzzers/055-pip-gnd/README.md
@@ -1,6 +1,4 @@
-
-Fuzzer for INT PIPs driving the GFAN wires with GND
----------------------------------------------------
+# Fuzzer for INT PIPs driving the GFAN wires with GND
 
 Run this fuzzer once.
 
diff --git a/fuzzers/056-pip-rem/README.md b/fuzzers/056-pip-rem/README.md
@@ -1,6 +1,4 @@
-
-Fuzzer for the remaining INT PIPs
----------------------------------
+# Fuzzer for the remaining INT PIPs
 
 Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop).
 

diff --git a/fuzzers/057-pip-bi/README.md b/fuzzers/057-pip-bi/README.md
@@ -1,6 +1,5 @@
+# Fuzzer for bidirectional INT PIPs
 
-Fuzzer for bidirectional INT PIPs
----------------------------------
-
-Run this fuzzer a few times until it produces an empty todo.txt file (`make run` will run this loop).
+Run this fuzzer a few times until it produces an empty todo.txt file (`make
+run` will run this loop).
 
diff --git a/fuzzers/058-pip-hclk/README.md b/fuzzers/058-pip-hclk/README.md
@@ -1,6 +1,4 @@
-
-Fuzzer for PIPs in HCLK titles
-------------------------------
+# Fuzzer for PIPs in HCLK titles
 
 Run this fuzzer once.