chipsalliance / firrtl-spec

The specification for the FIRRTL language
44 stars 28 forks source link

[nfc] Make block quotations commentary-like #147

Closed seldridge closed 11 months ago

seldridge commented 11 months ago

Modify the LaTeX template to make the "quote" environment more like commentaries/asides. This is modeled after how the RISC-V Specification does commentary with an indented, italicized region with a "\rule" at the top.

Example

With the following diff:

diff --git a/abi.md b/abi.md
index 2ab8853..a4042c8 100644
--- a/abi.md
+++ b/abi.md
@@ -3,6 +3,26 @@
 FIRRTL defines a language/IR for describing synchronous hardware circuits.
 This document specifies the mapping of FIRRTL constructs to Verilog in a manner similar to an application binary interface (ABI) which enables predictability of the output of key constructs necessary for the interoperability between circuits described in FIRRTL and between other languages and FIRRTL output.

+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+> Thanks for reading the document.
+
+
+
 This document describes multiple versions of the ABI, specifically calling specific changes in later versions.
 It is expected that a conforming FIRRTL compiler can lower to all specified ABIs.
 This mechanism exists to allow improved representations when using tools which have better Verilog support and allow incremental migration of existing development flows to the significant representational changes introduced by ABI changes.

The following is produced:

Screenshot 2023-11-09 at 16 47 15

For comparison, the RISC-V spec does things like:

Screenshot 2023-11-09 at 16 47 29