Deploying to main from @ amaranth-lang/amaranth@556faea 🚀

Author: github-merge-queue[bot]

docs/amaranth/latest/.buildinfo

@@ -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: b0c116fbad02b7676203320ac0373e2e
+config: fd796875298760e672b38162de83eb59
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/amaranth/latest/.doctrees/environment.pickle

@@ -170,6 +170,14 @@ Specifying a shape with a range is convenient for counters, indexes, and all oth
 
    Python ranges are *exclusive* or *half-open*, meaning they do not contain their ``.stop`` element. Because of this, values with shapes cast from a ``range(stop)`` where ``stop`` is a power of 2 are not wide enough to represent ``stop`` itself:
 
+   .. doctest::
+      :hide:
+
+      >>> import warnings
+      >>> _warning_filters_backup = warnings.catch_warnings()
+      >>> _warning_filters_backup.__enter__() # have to do this horrific hack to make it work with `PYTHONWARNINGS=error` :(
+      >>> warnings.simplefilter("default", amaranth.hdl._ast.SyntaxWarning)
+
    .. doctest::
 
       >>> fencepost = C(256, range(256))
@@ -180,6 +188,11 @@ Specifying a shape with a range is convenient for counters, indexes, and all oth
       >>> fencepost.value
       0
 
+   .. doctest::
+      :hide:
+
+      >>> _warning_filters_backup.__exit__()
+
    Amaranth detects uses of :class:`Const` and :class:`Signal` that invoke such an off-by-one error, and emits a diagnostic message.
 
 .. note::
@@ -670,6 +683,14 @@ Python expression Amaranth expression (boolean operands)
 
    When applied to Amaranth boolean values, the ``~`` operator computes negation, and when applied to Python boolean values, the ``not`` operator also computes negation. However, the ``~`` operator applied to Python boolean values produces an unexpected result:
 
+   .. doctest::
+      :hide:
+
+      >>> import warnings
+      >>> _warning_filters_backup = warnings.catch_warnings()
+      >>> _warning_filters_backup.__enter__() # have to do this horrific hack to make it work with `PYTHONWARNINGS=error` :(
+      >>> warnings.simplefilter("ignore", DeprecationWarning)
+
    .. doctest::
 
       >>> ~False
@@ -688,6 +709,11 @@ Python expression Amaranth expression (boolean operands)
       >>> ~use_stb | stb # WRONG! MSB of 2-bit wide OR expression is always 1
       (| (const 2'sd-2) (sig stb))
 
+   .. doctest::
+      :hide:
+
+      >>> _warning_filters_backup.__exit__()
+
    Amaranth automatically detects some cases of misuse of ``~`` and emits a detailed diagnostic message.
 
    .. TODO: this isn't quite reliable, #380
@@ -1372,14 +1398,14 @@ A new synchronous :ref:`control domain <lang-domains>`, which is more often call
 
 .. testcode::
 
-    m.domains.video = cd_video = ClockDomain(local=True)
+    m.domains.video = cd_video = ClockDomain()
 
 If the name of the domain is not known upfront, another, less concise, syntax can be used instead:
 
 .. testcode::
 
     def add_video_domain(n):
-        cd = ClockDomain(f"video_{n}", local=True)
+        cd = ClockDomain(f"video_{n}")
         m.domains += cd
         return cd
 
@@ -1393,22 +1419,18 @@ A clock domain always has a clock signal, which can be accessed through the :att
 
 .. testcode::
 
-    m.domains.jtag = ClockDomain(clk_edge="neg", local=True)
+    m.domains.jtag = ClockDomain(clk_edge="neg")
 
 A clock domain also has a reset signal, which can be accessed through the :attr:`cd.rst <ClockDomain.rst>` attribute. The reset signal is always active-high: the signals in the clock domain are reset if the value of the reset signal is 1. The :ref:`initial value <lang-initial>` of this signal is 0, so if the reset signal is never assigned, the signals in the clock domain are never explicitly reset (they are still :ref:`reset at power-on <lang-initial>`). Nevertheless, if its existence is undesirable, the clock domain can be configured to omit it:
 
 .. testcode::
 
-    m.domains.startup = ClockDomain(reset_less=True, local=True)
+    m.domains.startup = ClockDomain(reset_less=True)
 
 Signals in a reset-less clock domain can still be explicitly reset using the :class:`ResetInserter` :ref:`control flow modifier <lang-controlinserter>`.
 
 If a clock domain is defined in a module, all of its :ref:`submodules <lang-submodules>` can refer to that domain under the same name.
 
-.. warning::
-
-    Always provide the :py:`local=True` keyword argument when defining a clock domain. The behavior of clock domains defined without this keyword argument is subject to change in near future, and is intentionally left undocumented.
-
 .. warning::
 
     Clock domains use synchronous reset unless otherwise specified. Clock domains with asynchronous reset are implemented, but their behavior is subject to change in near future, and is intentionally left undocumented.
@@ -1447,7 +1469,7 @@ In this example, once the design is processed, the clock signal of the clock dom
 
 .. testcode::
 
-    m.domains.sync = cd_sync = ClockDomain(local=True)
+    m.domains.sync = cd_sync = ClockDomain()
     m.d.comb += [
         cd_sync.clk.eq(bus_clk),
         cd_sync.rst.eq(~bus_rstn),

docs/amaranth/latest/.doctrees/guide.doctree

@@ -106,7 +106,7 @@ In this example, a clock domain is created and driven from an external clock sou
         def elaborate(self, platform):
             m = Module()
 
-            m.domains.sync = cd_sync = ClockDomain(local=True)
+            m.domains.sync = cd_sync = ClockDomain()
 
             m.submodules.clk24 = clk24 = io.Buffer("i", platform.request("clk24", dir="-"))
             m.d.comb += cd_sync.clk.eq(clk24.i)

docs/amaranth/latest/.doctrees/stdlib/io.doctree

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.6.0.dev40',
+    VERSION: '0.6.0.dev44',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/amaranth/latest/_sources/guide.rst.txt

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Changelog &mdash; Amaranth language &amp; toolchain 0.6.0.dev40 documentation</title>
+  <title>Changelog &mdash; Amaranth language &amp; toolchain 0.6.0.dev44 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
@@ -17,7 +17,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=66db0882"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=9aaa1225"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
         <script src="_static/platformpicker.js"></script>
@@ -41,7 +41,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.6.0.dev40
+                0.6.0.dev44
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/amaranth/latest/_sources/stdlib/io.rst.txt

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Contributing &mdash; Amaranth language &amp; toolchain 0.6.0.dev40 documentation</title>
+  <title>Contributing &mdash; Amaranth language &amp; toolchain 0.6.0.dev44 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
@@ -17,7 +17,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=66db0882"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=9aaa1225"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
         <script src="_static/platformpicker.js"></script>
@@ -40,7 +40,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.6.0.dev40
+                0.6.0.dev44
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/amaranth/latest/_static/documentation_options.js

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.6.0.dev40 documentation</title>
+  <title>Amaranth project documentation &mdash; Amaranth language &amp; toolchain 0.6.0.dev44 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
@@ -17,7 +17,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=66db0882"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=9aaa1225"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
         <script src="_static/platformpicker.js"></script>
@@ -40,7 +40,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.6.0.dev40
+                0.6.0.dev44
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/amaranth/latest/changes.html

@@ -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.6.0.dev40 documentation</title>
+  <title>Index &mdash; Amaranth language &amp; toolchain 0.6.0.dev44 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/platformpicker.css" />
@@ -16,7 +16,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=66db0882"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=9aaa1225"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
         <script src="_static/platformpicker.js"></script>
@@ -38,7 +38,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.6.0.dev40
+                0.6.0.dev44
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">