Skip to content

Commit 64809be

Browse files
committed
docs/changes: reorder migration checklist by importance.
1 parent 2c0265d commit 64809be

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/changes.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,23 @@ Migrating from version 0.4
2929

3030
Apply the following changes to code written against Amaranth 0.4 to migrate it to version 0.5:
3131

32+
* Update uses of :py:`reset=` keyword argument to :py:`init=`.
33+
* Ensure all elaboratables are subclasses of :class:`Elaboratable`.
3234
* Replace uses of :py:`m.Case()` with no patterns with :py:`m.Default()`.
3335
* Replace uses of :py:`Value.matches()` with no patterns with :py:`Const(1)`.
34-
* Update uses of :py:`amaranth.utils.log2_int(need_pow2=False)` to :func:`amaranth.utils.ceil_log2`.
35-
* Update uses of :py:`amaranth.utils.log2_int(need_pow2=True)` to :func:`amaranth.utils.exact_log2`.
36-
* Update uses of :py:`reset=` keyword argument to :py:`init=`.
37-
* Convert uses of :py:`Simulator.add_sync_process` used as testbenches to :meth:`Simulator.add_testbench <amaranth.sim.Simulator.add_testbench>`.
38-
* Convert other uses of :py:`Simulator.add_sync_process` to :meth:`Simulator.add_process <amaranth.sim.Simulator.add_process>`.
39-
* Convert simulator processes and testbenches to use the new async API.
40-
* Replace uses of :py:`amaranth.hdl.Memory` with :class:`amaranth.lib.memory.Memory`.
36+
* Ensure clock domains aren't used outside the module that defines them, or its submodules; move clock domain definitions upwards in the hierarchy as necessary
4137
* Replace imports of :py:`amaranth.asserts.Assert`, :py:`Assume`, and :py:`Cover` with imports from :py:`amaranth.hdl`.
4238
* Remove uses of :py:`name=` keyword argument of :py:`Assert`, :py:`Assume`, and :py:`Cover`; a message can be used instead.
43-
* Ensure all elaboratables are subclasses of :class:`Elaboratable`.
44-
* Ensure clock domains aren't used outside the module that defines them, or its submodules; move clock domain definitions upwards in the hierarchy as necessary
45-
* Remove uses of :py:`amaranth.lib.coding.*` by inlining or copying the implementation of the modules.
39+
* Replace uses of :py:`amaranth.hdl.Memory` with :class:`amaranth.lib.memory.Memory`.
4640
* Update uses of :py:`platform.request` to pass :py:`dir="-"` and use :mod:`amaranth.lib.io` buffers.
41+
* Remove uses of :py:`amaranth.lib.coding.*` by inlining or copying the implementation of the modules.
42+
* Convert uses of :py:`Simulator.add_sync_process` used as testbenches to :meth:`Simulator.add_testbench <amaranth.sim.Simulator.add_testbench>`.
43+
* Convert other uses of :py:`Simulator.add_sync_process` to :meth:`Simulator.add_process <amaranth.sim.Simulator.add_process>`.
44+
* Convert simulator processes and testbenches to use the new async API.
4745
* Update uses of :meth:`Simulator.add_clock <amaranth.sim.Simulator.add_clock>` with explicit :py:`phase` to take into account simulator no longer adding implicit :py:`period / 2`. (Previously, :meth:`Simulator.add_clock <amaranth.sim.Simulator.add_clock>` was documented to first toggle the clock at the time :py:`phase`, but actually first toggled the clock at :py:`period / 2 + phase`.)
4846
* Update uses of :meth:`Simulator.run_until <amaranth.sim.Simulator.run_until>` to remove the :py:`run_passive=True` argument. If the code uses :py:`run_passive=False`, ensure it still works with the new behavior.
47+
* Update uses of :py:`amaranth.utils.log2_int(need_pow2=False)` to :func:`amaranth.utils.ceil_log2`.
48+
* Update uses of :py:`amaranth.utils.log2_int(need_pow2=True)` to :func:`amaranth.utils.exact_log2`.
4949

5050

5151
Implemented RFCs

0 commit comments

Comments
 (0)