Reformat to single sentence per line

Only source file whitespace changes, the generated site is exactly the
same before and after (actual bug-for-bug compatiblity, including what
is obviously a formatting error X-D. I'll take care of it in another
PR.)

`wdiff` was used to verify the generated files were identical save white
space.

Author: DigitalBrains1

compiler-userguide/src/developing-hardware/flags.md

@@ -1,26 +1,25 @@
 # Clash Compiler Flags
 
 --vhdl  
-Use the VHDL backend for code generation. This currently emits VHDL 1993
-source which can be consumed by other tools.
+Use the VHDL backend for code generation.
+This currently emits VHDL 1993 source which can be consumed by other tools.
 
 --verilog  
-Use the Verilog backend for code generation. This currently emits
-Verilog 2001 source which can be consumed by other tools.
+Use the Verilog backend for code generation.
+This currently emits Verilog 2001 source which can be consumed by other tools.
 
 --systemverilog  
-Use the SystemVerilog backend for code generation. This currently emits
-SystemVerilog 2012 source which can be consumed by other tools.
+Use the SystemVerilog backend for code generation.
+This currently emits SystemVerilog 2012 source which can be consumed by other tools.
 
 -fclash-debug  
-Set the debugging mode for the compiler, exposing additional output. The
-available options are
+Set the debugging mode for the compiler, exposing additional output.
+The available options are
 
 - `DebugNone` to show no debug messages
-- `DebugSilent` to test invariants and error if any are violated. This
-  is implicitly enabled by any debug flag
-- `DebugFinal` to show expressions after they have been completely
-  normalized
+- `DebugSilent` to test invariants and error if any are violated.
+  This is implicitly enabled by any debug flag
+- `DebugFinal` to show expressions after they have been completely normalized
 - `DebugCount` to count how often each transformation is applied
 - `DebugName` to show the names of transformations as they are applied
 - `DebugTry` to show names of tried and applied transformations
@@ -37,22 +36,20 @@ Note
 
 </div>
 
-This flag exists for backwards compatibility. It is now possible to set
-debugging flags individually with
+This flag exists for backwards compatibility.
+It is now possible to set debugging flags individually with
 <span class="title-ref">-fclash-debug-invariants</span>,
 <span class="title-ref">-fclash-debug-info</span> and
 <span class="title-ref">-fclash-debug-count-transformations</span>.
 
 </div>
 
 -fclash-debug-invariants  
-Check invariants while debugging and print warnings / errors which may
-be useful, such as alterting when unexpected changes occur or when a
-transformation introduces free variables / shadowing.
+Check invariants while debugging and print warnings / errors which may be useful, such as alterting when unexpected changes occur or when a transformation introduces free variables / shadowing.
 
 -fclash-debug-info  
-Specify the information to show about individual transformations while
-debugging. From least to most information, these are
+Specify the information to show about individual transformations while debugging.
+From least to most information, these are
 
 - `None` to show no information
 
@@ -62,25 +59,22 @@ debugging. From least to most information, these are
 
 - `AppliedTerm` to show the result of applied transformations
 
-- `TryName` to show the names of attempted transforamtions, as well as
-  the result of any transformations which are applied
+- `TryName` to show the names of attempted transforamtions, as well as the result of any transformations which are applied
 
-- `TryTerm` to show the names and results of all transformations
-  attempted whether they were applied or not
+- `TryTerm` to show the names and results of all transformations attempted whether they were applied or not
 
   **Default:** `None`
 
 -fclash-debug-count-transformations  
-Count the transformations that are applied and print a summary at the
-end of the normalization phase.
+Count the transformations that are applied and print a summary at the end of the normalization phase.
 
 -fclash-debug-history\[=FILENAME\]  
-Saves all applied rewrites into `FILENAME`, for later analysis with the
-clash-term tool. When no filename is given it defaults to `history.dat`.
+Saves all applied rewrites into `FILENAME`, for later analysis with the clash-term tool.
+When no filename is given it defaults to `history.dat`.
 
 -fclash-debug-transformations  
-List the transformations that are to be debugged. This is given as a
-comma-separated list of transformations, e.g.
+List the transformations that are to be debugged.
+This is given as a comma-separated list of transformations, e.g.
 
 ``` bash
 clash -fclash-debug-transformations inlineNonRep,topLet,appProp
@@ -107,29 +101,26 @@ clash -fclash-debug-transformations-limit=12
 **Default:** MAX_INT
 
 -fclash-hdldir  
-Specify the directory that generated HDL is written into. For example
+Specify the directory that generated HDL is written into.
+For example
 
 ``` bash
 clash -fclash-hdldir build/hdl
 ```
 
 will create a directory `build/hdl`
 
-**Default:** Either `vhdl`, `verilog`, or `systemverilog` depending on
-the synthesis target.
+**Default:** Either `vhdl`, `verilog`, or `systemverilog` depending on the synthesis target.
 
 -fclash-hdlsyn  
-Specify the HDL synthesis tool which will be used. Available options are
-`Vivado`, `Quartus` and `Other`, but some synonyms for these exist
-(`Xilinx` and `ISE` are synonyms for `Vivado`, `Altera` and `Intel` are
-synyonyms for `Quartus`).
+Specify the HDL synthesis tool which will be used.
+Available options are `Vivado`, `Quartus` and `Other`, but some synonyms for these exist (`Xilinx` and `ISE` are synonyms for `Vivado`, `Altera` and `Intel` are synyonyms for `Quartus`).
 
 **Default:** `Other`
 
 -fclash-no-cache  
-Don't reuse previously generated output from Clash, instead generating
-HDL from a clean state. While this leads to longer builds, it can be
-useful in development.
+Don't reuse previously generated output from Clash, instead generating HDL from a clean state.
+While this leads to longer builds, it can be useful in development.
 
 <div class="warning">
 
@@ -139,25 +130,22 @@ Warning
 
 </div>
 
-Previously this flag was called `-fclash-nocache`, however this is now
-deprecated.
+Previously this flag was called `-fclash-nocache`, however this is now deprecated.
 
 </div>
 
 **Default:** Cache generated HDL
 
 -fclash-no-check-inaccessible-idirs  
-Check that all include directories (containing primitives) exist when
-running Clash. If any directory does not exist, an error is thrown.
+Check that all include directories (containing primitives) exist when running Clash.
+If any directory does not exist, an error is thrown.
 
 **Default:** Check directories
 
 -fclash-clear  
 Remove HDL directories before writing to them (if cache can't be used).
-By default, Clash will only write to non-empty directories if it can
-prove all files in it are generated by a previous run. This option
-applies to directories of the various top entities, i.e., the
-subdirectories made in the directory passed in with `-fclash-hdldir`.
+By default, Clash will only write to non-empty directories if it can prove all files in it are generated by a previous run.
+This option applies to directories of the various top entities, i.e., the subdirectories made in the directory passed in with `-fclash-hdldir`.
 
 **Default:** Clean before build
 
@@ -179,27 +167,27 @@ Change the number of times a function can undergo specialization.
 **Default:** 20
 
 -fclash-inline-limit  
-Change the number of times a function `f` can undergo inlining inside
-some other function `g`. This prevents the size of `g` growing
-dramatically.
+Change the number of times a function `f` can undergo inlining inside some other function `g`.
+This prevents the size of `g` growing dramatically.
 
 **Default:** 20
 
 -fclash-inline-function-limit  
-Set the threshold for function size. Below this threshold functions are
-always inlined (if it is not recursive).
+Set the threshold for function size.
+Below this threshold functions are always inlined (if it is not recursive).
 
 **Default:** 15
 
 -fclash-inline-constant-limit  
-Set the threshold for constant size. Below this threshold constants are
-always inlined. A value of 0 inlines all constants.
+Set the threshold for constant size.
+Below this threshold constants are always inlined.
+A value of 0 inlines all constants.
 
 **Default:** 0
 
 -fclash-evaluator-fuel-limit  
-Set the threshold for unfolding potentially non-terminating bindings in
-the evaluator. A value of 0 only unfolds terminating bindings.
+Set the threshold for unfolding potentially non-terminating bindings in the evaluator.
+A value of 0 only unfolds terminating bindings.
 
 **Default:** 20
 
@@ -211,21 +199,20 @@ The only allowed values are 32 or 64.
 **Default:** Machine word size (`WORD_SIZE_IN_BITS`)
 
 -fclash-error-extra  
-Print additional information with compiler errors if it as available. If
-there is extra information and this flag is not enabled, a message will
-be printed suggesting this flag.
+Print additional information with compiler errors if it as available.
+If there is extra information and this flag is not enabled, a message will be printed suggesting this flag.
 
 **Default:** False
 
 -fclash-float-support  
-Enable support for floating point numbers. If this is disabled, Clash
-will not attempt to convert Float and Double values for hardware.
+Enable support for floating point numbers.
+If this is disabled, Clash will not attempt to convert Float and Double values for hardware.
 
 **Default:** False
 
 -fclash-component-prefix  
-Prefix the names of generated HDl components with a string. For example
-a component `foo` would be called `xcorp_foo` if run with
+Prefix the names of generated HDl components with a string.
+For example a component `foo` would be called `xcorp_foo` if run with
 
 ``` bash
 clash -fclash-component-prefix "xcorp"
@@ -234,77 +221,64 @@ clash -fclash-component-prefix "xcorp"
 **Default:** ""
 
 -fclash-old-inline-strategy  
-The new inlining strategy for Clash inlines all functions which are not
-marked with `NOINLINE` or a synthesize attribute. The old inlining
-strategy differed, attempting only to inline functions which were deemed
-"cheap". The old inlining strategy may be quicker in practice for some
-circuits.
+The new inlining strategy for Clash inlines all functions which are not marked with `NOINLINE` or a synthesize attribute.
+The old inlining strategy differed, attempting only to inline functions which were deemed "cheap".
+The old inlining strategy may be quicker in practice for some circuits.
 
 **Default:** False
 
 -fclash-no-escaped-identifiers  
-Disable extended identifiers, as used in some HDLs like VHDL to allow
-more flexibility with names. Clash will only generate basic identifiers
-if this is used.
+Disable extended identifiers, as used in some HDLs like VHDL to allow more flexibility with names.
+Clash will only generate basic identifiers if this is used.
 
 **Default:** Escaped identifiers are allowed
 
 -fclash-lower-case-basic-identifiers  
 Clash will only generate lower case basic identifiers if this is used.
-This affects places where the various HDLs only allow basic identifiers
-to be used, most notably module and file names.
+This affects places where the various HDLs only allow basic identifiers to be used, most notably module and file names.
 
 **Default:** Disabled
 
 -fclash-compile-ultra  
-Aggressively run the normalizer, potentially gaining much better runtime
-performance at the expense of compile time.
+Aggressively run the normalizer, potentially gaining much better runtime performance at the expense of compile time.
 
 **Default:** False
 
 -fclash-force-undefined{,0,1}  
-Set the value to use when an undefined value is inserted into generated
-HDL. This flag can be suffixed with either 0 or 1 to force use of that
-bit, or left without a suffix to use a HDL-specific default (e.g. `x` in
-Verilog).
+Set the value to use when an undefined value is inserted into generated HDL.
+This flag can be suffixed with either 0 or 1 to force use of that bit, or left without a suffix to use a HDL-specific default (e.g. `x` in Verilog).
 
 **Default:** Disabled
 
 -fclash-aggressive-x-optimization  
-Remove all undefined branches from case expressions, replacing them with
-another defined value in the expression. If only one branch is defined,
-the case expression is elided completely. If no branches are defined the
-entire expression is replaced with a call to `errorX`.
+Remove all undefined branches from case expressions, replacing them with another defined value in the expression.
+If only one branch is defined, the case expression is elided completely.
+If no branches are defined the entire expression is replaced with a call to `errorX`.
 
 **Implies:** `-fclash-aggressive-x-optimization-blackboxes`
 
 **Default:** False
 
 -fclash-aggressive-x-optimization-blackboxes  
-Allow blackboxes to detect undefined values and change their behavior
-accordingly. For example, if `register` is used in combination with an
-undefined reset value, it will leave out the reset logic entirely. This
-flag is enabled when using `-fclash-aggressive-x-optimization`.
+Allow blackboxes to detect undefined values and change their behavior accordingly.
+For example, if `register` is used in combination with an undefined reset value, it will leave out the reset logic entirely.
+This flag is enabled when using `-fclash-aggressive-x-optimization`.
 
 **Default:** False
 
 -fclash-edalize  
-Generate metadata for use with
-[Edalize](https://github.com/olofk/edalize). This generates edam.py
-files in all top entities with the configuration for building that
-entity. Users still need to edit this file to specify the EDA tool to
-use, and if necessary the device to target (for Quartus, Vivado etc.)
+Generate metadata for use with [Edalize](https://github.com/olofk/edalize).
+This generates edam.py files in all top entities with the configuration for building that entity.
+Users still need to edit this file to specify the EDA tool to use, and if necessary the device to target (for Quartus, Vivado etc.)
 
 **Default:** False
 
 -main-is  
-When using one of `--vhdl`, `--verilog`, or `--systemverilog`, this flag
-refers to synthesis target. For example, running Clash with
-`clash My.Module -main-is top --vhdl` would synthesize `My.Module.top`.
+When using one of `--vhdl`, `--verilog`, or `--systemverilog`, this flag refers to synthesis target.
+For example, running Clash with `clash My.Module -main-is top --vhdl` would synthesize `My.Module.top`.
 
 -fclash-timescale-precision  
-Sets the second part of Verilog's `timescale 100fs/100fs`. E.g., setting
-this flag to `1fs` would make Clash generate Verilog files with
-`timescale 100fs/1fs` as their header.
+Sets the second part of Verilog's `timescale 100fs/100fs`.
+E.g., setting this flag to `1fs` would make Clash generate Verilog files with `timescale 100fs/1fs` as their header.
 
 **Default:** `100fs`

compiler-userguide/src/developing-hardware/language.md

@@ -1,17 +1,14 @@
 # Clash as a Language
 
-As Clash reuses parts of the GHC compiler for its front-end, the syntax
-and semantics should be familiar to Haskell programmers. For people
-unfamiliar with Haskell, there are many resources to learn the language,
-such as
+As Clash reuses parts of the GHC compiler for its front-end, the syntax and semantics should be familiar to Haskell programmers.
+For people unfamiliar with Haskell, there are many resources to learn the language, such as
 
 - [Learn You a Haskell](http://learnyouahaskell.com/chapters)
 - [Real World Haskell](http://book.realworldhaskell.org/read/)
 - [The Haskell Wikibook](https://en.wikibooks.org/wiki/Haskell)
 
-Clash does make some use of more advanced features of GHC Haskell, which
-are exposed by GHC as language extensions. The extensions used by Clash
-are
+Clash does make some use of more advanced features of GHC Haskell, which are exposed by GHC as language extensions.
+The extensions used by Clash are
 
 - [BinaryLiterals](https://downloads.haskell.org/~ghc/9.0.1/docs/html/users_guide/exts/binary_literals.html)
 - [ConstraintKinds](https://downloads.haskell.org/~ghc/9.0.1/docs/html/users_guide/exts/constraint_kind.html)
@@ -48,20 +45,17 @@ Warning
 
 </div>
 
-Since GHC 8.6, the `StarIsType` extension is defined. This extension is
-explicitly turned off by Clash, meaning `Data.Kind.Type` must be used to
-refer to Haskell types.
+Since GHC 8.6, the `StarIsType` extension is defined.
+This extension is explicitly turned off by Clash, meaning `Data.Kind.Type` must be used to refer to Haskell types.
 
 </div>
 
-Clash also enables some GHC plugins by default which improve the type
-inference for type level numbers. The plugins enabled by default are
+Clash also enables some GHC plugins by default which improve the type inference for type level numbers.
+The plugins enabled by default are
 
 - [ghc-typelits-extra](https://hackage.haskell.org/package/ghc-typelits-extra)
 - [ghc-typelits-knownnat](https://hackage.haskell.org/package/ghc-typelits-knownnat)
 - [ghc-typelits-natnormalise](https://hackage.haskell.org/package/ghc-typelits-natnormalise)
 
-Users are free to control the language extensions and GHC options with
-the normal `OPTIONS_GHC` and `LANGUAGE` pragmas in source files. For
-more information, see the [GHC User's
-Guide](https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/).
+Users are free to control the language extensions and GHC options with the normal `OPTIONS_GHC` and `LANGUAGE` pragmas in source files.
+For more information, see the [GHC User's Guide](https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/).