summaryrefslogtreecommitdiffstatshomepage
path: root/docs/unix
diff options
context:
space:
mode:
authorDavid Lechner <david@lechnology.com>2022-05-03 22:26:29 -0500
committerDamien George <damien@micropython.org>2022-05-24 00:51:47 +1000
commitc012318d74fed232b1c872a1a0cacf91ebcb1b6d (patch)
tree90952f1815a9e1edc4d06e4d85a818b6a25ad66a /docs/unix
parentbe5657b64ff718bfeeab8f60d8ae12b31bbcbb89 (diff)
downloadmicropython-c012318d74fed232b1c872a1a0cacf91ebcb1b6d.tar.gz
micropython-c012318d74fed232b1c872a1a0cacf91ebcb1b6d.zip
unix: Implement `-X realtime` command-line option on macOS.
This adds a new command line option to the unix port `-X realtime` to enable realtime priority on threads. This enables high precision timers for applications that need more accurate timers. Related docs: https://developer.apple.com/library/archive/technotes/tn2169/_index.html Fixes issue #8621. Signed-off-by: David Lechner <david@pybricks.com>
Diffstat (limited to 'docs/unix')
-rw-r--r--docs/unix/quickref.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/unix/quickref.rst b/docs/unix/quickref.rst
index ec5312a535..2eac1edc79 100644
--- a/docs/unix/quickref.rst
+++ b/docs/unix/quickref.rst
@@ -73,6 +73,8 @@ General options:
- ``-X heapsize=<n>[w][K|M]`` sets the heap size for the garbage collector.
The suffix ``w`` means words instead of bytes. ``K`` means x1024 and ``M``
means x1024x1024.
+ - ``-X realtime`` sets thread priority to realtime. This can be used to
+ improve timer precision. Only available on macOS.