Updating todo text and assorted fixes

Fix #3905 by removing emoji (and move the comment into the if block for less ambiguity).
Adds `latexmk` to README.

Note that latexpdf doesn't seem to like `cmd:ref` links, possibly because the
reference location is inside a latex comment block, but I was under the
impression that there was a reference location in there previously which was
working fine.  May be related to how the `cmd:def` block expands (or doesn't as
the case may be).
This commit is contained in:
Krystine Sherwin 2023-08-28 10:09:34 +12:00
parent aad8a3b959
commit 70c47690b3
No known key found for this signature in database
4 changed files with 8 additions and 8 deletions

View File

@ -607,7 +607,7 @@ following are used for building the website:
PDFLaTeX, included with most LaTeX distributions, is also needed during the
build process for the website. Or, run the following:
$ sudo apt install texlive-latex-base texlive-latex-extra
$ sudo apt install texlive-latex-base texlive-latex-extra latexmk
The Python package, Sphinx, is needed along with those listed in
`docs/source/requirements.txt`:

View File

@ -198,8 +198,8 @@ Synchronous SDP with undefined collision behavior
if (read_enable) begin
read_data <= mem[read_addr];
// 👇 this if block 👇
if (write_enable && read_addr == write_addr)
// this if block
read_data <= 'x;
end
end

View File

@ -128,7 +128,7 @@ is produced.
The ``opt_rmdff`` pass
~~~~~~~~~~~~~~~~~~~~~~
.. todo:: The ``opt_rmdff`` pass doesn't exist anymore?
.. todo:: Update to ``opt_dff``
This pass identifies single-bit d-type flip-flops (``$_DFF_``, ``$dff``, and
``$adff`` cells) with a constant data input and replaces them with a constant

View File

@ -59,7 +59,7 @@ RTLIL identifiers
All identifiers in RTLIL (such as module names, port names, signal names, cell
types, etc.) follow the following naming convention: they must either start with
a backslash (\) or a dollar sign ($).
a backslash (``\``) or a dollar sign (``$``).
Identifiers starting with a backslash are public visible identifiers. Usually
they originate from one of the HDL input files. For example the signal name
@ -74,7 +74,7 @@ This has three advantages:
- First, it is impossible that an auto-generated identifier collides with an
identifier that was provided by the user.
.. todo:: does opt_rmunused (still?) exist?
.. todo:: ``opt_clean`` (or clean), also ``-purge``
- Second, the information about which identifiers were originally provided by
the user is always available which can help guide some optimizations. For
@ -86,7 +86,7 @@ This has three advantages:
names is deferred to one central location. Internally auto-generated names
that may hold important information for Yosys developers can be used without
disturbing external tools. For example the Verilog backend assigns names in
the form \_integer\_.
the form ``_123_``.
Whitespace and control characters (any character with an ASCII code 32 or less)
are not allowed in RTLIL identifiers; most frontends and backends cannot support
@ -158,7 +158,7 @@ An ``RTLIL::Wire`` object has the following properties:
- The wire name
- A list of attributes
- A width (buses are just wires with a width > 1)
- A width (buses are just wires with a width more than 1)
- Bus direction (MSB to LSB or vice versa)
- Lowest valid bit index (LSB or MSB depending on bus direction)
- If the wire is a port: port number and direction (input/output/inout)
@ -167,7 +167,7 @@ As with modules, the attributes can be Verilog attributes imported by the
Verilog frontend or attributes assigned by passes.
In Yosys, busses (signal vectors) are represented using a single wire object
with a width > 1. So Yosys does not convert signal vectors to individual
with a width more than 1. So Yosys does not convert signal vectors to individual
signals. This makes some aspects of RTLIL more complex but enables Yosys to be
used for coarse grain synthesis where the cells of the target architecture
operate on entire signal vectors instead of single bit wires.