Skip to content

Commit

Permalink
Deploying to main from @ amaranth-lang/amaranth@475b0f3 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Dec 13, 2023
1 parent 30d6cc1 commit 0252b4d
Show file tree
Hide file tree
Showing 37 changed files with 167 additions and 108 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: 047a4268991feb42c387b692e10ef475
config: 035b6494da2fd80e7a863db70ec63099
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.
19 changes: 19 additions & 0 deletions docs/amaranth/latest/_sources/changes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ Changelog
This document describes changes to the public interfaces in the Amaranth language and standard library. It does not include most bug fixes or implementation changes.


Version 0.5 (unreleased)
========================

Language changes
----------------

.. currentmodule:: amaranth.hdl

* Removed: (deprecated in 0.4) :meth:`Const.normalize`. (`RFC 5`_)


Standard library changes
------------------------

.. currentmodule:: amaranth.lib

* Removed: (deprecated in 0.4) :mod:`amaranth.lib.scheduler`. (`RFC 19`_)


Version 0.4
===========

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.dev269',
VERSION: '0.4.1.dev2',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
62 changes: 41 additions & 21 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 HDL toolchain 0.4.dev269 documentation</title>
<title>Changelog &mdash; Amaranth HDL toolchain 0.4.1.dev2 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=89423bd8"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=5b7a6e40"></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 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev269+ga2f3c54.editable
0.4.1.dev2+g475b0f3.editable
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand All @@ -58,21 +58,26 @@
<li class="toctree-l2"><a class="reference internal" href="stdlib.html">Standard library</a></li>
<li class="toctree-l2"><a class="reference internal" href="platform.html">Platform integration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#version-0-5-unreleased">Version 0.5 (unreleased)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#language-changes">Language changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#standard-library-changes">Standard library changes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#version-0-4">Version 0.4</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#migrating-from-version-0-3">Migrating from version 0.3</a></li>
<li class="toctree-l4"><a class="reference internal" href="#implemented-rfcs">Implemented RFCs</a></li>
<li class="toctree-l4"><a class="reference internal" href="#language-changes">Language changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#standard-library-changes">Standard library changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id1">Language changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id2">Standard library changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#toolchain-changes">Toolchain changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#platform-integration-changes">Platform integration changes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#version-0-3">Version 0.3</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#migrating-from-version-0-2">Migrating from version 0.2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id1">Language changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id2">Standard library changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id3">Toolchain changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id4">Platform integration changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id3">Language changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id4">Standard library changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id5">Toolchain changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id6">Platform integration changes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#versions-0-1-0-2">Versions 0.1, 0.2</a></li>
Expand Down Expand Up @@ -112,6 +117,21 @@
<section id="changelog">
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading"></a></h1>
<p>This document describes changes to the public interfaces in the Amaranth language and standard library. It does not include most bug fixes or implementation changes.</p>
<section id="version-0-5-unreleased">
<h2>Version 0.5 (unreleased)<a class="headerlink" href="#version-0-5-unreleased" title="Permalink to this heading"></a></h2>
<section id="language-changes">
<h3>Language changes<a class="headerlink" href="#language-changes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<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>
</ul>
</section>
<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>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>
</ul>
</section>
</section>
<section id="version-0-4">
<h2>Version 0.4<a class="headerlink" href="#version-0-4" title="Permalink to this heading"></a></h2>
<p>Support has been added for a new and improved way of defining data structures in <a class="reference internal" href="stdlib/data.html#module-amaranth.lib.data" title="amaranth.lib.data"><code class="xref py py-mod docutils literal notranslate"><span class="pre">amaranth.lib.data</span></code></a> and component interfaces in <a class="reference internal" href="stdlib/wiring.html#module-amaranth.lib.wiring" title="amaranth.lib.wiring"><code class="xref py py-mod docutils literal notranslate"><span class="pre">amaranth.lib.wiring</span></code></a>, as defined in <a class="reference external" href="https://amaranth-lang.org/rfcs/0001-aggregate-data-structures.html">RFC 1</a> and <a class="reference external" href="https://amaranth-lang.org/rfcs/0002-interfaces.html">RFC 2</a>. <code class="xref py py-class docutils literal notranslate"><span class="pre">Record</span></code> has been deprecated. In a departure from the usual policy, to give designers additional time to migrate, <code class="xref py py-class docutils literal notranslate"><span class="pre">Record</span></code> will be removed in Amaranth 0.6 (one release later than normal).</p>
Expand Down Expand Up @@ -164,8 +184,8 @@ <h3>Implemented RFCs<a class="headerlink" href="#implemented-rfcs" title="Permal
<li><p><a class="reference external" href="https://amaranth-lang.org/rfcs/0038-component-signature-immutability.html">RFC 38</a>: <code class="docutils literal notranslate"><span class="pre">Component.signature</span></code> immutability</p></li>
</ul>
</section>
<section id="language-changes">
<h3>Language changes<a class="headerlink" href="#language-changes" title="Permalink to this heading"></a></h3>
<section id="id1">
<h3>Language changes<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Added: <code class="xref py py-class docutils literal notranslate"><span class="pre">ShapeCastable</span></code>, similar to <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueCastable</span></code>.</p></li>
<li><p>Added: <code class="xref py py-class docutils literal notranslate"><span class="pre">ShapeLike</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueLike</span></code>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0035-shapelike-valuelike.html">RFC 35</a>)</p></li>
Expand All @@ -190,8 +210,8 @@ <h3>Language changes<a class="headerlink" href="#language-changes" title="Permal
<li><p>Removed: (deprecated in 0.3) support for <code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">nmigen:</span></code> linter instructions at the beginning of file.</p></li>
</ul>
</section>
<section id="standard-library-changes">
<h3>Standard library changes<a class="headerlink" href="#standard-library-changes" title="Permalink to this heading"></a></h3>
<section id="id2">
<h3>Standard library changes<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Added: <a class="reference internal" href="stdlib/enum.html#module-amaranth.lib.enum" title="amaranth.lib.enum"><code class="xref py py-mod docutils literal notranslate"><span class="pre">amaranth.lib.enum</span></code></a>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0003-enumeration-shapes.html">RFC 3</a>)</p></li>
<li><p>Added: <a class="reference internal" href="stdlib/data.html#module-amaranth.lib.data" title="amaranth.lib.data"><code class="xref py py-mod docutils literal notranslate"><span class="pre">amaranth.lib.data</span></code></a>. (<a class="reference external" href="https://amaranth-lang.org/rfcs/0001-aggregate-data-structures.html">RFC 1</a>)</p></li>
Expand Down Expand Up @@ -251,8 +271,8 @@ <h3>Migrating from version 0.2<a class="headerlink" href="#migrating-from-versio
</ul>
<p>While code that uses the features listed as deprecated below will work in Amaranth 0.3, they will be removed in the next version.</p>
</section>
<section id="id1">
<h3>Language changes<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<section id="id3">
<h3>Language changes<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Added: <code class="xref py py-class docutils literal notranslate"><span class="pre">Value</span></code> can be used with <a class="reference external" href="https://docs.python.org/3/library/functions.html#abs" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">abs()</span></code></a>.</p></li>
<li><p>Added: <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.rotate_left()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">Value.rotate_right()</span></code>.</p></li>
Expand All @@ -263,8 +283,8 @@ <h3>Language changes<a class="headerlink" href="#id1" title="Permalink to this h
<li><p>Deprecated: <code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">nmigen:</span></code> linter instructions at the beginning of file; use <code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">amaranth:</span></code> instead.</p></li>
</ul>
</section>
<section id="id2">
<h3>Standard library changes<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<section id="id4">
<h3>Standard library changes<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Added: <a class="reference internal" href="stdlib/cdc.html#amaranth.lib.cdc.PulseSynchronizer" title="amaranth.lib.cdc.PulseSynchronizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">cdc.PulseSynchronizer</span></code></a>.</p></li>
<li><p>Added: <a class="reference internal" href="stdlib/cdc.html#amaranth.lib.cdc.AsyncFFSynchronizer" title="amaranth.lib.cdc.AsyncFFSynchronizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">cdc.AsyncFFSynchronizer</span></code></a>.</p></li>
Expand All @@ -273,8 +293,8 @@ <h3>Standard library changes<a class="headerlink" href="#id2" title="Permalink t
<li><p>Added: <code class="xref py py-attr docutils literal notranslate"><span class="pre">fifo.FIFOInterface.r_level</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">fifo.FIFOInterface.w_level</span></code>.</p></li>
</ul>
</section>
<section id="id3">
<h3>Toolchain changes<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<section id="id5">
<h3>Toolchain changes<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Changed: Backend and simulator reject wires larger than 65536 bits.</p></li>
<li><p>Added: Backend emits Yosys enumeration attributes for <a class="reference internal" href="lang.html#lang-shapeenum"><span class="std std-ref">enumeration-shaped</span></a> signals.</p></li>
Expand All @@ -292,8 +312,8 @@ <h3>Toolchain changes<a class="headerlink" href="#id3" title="Permalink to this
<li><p>Deprecated: <code class="docutils literal notranslate"><span class="pre">NMIGEN_*</span></code> environment variables; use <code class="docutils literal notranslate"><span class="pre">AMARANTH_*</span></code> environment variables instead.</p></li>
</ul>
</section>
<section id="id4">
<h3>Platform integration changes<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<section id="id6">
<h3>Platform integration changes<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Added: <code class="docutils literal notranslate"><span class="pre">SB_LFOSC</span></code> and <code class="docutils literal notranslate"><span class="pre">SB_HFOSC</span></code> as <code class="docutils literal notranslate"><span class="pre">default_clk</span></code> clock sources in <code class="xref py py-class docutils literal notranslate"><span class="pre">lattice_ice40.LatticeICE40Platform</span></code>.</p></li>
<li><p>Added: <code class="xref py py-class docutils literal notranslate"><span class="pre">lattice_machxo2.LatticeMachXO2Platform</span></code> generates binary (<code class="docutils literal notranslate"><span class="pre">.bit</span></code>) bitstreams.</p></li>
Expand Down
19 changes: 19 additions & 0 deletions docs/amaranth/latest/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ Changelog
This document describes changes to the public interfaces in the Amaranth language and standard library. It does not include most bug fixes or implementation changes.


Version 0.5 (unreleased)
========================

Language changes
----------------

.. currentmodule:: amaranth.hdl

* Removed: (deprecated in 0.4) :meth:`Const.normalize`. (`RFC 5`_)


Standard library changes
------------------------

.. currentmodule:: amaranth.lib

* Removed: (deprecated in 0.4) :mod:`amaranth.lib.scheduler`. (`RFC 19`_)


Version 0.4
===========

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 HDL toolchain 0.4.dev269 documentation</title>
<title>Contributing &mdash; Amaranth HDL toolchain 0.4.1.dev2 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=89423bd8"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=5b7a6e40"></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 @@ -37,7 +37,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev269+ga2f3c54.editable
0.4.1.dev2+g475b0f3.editable
</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 HDL documentation &mdash; Amaranth HDL toolchain 0.4.dev269 documentation</title>
<title>Amaranth HDL documentation &mdash; Amaranth HDL toolchain 0.4.1.dev2 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=89423bd8"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=5b7a6e40"></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 @@ -37,7 +37,7 @@
Amaranth HDL toolchain
</a>
<div class="version">
0.4.dev269+ga2f3c54.editable
0.4.1.dev2+g475b0f3.editable
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Loading

0 comments on commit 0252b4d

Please sign in to comment.