summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/builtins.rst4
-rw-r--r--docs/library/machine.RTC.rst2
-rw-r--r--docs/library/machine.USBDevice.rst12
-rw-r--r--docs/library/machine.rst9
-rw-r--r--docs/library/pyb.rst13
5 files changed, 22 insertions, 18 deletions
diff --git a/docs/library/builtins.rst b/docs/library/builtins.rst
index e489375b1..88b1fbcfe 100644
--- a/docs/library/builtins.rst
+++ b/docs/library/builtins.rst
@@ -170,6 +170,10 @@ Exceptions
.. exception:: KeyboardInterrupt
+ |see_cpython| `python:KeyboardInterrupt`.
+
+ See also in the context of :ref:`soft_bricking`.
+
.. exception:: KeyError
.. exception:: MemoryError
diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst
index fcd78f1c3..ad0b0759e 100644
--- a/docs/library/machine.RTC.rst
+++ b/docs/library/machine.RTC.rst
@@ -83,7 +83,7 @@ Methods
a `bytes` object.
Data written to RTC user memory is persistent across restarts, including
- `machine.soft_reset()` and `machine.deepsleep()`.
+ :ref:`soft_reset` and `machine.deepsleep()`.
The maximum length of RTC user memory is 2048 bytes by default on esp32,
and 492 bytes on esp8266.
diff --git a/docs/library/machine.USBDevice.rst b/docs/library/machine.USBDevice.rst
index a47fda2a2..5c18c49a7 100644
--- a/docs/library/machine.USBDevice.rst
+++ b/docs/library/machine.USBDevice.rst
@@ -32,10 +32,10 @@ Managing a runtime USB interface can be tricky, especially if you are communicat
with MicroPython over a built-in USB-CDC serial port that's part of the same USB
device.
-- A MicroPython soft reset will always clear all runtime USB interfaces, which
- results in the entire USB device disconnecting from the host. If MicroPython
- is also providing a built-in USB-CDC serial port then this will re-appear
- after the soft reset.
+- A MicroPython :ref:`soft reset <soft_reset>` will always clear all runtime USB
+ interfaces, which results in the entire USB device disconnecting from the
+ host. If MicroPython is also providing a built-in USB-CDC serial port then
+ this will re-appear after the soft reset.
This means some functions (like ``mpremote run``) that target the USB-CDC
serial port will immediately fail if a runtime USB interface is active,
@@ -44,9 +44,9 @@ device.
no more runtime USB interface.
- To configure a runtime USB device on every boot, it's recommended to place the
- configuration code in the ``boot.py`` file on the :ref:`device VFS
+ configuration code in the :ref:`boot.py` file on the :ref:`device VFS
<filesystem>`. On each reset this file is executed before the USB subsystem is
- initialised (and before ``main.py``), so it allows the board to come up with the runtime
+ initialised (and before :ref:`main.py`), so it allows the board to come up with the runtime
USB device immediately.
- For development or debugging, it may be convenient to connect a hardware
diff --git a/docs/library/machine.rst b/docs/library/machine.rst
index 7d2eb26a7..76d111f11 100644
--- a/docs/library/machine.rst
+++ b/docs/library/machine.rst
@@ -62,14 +62,13 @@ Reset related functions
.. function:: reset()
- Resets the device in a manner similar to pushing the external RESET
- button.
+ :ref:`Hard resets <hard_reset>` the device in a manner similar to pushing the
+ external RESET button.
.. function:: soft_reset()
- Performs a soft reset of the interpreter, deleting all Python objects and
- resetting the Python heap. It tries to retain the method by which the user
- is connected to the MicroPython REPL (eg serial, USB, Wifi).
+ Performs a :ref:`soft reset <soft_reset>` of the interpreter, deleting all
+ Python objects and resetting the Python heap.
.. function:: reset_cause()
diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst
index f169a77f3..5eb75c22b 100644
--- a/docs/library/pyb.rst
+++ b/docs/library/pyb.rst
@@ -147,10 +147,10 @@ Power related functions
(internal oscillator) directly. The higher frequencies use the HSE to
drive the PLL (phase locked loop), and then use the output of the PLL.
- Note that if you change the frequency while the USB is enabled then
- the USB may become unreliable. It is best to change the frequency
- in boot.py, before the USB peripheral is started. Also note that sysclk
- frequencies below 36MHz do not allow the USB to function correctly.
+ Note that if you change the frequency while the USB is enabled then the USB
+ may become unreliable. It is best to change the frequency in :ref:`boot.py`,
+ before the USB peripheral is started. Also note that sysclk frequencies below
+ 36MHz do not allow the USB to function correctly.
.. function:: wfi()
@@ -205,8 +205,9 @@ Miscellaneous functions
.. function:: main(filename)
- Set the filename of the main script to run after boot.py is finished. If
- this function is not called then the default file main.py will be executed.
+ Set the filename of the main script to run after :ref:`boot.py` is finished.
+ If this function is not called then the default file :ref:`main.py` will be
+ executed.
It only makes sense to call this function from within boot.py.