Skip to content

Commit

Permalink
Deploying to main from @ amaranth-lang/amaranth@890e099 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Feb 19, 2024
1 parent 94656c8 commit 8203827
Show file tree
Hide file tree
Showing 41 changed files with 110 additions and 96 deletions.
2 changes: 1 addition & 1 deletion docs/amaranth/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: daf6797fb3798139525659a3eb6e3aca
config: a2f61b0e975b6cc71f02fad50855d6ea
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/amaranth/latest/.doctrees/changes.doctree
Binary file not shown.
Binary file modified docs/amaranth/latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/amaranth/latest/.doctrees/stdlib.doctree
Binary file not shown.
5 changes: 5 additions & 0 deletions docs/amaranth/latest/_sources/changes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Apply the following changes to code written against Amaranth 0.4 to migrate it t
* Update uses of ``reset=`` keyword argument to ``init=``
* Convert uses of ``Simulator.add_sync_process`` used as testbenches to ``Simulator.add_testbench``
* Convert other uses of ``Simulator.add_sync_process`` to ``Simulator.add_process``
* Replace uses of ``amaranth.hdl.Memory`` with ``amaranth.lib.memory.Memory``


Implemented RFCs
Expand All @@ -41,12 +42,14 @@ Implemented RFCs
.. _RFC 27: https://amaranth-lang.org/rfcs/0027-simulator-testbenches.html
.. _RFC 39: https://amaranth-lang.org/rfcs/0039-empty-case.html
.. _RFC 43: https://amaranth-lang.org/rfcs/0043-rename-reset-to-init.html
.. _RFC 45: https://amaranth-lang.org/rfcs/0045-lib-memory.html
.. _RFC 46: https://amaranth-lang.org/rfcs/0046-shape-range-1.html

* `RFC 17`_: Remove ``log2_int``
* `RFC 27`_: Testbench processes for the simulator
* `RFC 39`_: Change semantics of no-argument ``m.Case()``
* `RFC 43`_: Rename ``reset=`` to ``init=``
* `RFC 45`_: Move ``hdl.Memory`` to ``lib.Memory``
* `RFC 46`_: Change ``Shape.cast(range(1))`` to ``unsigned(0)``


Expand All @@ -65,6 +68,7 @@ Language changes
* Changed: the ``reset=`` argument of :class:`Signal`, :meth:`Signal.like`, :class:`amaranth.lib.wiring.Member`, :class:`amaranth.lib.cdc.FFSynchronizer`, and ``m.FSM()`` has been renamed to ``init=``. (`RFC 43`_)
* Changed: :class:`Shape` has been made immutable and hashable.
* Deprecated: :func:`amaranth.utils.log2_int`. (`RFC 17`_)
* Deprecated: :class:`amaranth.hdl.Memory`. (`RFC 45`_)
* Removed: (deprecated in 0.4) :meth:`Const.normalize`. (`RFC 5`_)
* Removed: (deprecated in 0.4) :class:`Repl`. (`RFC 10`_)
* Removed: (deprecated in 0.4) :class:`ast.Sample`, :class:`ast.Past`, :class:`ast.Stable`, :class:`ast.Rose`, :class:`ast.Fell`.
Expand All @@ -75,6 +79,7 @@ Standard library changes

.. currentmodule:: amaranth.lib

* Added: :mod:`amaranth.lib.memory`. (`RFC 45`_)
* Removed: (deprecated in 0.4) :mod:`amaranth.lib.scheduler`. (`RFC 19`_)
* Removed: (deprecated in 0.4) :class:`amaranth.lib.fifo.FIFOInterface` with ``fwft=False``. (`RFC 20`_)
* Removed: (deprecated in 0.4) :class:`amaranth.lib.fifo.SyncFIFO` with ``fwft=False``. (`RFC 20`_)
Expand Down
2 changes: 1 addition & 1 deletion docs/amaranth/latest/_sources/stdlib.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Standard library
The :mod:`amaranth.lib` module, also known as the standard library, provides modules that falls into one of the three categories:

1. Modules that will used by essentially all idiomatic Amaranth code, and are necessary for interoperability. This includes :mod:`amaranth.lib.enum` (enumerations), :mod:`amaranth.lib.data` (data structures), and :mod:`amaranth.lib.wiring` (interfaces and components).
2. Modules that abstract common functionality whose implementation differs between hardware platforms. This includes :mod:`amaranth.lib.cdc`.
2. Modules that abstract common functionality whose implementation differs between hardware platforms. This includes :mod:`amaranth.lib.cdc`, :mod:`amaranth.lib.memory`.
3. Modules that have essentially one correct implementation and are of broad utility in digital designs. This includes :mod:`amaranth.lib.coding`, :mod:`amaranth.lib.fifo`, and :mod:`amaranth.lib.crc`.

As part of the Amaranth backwards compatibility guarantee, any behaviors described in these documents will not change from a version to another without at least one version including a warning about the impending change. Any nontrivial change to these behaviors must also go through the public review as a part of the `Amaranth Request for Comments process <https://amaranth-lang.org/rfcs/>`_.
Expand Down
2 changes: 1 addition & 1 deletion docs/amaranth/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.4.1.dev112',
VERSION: '0.4.1.dev113',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
10 changes: 7 additions & 3 deletions docs/amaranth/latest/changes.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.4.1.dev112 documentation</title>
<title>Changelog &mdash; Amaranth language &amp; toolchain 0.4.1.dev113 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=51dc03a0"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=f5a487b9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -39,7 +39,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.1.dev112+g6d65dc1
0.4.1.dev113+g890e099
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -148,6 +148,7 @@ <h3>Migrating from version 0.4<a class="headerlink" href="#migrating-from-versio
<li><p>Update uses of <code class="docutils literal notranslate"><span class="pre">reset=</span></code> keyword argument to <code class="docutils literal notranslate"><span class="pre">init=</span></code></p></li>
<li><p>Convert uses of <code class="docutils literal notranslate"><span class="pre">Simulator.add_sync_process</span></code> used as testbenches to <code class="docutils literal notranslate"><span class="pre">Simulator.add_testbench</span></code></p></li>
<li><p>Convert other uses of <code class="docutils literal notranslate"><span class="pre">Simulator.add_sync_process</span></code> to <code class="docutils literal notranslate"><span class="pre">Simulator.add_process</span></code></p></li>
<li><p>Replace uses of <code class="docutils literal notranslate"><span class="pre">amaranth.hdl.Memory</span></code> with <code class="docutils literal notranslate"><span class="pre">amaranth.lib.memory.Memory</span></code></p></li>
</ul>
</section>
<section id="implemented-rfcs">
Expand All @@ -157,6 +158,7 @@ <h3>Implemented RFCs<a class="headerlink" href="#implemented-rfcs" title="Permal
<li><p><a class="reference external" href="https://amaranth-lang.org/rfcs/0027-simulator-testbenches.html">RFC 27</a>: Testbench processes for the simulator</p></li>
<li><p><a class="reference external" href="https://amaranth-lang.org/rfcs/0039-empty-case.html">RFC 39</a>: Change semantics of no-argument <code class="docutils literal notranslate"><span class="pre">m.Case()</span></code></p></li>
<li><p><a class="reference external" href="https://amaranth-lang.org/rfcs/0043-rename-reset-to-init.html">RFC 43</a>: Rename <code class="docutils literal notranslate"><span class="pre">reset=</span></code> to <code class="docutils literal notranslate"><span class="pre">init=</span></code></p></li>
<li><p><a class="reference external" href="https://amaranth-lang.org/rfcs/0045-lib-memory.html">RFC 45</a>: Move <code class="docutils literal notranslate"><span class="pre">hdl.Memory</span></code> to <code class="docutils literal notranslate"><span class="pre">lib.Memory</span></code></p></li>
<li><p><a class="reference external" href="https://amaranth-lang.org/rfcs/0046-shape-range-1.html">RFC 46</a>: Change <code class="docutils literal notranslate"><span class="pre">Shape.cast(range(1))</span></code> to <code class="docutils literal notranslate"><span class="pre">unsigned(0)</span></code></p></li>
</ul>
</section>
Expand All @@ -173,6 +175,7 @@ <h3>Language changes<a class="headerlink" href="#language-changes" title="Permal
<li><p>Changed: the <code class="docutils literal notranslate"><span class="pre">reset=</span></code> argument of <code class="xref py py-class docutils literal notranslate"><span class="pre">Signal</span></code>, <code class="xref py py-meth docutils literal notranslate"><span class="pre">Signal.like()</span></code>, <a class="reference internal" href="stdlib/wiring.html#amaranth.lib.wiring.Member" title="amaranth.lib.wiring.Member"><code class="xref py py-class docutils literal notranslate"><span class="pre">amaranth.lib.wiring.Member</span></code></a>, <a class="reference internal" href="stdlib/cdc.html#amaranth.lib.cdc.FFSynchronizer" title="amaranth.lib.cdc.FFSynchronizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">amaranth.lib.cdc.FFSynchronizer</span></code></a>, and <code class="docutils literal notranslate"><span class="pre">m.FSM()</span></code> has been renamed to <code class="docutils literal notranslate"><span class="pre">init=</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0043-rename-reset-to-init.html">RFC 43</a>)</p></li>
<li><p>Changed: <a class="reference internal" href="reference.html#amaranth.hdl.Shape" title="amaranth.hdl.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a> has been made immutable and hashable.</p></li>
<li><p>Deprecated: <code class="xref py py-func docutils literal notranslate"><span class="pre">amaranth.utils.log2_int()</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0017-remove-log2-int.html">RFC 17</a>)</p></li>
<li><p>Deprecated: <code class="xref py py-class docutils literal notranslate"><span class="pre">amaranth.hdl.Memory</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0045-lib-memory.html">RFC 45</a>)</p></li>
<li><p>Removed: (deprecated in 0.4) <code class="xref py py-meth docutils literal notranslate"><span class="pre">Const.normalize()</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0005-remove-const-normalize.html">RFC 5</a>)</p></li>
<li><p>Removed: (deprecated in 0.4) <code class="xref py py-class docutils literal notranslate"><span class="pre">Repl</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0010-move-repl-to-value.html">RFC 10</a>)</p></li>
<li><p>Removed: (deprecated in 0.4) <code class="xref py py-class docutils literal notranslate"><span class="pre">ast.Sample</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ast.Past</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ast.Stable</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ast.Rose</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ast.Fell</span></code>.</p></li>
Expand All @@ -181,6 +184,7 @@ <h3>Language changes<a class="headerlink" href="#language-changes" title="Permal
<section id="standard-library-changes">
<h3>Standard library changes<a class="headerlink" href="#standard-library-changes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Added: <code class="xref py py-mod docutils literal notranslate"><span class="pre">amaranth.lib.memory</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0045-lib-memory.html">RFC 45</a>)</p></li>
<li><p>Removed: (deprecated in 0.4) <code class="xref py py-mod docutils literal notranslate"><span class="pre">amaranth.lib.scheduler</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0019-remove-scheduler.html">RFC 19</a>)</p></li>
<li><p>Removed: (deprecated in 0.4) <a class="reference internal" href="stdlib/fifo.html#amaranth.lib.fifo.FIFOInterface" title="amaranth.lib.fifo.FIFOInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">amaranth.lib.fifo.FIFOInterface</span></code></a> with <code class="docutils literal notranslate"><span class="pre">fwft=False</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0020-deprecate-non-fwft-fifos.html">RFC 20</a>)</p></li>
<li><p>Removed: (deprecated in 0.4) <a class="reference internal" href="stdlib/fifo.html#amaranth.lib.fifo.SyncFIFO" title="amaranth.lib.fifo.SyncFIFO"><code class="xref py py-class docutils literal notranslate"><span class="pre">amaranth.lib.fifo.SyncFIFO</span></code></a> with <code class="docutils literal notranslate"><span class="pre">fwft=False</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0020-deprecate-non-fwft-fifos.html">RFC 20</a>)</p></li>
Expand Down
5 changes: 5 additions & 0 deletions docs/amaranth/latest/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Apply the following changes to code written against Amaranth 0.4 to migrate it t
* Update uses of ``reset=`` keyword argument to ``init=``
* Convert uses of ``Simulator.add_sync_process`` used as testbenches to ``Simulator.add_testbench``
* Convert other uses of ``Simulator.add_sync_process`` to ``Simulator.add_process``
* Replace uses of ``amaranth.hdl.Memory`` with ``amaranth.lib.memory.Memory``


Implemented RFCs
Expand All @@ -41,12 +42,14 @@ Implemented RFCs
.. _RFC 27: https://amaranth-lang.org/rfcs/0027-simulator-testbenches.html
.. _RFC 39: https://amaranth-lang.org/rfcs/0039-empty-case.html
.. _RFC 43: https://amaranth-lang.org/rfcs/0043-rename-reset-to-init.html
.. _RFC 45: https://amaranth-lang.org/rfcs/0045-lib-memory.html
.. _RFC 46: https://amaranth-lang.org/rfcs/0046-shape-range-1.html

* `RFC 17`_: Remove ``log2_int``
* `RFC 27`_: Testbench processes for the simulator
* `RFC 39`_: Change semantics of no-argument ``m.Case()``
* `RFC 43`_: Rename ``reset=`` to ``init=``
* `RFC 45`_: Move ``hdl.Memory`` to ``lib.Memory``
* `RFC 46`_: Change ``Shape.cast(range(1))`` to ``unsigned(0)``


Expand All @@ -65,6 +68,7 @@ Language changes
* Changed: the ``reset=`` argument of :class:`Signal`, :meth:`Signal.like`, :class:`amaranth.lib.wiring.Member`, :class:`amaranth.lib.cdc.FFSynchronizer`, and ``m.FSM()`` has been renamed to ``init=``. (`RFC 43`_)
* Changed: :class:`Shape` has been made immutable and hashable.
* Deprecated: :func:`amaranth.utils.log2_int`. (`RFC 17`_)
* Deprecated: :class:`amaranth.hdl.Memory`. (`RFC 45`_)
* Removed: (deprecated in 0.4) :meth:`Const.normalize`. (`RFC 5`_)
* Removed: (deprecated in 0.4) :class:`Repl`. (`RFC 10`_)
* Removed: (deprecated in 0.4) :class:`ast.Sample`, :class:`ast.Past`, :class:`ast.Stable`, :class:`ast.Rose`, :class:`ast.Fell`.
Expand All @@ -75,6 +79,7 @@ Standard library changes

.. currentmodule:: amaranth.lib

* Added: :mod:`amaranth.lib.memory`. (`RFC 45`_)
* Removed: (deprecated in 0.4) :mod:`amaranth.lib.scheduler`. (`RFC 19`_)
* Removed: (deprecated in 0.4) :class:`amaranth.lib.fifo.FIFOInterface` with ``fwft=False``. (`RFC 20`_)
* Removed: (deprecated in 0.4) :class:`amaranth.lib.fifo.SyncFIFO` with ``fwft=False``. (`RFC 20`_)
Expand Down
6 changes: 3 additions & 3 deletions docs/amaranth/latest/contrib.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.4.1.dev112 documentation</title>
<title>Contributing &mdash; Amaranth language &amp; toolchain 0.4.1.dev113 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=51dc03a0"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=f5a487b9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -38,7 +38,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.1.dev112+g6d65dc1
0.4.1.dev113+g890e099
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
6 changes: 3 additions & 3 deletions docs/amaranth/latest/cover.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.4.1.dev112 documentation</title>
<title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.4.1.dev113 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=51dc03a0"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=f5a487b9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -38,7 +38,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.1.dev112+g6d65dc1
0.4.1.dev113+g890e099
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
6 changes: 3 additions & 3 deletions docs/amaranth/latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; Amaranth language &amp; toolchain 0.4.1.dev112 documentation</title>
<title>Index &mdash; Amaranth language &amp; toolchain 0.4.1.dev113 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/platformpicker.css" type="text/css" />
Expand All @@ -14,7 +14,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=51dc03a0"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=f5a487b9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/platformpicker.js"></script>
Expand All @@ -36,7 +36,7 @@
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.1.dev112+g6d65dc1
0.4.1.dev113+g890e099
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Loading

0 comments on commit 8203827

Please sign in to comment.