summaryrefslogtreecommitdiff
path: root/docs/library/machine.RTC.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/library/machine.RTC.rst
parentcbffe61f96d060ed4af2bde7e3043a3664dc147a (diff)
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/library/machine.RTC.rst')
-rw-r--r--docs/library/machine.RTC.rst2
1 files changed, 1 insertions, 1 deletions
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.