summaryrefslogtreecommitdiffstatshomepage
path: root/docs/reference/repl.rst
diff options
context:
space:
mode:
authorAngus Gratton <angus@redyak.com.au>2024-10-02 19:16:39 +1000
committerDamien George <damien@micropython.org>2024-11-19 10:57:26 +1100
commit0e7c3901b897a1edd53b56b6119f2d4119e88842 (patch)
tree1264a33779159677fa6550cfc8bdecd91c2ee6ea /docs/reference/repl.rst
parentcbffe61f96d060ed4af2bde7e3043a3664dc147a (diff)
downloadmicropython-0e7c3901b897a1edd53b56b6119f2d4119e88842.tar.gz
micropython-0e7c3901b897a1edd53b56b6119f2d4119e88842.zip
docs: Add a "Reset and Boot Sequence" reference page.
Previously individual ports documented these aspects to varying degrees, but most of the information is common to all ports. In particular, this adds a canonical explanation of `boot.py` and `main.py`. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
Diffstat (limited to 'docs/reference/repl.rst')
-rw-r--r--docs/reference/repl.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/reference/repl.rst b/docs/reference/repl.rst
index 55f76ee1a0..be02ddebde 100644
--- a/docs/reference/repl.rst
+++ b/docs/reference/repl.rst
@@ -143,10 +143,12 @@ the auto-indent feature, and changes the prompt from ``>>>`` to ``===``. For exa
Paste Mode allows blank lines to be pasted. The pasted text is compiled as if
it were a file. Pressing Ctrl-D exits paste mode and initiates the compilation.
+.. _repl_soft_reset:
+
Soft reset
----------
-A soft reset will reset the python interpreter, but tries not to reset the
+A :ref:`soft_reset` will reset the python interpreter, but tries not to reset the
method by which you're connected to the MicroPython board (USB-serial, or Wifi).
You can perform a soft reset from the REPL by pressing Ctrl-D, or from your python
@@ -182,6 +184,9 @@ variables no longer exist:
['__name__', 'pyb']
>>>
+For more information about reset types and the startup process, see
+:doc:`/reference/reset_boot`.
+
The special variable _ (underscore)
-----------------------------------
@@ -196,6 +201,8 @@ So you can use the underscore to save the result in a variable. For example:
15
>>>
+.. _raw_repl:
+
Raw mode and raw-paste mode
---------------------------