Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: amaranth-lang/amaranth
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 955881193ad2
Choose a base ref
...
head repository: amaranth-lang/amaranth
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: f2f405fa943f
Choose a head ref
  • 1 commit
  • 18 files changed
  • 1 contributor

Commits on Dec 11, 2021

  1. Copy the full SHA
    f2f405f View commit details
2 changes: 1 addition & 1 deletion latest/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a5f181ca87b053890a0d1cae690289f7
config: 8de107503e71ec7dc2ddabf6a35012e4
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified latest/.doctrees/install.doctree
Binary file not shown.
Binary file modified latest/.doctrees/lang.doctree
Binary file not shown.
8 changes: 5 additions & 3 deletions latest/_sources/install.rst.txt
Original file line number Diff line number Diff line change
@@ -4,9 +4,11 @@ Installation
System requirements
===================

.. |yosys-version| replace:: 0.10 (or newer)

Amaranth HDL requires Python 3.6; it works on CPython_ 3.6 (or newer), and works faster on PyPy3.6_ 7.2 (or newer).

For most workflows, Amaranth requires Yosys_ 0.9 (or newer). A compatible version of Yosys is distributed via PyPI_ for most popular platforms.
For most workflows, Amaranth requires Yosys_ |yosys-version|. A compatible version of Yosys is distributed via PyPI_ for most popular platforms.

Simulating Amaranth code requires no additional software. However, a waveform viewer like GTKWave_ is invaluable for debugging.

@@ -66,7 +68,7 @@ Installing prerequisites
$ sudo apt-get install yosys
If Yosys 0.9 (or newer) is not available, `build Yosys from source`_.
If Yosys |yosys-version| is not available, `build Yosys from source`_.

.. platform-choice:: arch
:altname: linux
@@ -85,7 +87,7 @@ Installing prerequisites

On architectures other than |builtin-yosys-architectures|, install Yosys from the package repository of your distribution.

If Yosys 0.9 (or newer) is not available, `build Yosys from source`_.
If Yosys |yosys-version| is not available, `build Yosys from source`_.

.. _build Yosys from source: https://github.com/YosysHQ/yosys/#setup

14 changes: 6 additions & 8 deletions latest/_sources/lang.rst.txt
Original file line number Diff line number Diff line change
@@ -421,19 +421,17 @@ While arithmetic computations never result in an overflow, :ref:`assigning <lang

The following table lists the arithmetic operations provided by Amaranth:

============ ========================== ======
Operation Description Notes
============ ========================== ======
============ ==========================
Operation Description
============ ==========================
``a + b`` addition
``-a`` negation
``a - b`` subtraction
``a * b`` multiplication
``a // b`` floor division [#opA1]_
``a % b`` modulo [#opA1]_
``a // b`` floor division
``a % b`` modulo
``abs(a)`` absolute value
============ ========================== ======

.. [#opA1] Divisor must be unsigned; this is an Amaranth limitation that may be lifted in the future.
============ ==========================


.. _lang-cmpops:
2 changes: 1 addition & 1 deletion latest/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.3.dev284',
VERSION: '0.3.dev285',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
4 changes: 2 additions & 2 deletions latest/cover.html
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Amaranth HDL documentation &mdash; Amaranth HDL toolchain 0.3.dev284 documentation</title>
<title>Amaranth HDL documentation &mdash; Amaranth HDL toolchain 0.3.dev285 documentation</title>



@@ -68,7 +68,7 @@


<div class="version">
0.3.dev284+g25573c5
0.3.dev285+gb452e0e
</div>


4 changes: 2 additions & 2 deletions latest/genindex.html
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Index &mdash; Amaranth HDL toolchain 0.3.dev284 documentation</title>
<title>Index &mdash; Amaranth HDL toolchain 0.3.dev285 documentation</title>



@@ -67,7 +67,7 @@


<div class="version">
0.3.dev284+g25573c5
0.3.dev285+gb452e0e
</div>


4 changes: 2 additions & 2 deletions latest/index.html
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Language &amp; toolchain &mdash; Amaranth HDL toolchain 0.3.dev284 documentation</title>
<title>Language &amp; toolchain &mdash; Amaranth HDL toolchain 0.3.dev285 documentation</title>



@@ -69,7 +69,7 @@


<div class="version">
0.3.dev284+g25573c5
0.3.dev285+gb452e0e
</div>


10 changes: 5 additions & 5 deletions latest/install.html
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Installation &mdash; Amaranth HDL toolchain 0.3.dev284 documentation</title>
<title>Installation &mdash; Amaranth HDL toolchain 0.3.dev285 documentation</title>



@@ -69,7 +69,7 @@


<div class="version">
0.3.dev284+g25573c5
0.3.dev285+gb452e0e
</div>


@@ -189,7 +189,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
<div class="section" id="system-requirements">
<h2>System requirements<a class="headerlink" href="#system-requirements" title="Permalink to this headline"></a></h2>
<p>Amaranth HDL requires Python 3.6; it works on <a class="reference external" href="https://www.python.org/">CPython</a> 3.6 (or newer), and works faster on <a class="reference external" href="https://www.pypy.org/">PyPy3.6</a> 7.2 (or newer).</p>
<p>For most workflows, Amaranth requires <a class="reference external" href="https://yosyshq.net/yosys/">Yosys</a> 0.9 (or newer). A compatible version of Yosys is distributed via <a class="reference external" href="https://pypi.org/">PyPI</a> for most popular platforms.</p>
<p>For most workflows, Amaranth requires <a class="reference external" href="https://yosyshq.net/yosys/">Yosys</a> 0.10 (or newer). A compatible version of Yosys is distributed via <a class="reference external" href="https://pypi.org/">PyPI</a> for most popular platforms.</p>
<p>Simulating Amaranth code requires no additional software. However, a waveform viewer like <a class="reference external" href="http://gtkwave.sourceforge.net/">GTKWave</a> is invaluable for debugging.</p>
<p>Synthesizing, placing and routing an Amaranth design for an FPGA requires the FPGA family specific toolchain.</p>
</div>
@@ -218,7 +218,7 @@ <h2>System requirements<a class="headerlink" href="#system-requirements" title="
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>sudo apt-get install yosys
</pre></div>
</div>
<p>If Yosys 0.9 (or newer) is not available, <a class="reference external" href="https://github.com/YosysHQ/yosys/#setup">build Yosys from source</a>.</p>
<p>If Yosys 0.10 (or newer) is not available, <a class="reference external" href="https://github.com/YosysHQ/yosys/#setup">build Yosys from source</a>.</p>
</div>
<div class="platform-choice platform--arch platform--linux docutils container">
<p class="platform-title">Arch Linux</p>
@@ -231,7 +231,7 @@ <h2>System requirements<a class="headerlink" href="#system-requirements" title="
<p class="platform-title">Other Linux</p>
<p>Install Python and GTKWave from the package repository of your distribution.</p>
<p>On architectures other than x86_64 and AArch64, install Yosys from the package repository of your distribution.</p>
<p>If Yosys 0.9 (or newer) is not available, <a class="reference external" href="https://github.com/YosysHQ/yosys/#setup">build Yosys from source</a>.</p>
<p>If Yosys 0.10 (or newer) is not available, <a class="reference external" href="https://github.com/YosysHQ/yosys/#setup">build Yosys from source</a>.</p>
</div>
</div>
</div>
4 changes: 2 additions & 2 deletions latest/intro.html
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Introduction &mdash; Amaranth HDL toolchain 0.3.dev284 documentation</title>
<title>Introduction &mdash; Amaranth HDL toolchain 0.3.dev285 documentation</title>



@@ -69,7 +69,7 @@


<div class="version">
0.3.dev284+g25573c5
0.3.dev285+gb452e0e
</div>


Loading