diff options
| author | Damien George <damien.p.george@gmail.com> | 2015-04-09 10:08:25 +0100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2015-04-09 10:08:25 +0100 |
| commit | e97dddcdcaa70b7d21971cbee32cf1f4981877e0 (patch) | |
| tree | 8ff69a893e8df20672ea945d7bd30871ceb5ee7e | |
| parent | 9988618e0e0f5c319e31b135d993e22efb593093 (diff) | |
| download | micropython-e97dddcdcaa70b7d21971cbee32cf1f4981877e0.tar.gz micropython-e97dddcdcaa70b7d21971cbee32cf1f4981877e0.zip | |
docs: Document pyb.main function to set main script.
| -rw-r--r-- | docs/library/pyb.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst index f93b884ab4..91b8cccbde 100644 --- a/docs/library/pyb.rst +++ b/docs/library/pyb.rst @@ -162,6 +162,13 @@ Miscellaneous functions Print out lots of information about the board. +.. 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. + + It only makes sense to call this function from within boot.py. + .. function:: mount(device, mountpoint, \*, readonly=False, mkfs=False) Mount a block device and make it available as part of the filesystem. |